Overview | Index | Help
| Sonic Management API
SUMMARY: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS | DETAIL: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS

## Broker Metrics

Component: Broker (classname=com.sonicsw.mq.components.BrokerComponent, version=105)

This documentation describes the metrics and alert capabilities that are exposed by a Broker component running within the Sonic Management environment.

A general description of metrics and metric alerts is provided in the overview.

See Also:
  `Broker Notifications`, `Broker Operations/Attributes`

Metrics Summary
`broker.bytes.DeliveredPerSecond` Broker wide bytes delivered per second (includes internal/management messages).
`broker.bytes.FlowToDiskMemorySize` Total size in bytes of in-memory allocations associated with messages offloaded to the message store due to Flow To Disk.
`broker.bytes.ReceivedPerSecond` Broker wide bytes received per second (includes internal/management messages).
`broker.bytes.TopicDBSize` Total size in bytes of topic message store.
`broker.connections.Count` Inbound connection count to broker.
`broker.connections.RejectedPerMinute` Rejected connect attempts per minute.
`broker.messages.Delivered` Application messages delivered since start/reset (excludes internal/management messages).
`broker.messages.DeliveredPerSecond` Application messages delivered per second (excludes internal/management messages).
`broker.messages.Received` Application messages received since start/reset (excludes internal/management messages).
`broker.messages.ReceivedPerSecond` Application messages received per second (excludes internal/management messages).
`connection.bytes.Delivered` Bytes delivered to a connection (includes internal/management messages).
`connection.bytes.DeliveredPerSecond` Bytes delivered to a connection/sec (includes internal/management messages).
`connection.bytes.Received` Bytes received by a connection (includes internal/management messages).
`connection.bytes.ReceivedPerSecond` Bytes received by a connection per second (includes internal/management messages).
`connection.messages.Delivered` Messages delivered to a connection (excludes internal/management messages).
`connection.messages.DeliveredPerSecond` Messages delivered to a connection/sec (excludes internal/management messages).
`connection.messages.Received` Messages received by a connection (excludes internal/management messages).
`connection.messages.ReceivedPerSecond` Messages received by a connection per second (excludes internal/management messages).
`queue.messages.Count` Number of messages in a queue.
`queue.messages.DeliveredPerSecond` Messages delivered to a queue per second (including rejected messages).
`queue.messages.MaxAge` Age in seconds of the oldest message on the queue.
`queue.messages.MaxDepth` Maximum number of messages in a queue during a collection interval.
`queue.messages.ReceivedPerSecond` Messages received by a queue per second
`queue.messages.Size` Size of messages in a queue.
`queue.messages.TimeInQueue` Average time in the queue (in seconds) of messages dequeued during a collection interval.

Metrics Detail

### broker.bytes.DeliveredPerSecond

  Broker wide bytes delivered per second (includes internal/management messages).
  This metric's value is captured in terms of bytes per second.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.bytes.DeliveredPerSecond notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `broker.bytes.FlowToDiskMemorySize`, `broker.bytes.ReceivedPerSecond`, `broker.bytes.TopicDBSize`

### broker.bytes.FlowToDiskMemorySize

  Total size in bytes of in-memory allocations associated with messages offloaded to the message store due to Flow To Disk.
  This metric's value is captured in terms of bytes.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.bytes.FlowToDiskMemorySize notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `broker.bytes.DeliveredPerSecond`, `broker.bytes.ReceivedPerSecond`, `broker.bytes.TopicDBSize`

### broker.bytes.ReceivedPerSecond

  Broker wide bytes received per second (includes internal/management messages).
  This metric's value is captured in terms of bytes per second.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.bytes.ReceivedPerSecond notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `broker.bytes.DeliveredPerSecond`, `broker.bytes.FlowToDiskMemorySize`, `broker.bytes.TopicDBSize`

### broker.bytes.TopicDBSize

  Total size in bytes of topic message store.
  This metric's value is captured in terms of bytes.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.bytes.TopicDBSize notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `broker.bytes.DeliveredPerSecond`, `broker.bytes.FlowToDiskMemorySize`, `broker.bytes.ReceivedPerSecond`

### broker.connections.Count

  Inbound connection count to broker.
  This metric's value is captured in terms of connections.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.connections.Count notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High
> See Also:
>   `broker.connections.RejectedPerMinute`

### broker.connections.RejectedPerMinute

  Rejected connect attempts per minute.
  This metric's value is captured in terms of attempts per minute.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.connections.RejectedPerMinute notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High
> See Also:
>   `broker.connections.Count`

### broker.messages.Delivered

  Application messages delivered since start/reset (excludes internal/management messages).
  This metric's value is captured in terms of messages.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `broker.messages.DeliveredPerSecond`, `broker.messages.Received`, `broker.messages.ReceivedPerSecond`

### broker.messages.DeliveredPerSecond

  Application messages delivered per second (excludes internal/management messages).
  This metric's value is captured in terms of messages per second.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.messages.DeliveredPerSecond notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `broker.messages.Delivered`, `broker.messages.Received`, `broker.messages.ReceivedPerSecond`

### broker.messages.Received

  Application messages received since start/reset (excludes internal/management messages).
  This metric's value is captured in terms of messages.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `broker.messages.Delivered`, `broker.messages.DeliveredPerSecond`, `broker.messages.ReceivedPerSecond`

### broker.messages.ReceivedPerSecond

  Application messages received per second (excludes internal/management messages).
  This metric's value is captured in terms of messages per second.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.broker.messages.ReceivedPerSecond notification will be published.

> Metric Type:
>   Normal
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `broker.messages.Delivered`, `broker.messages.DeliveredPerSecond`, `broker.messages.Received`

### connection.bytes.Delivered

  Bytes delivered to a connection (includes internal/management messages).
  This metric's value is captured in terms of bytes.
  This metric may be enabled for individual connections or multiple connections using patterns.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `connection.bytes.DeliveredPerSecond`, `connection.bytes.Received`, `connection.bytes.ReceivedPerSecond`

### connection.bytes.DeliveredPerSecond

  Bytes delivered to a connection/sec (includes internal/management messages).
  This metric's value is captured in terms of bytes per second.
  This metric may be enabled for individual connections or multiple connections using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.connection.bytes.DeliveredPerSecond notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `connection.bytes.Delivered`, `connection.bytes.Received`, `connection.bytes.ReceivedPerSecond`

### connection.bytes.Received

  Bytes received by a connection (includes internal/management messages).
  This metric's value is captured in terms of bytes.
  This metric may be enabled for individual connections or multiple connections using patterns.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `connection.bytes.Delivered`, `connection.bytes.DeliveredPerSecond`, `connection.bytes.ReceivedPerSecond`

### connection.bytes.ReceivedPerSecond

  Bytes received by a connection per second (includes internal/management messages).
  This metric's value is captured in terms of bytes per second.
  This metric may be enabled for individual connections or multiple connections using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.connection.bytes.ReceivedPerSecond notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `connection.bytes.Delivered`, `connection.bytes.DeliveredPerSecond`, `connection.bytes.Received`

### connection.messages.Delivered

  Messages delivered to a connection (excludes internal/management messages).
  This metric's value is captured in terms of messages.
  This metric may be enabled for individual connections or multiple connections using patterns.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `connection.messages.DeliveredPerSecond`, `connection.messages.Received`, `connection.messages.ReceivedPerSecond`

### connection.messages.DeliveredPerSecond

  Messages delivered to a connection/sec (excludes internal/management messages).
  This metric's value is captured in terms of messages per second.
  This metric may be enabled for individual connections or multiple connections using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.connection.messages.DeliveredPerSecond notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `connection.messages.Delivered`, `connection.messages.Received`, `connection.messages.ReceivedPerSecond`

### connection.messages.Received

  Messages received by a connection (excludes internal/management messages).
  This metric's value is captured in terms of messages.
  This metric may be enabled for individual connections or multiple connections using patterns.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `connection.messages.Delivered`, `connection.messages.DeliveredPerSecond`, `connection.messages.ReceivedPerSecond`

### connection.messages.ReceivedPerSecond

  Messages received by a connection per second (excludes internal/management messages).
  This metric's value is captured in terms of messages per second.
  This metric may be enabled for individual connections or multiple connections using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.connection.messages.ReceivedPerSecond notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `connection.messages.Delivered`, `connection.messages.DeliveredPerSecond`, `connection.messages.Received`

### queue.messages.Count

  Number of messages in a queue.
  This metric's value is captured in terms of messages.
  This metric may be enabled for individual queues or multiple queues using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.queue.messages.Count notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High
> See Also:
>   `queue.messages.DeliveredPerSecond`, `queue.messages.MaxAge`, `queue.messages.MaxDepth`, `queue.messages.ReceivedPerSecond`, `queue.messages.Size`, `queue.messages.TimeInQueue`

### queue.messages.DeliveredPerSecond

  Messages delivered to a queue per second (including rejected messages).
  This metric's value is captured in terms of messages per second.
  This metric may be enabled for individual queues or multiple queues using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.queue.messages.DeliveredPerSecond notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `queue.messages.Count`, `queue.messages.MaxAge`, `queue.messages.MaxDepth`, `queue.messages.ReceivedPerSecond`, `queue.messages.Size`, `queue.messages.TimeInQueue`

### queue.messages.MaxAge

  Age in seconds of the oldest message on the queue.
  This metric's value is captured in terms of seconds.
  This metric may be enabled for individual queues or multiple queues using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.queue.messages.MaxAge notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High
> See Also:
>   `queue.messages.Count`, `queue.messages.DeliveredPerSecond`, `queue.messages.MaxDepth`, `queue.messages.ReceivedPerSecond`, `queue.messages.Size`, `queue.messages.TimeInQueue`

### queue.messages.MaxDepth

  Maximum number of messages in a queue during a collection interval.
  This metric's value is captured in terms of messages.
  This metric may be enabled for individual queues or multiple queues using patterns.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   None
> See Also:
>   `queue.messages.Count`, `queue.messages.DeliveredPerSecond`, `queue.messages.MaxAge`, `queue.messages.ReceivedPerSecond`, `queue.messages.Size`, `queue.messages.TimeInQueue`

### queue.messages.ReceivedPerSecond

  Messages received by a queue per second
  This metric's value is captured in terms of messages per second.
  This metric may be enabled for individual queues or multiple queues using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.queue.messages.ReceivedPerSecond notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High, Low
> See Also:
>   `queue.messages.Count`, `queue.messages.DeliveredPerSecond`, `queue.messages.MaxAge`, `queue.messages.MaxDepth`, `queue.messages.Size`, `queue.messages.TimeInQueue`

### queue.messages.Size

  Size of messages in a queue.
  This metric's value is captured in terms of bytes.
  This metric may be enabled for individual queues or multiple queues using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.queue.messages.Size notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High
> See Also:
>   `queue.messages.Count`, `queue.messages.DeliveredPerSecond`, `queue.messages.MaxAge`, `queue.messages.MaxDepth`, `queue.messages.ReceivedPerSecond`, `queue.messages.TimeInQueue`

### queue.messages.TimeInQueue

  Average time in the queue (in seconds) of messages dequeued during a collection interval.
  This metric's value is captured in terms of seconds.
  This metric may be enabled for individual queues or multiple queues using patterns.
  When alert thresholds are specified for this metric and are subsequently broken at runtime, a application.alert.queue.messages.TimeInQueue notification will be published.

> Metric Type:
>   Instance
> Dynamic:
>   Can be enabled/disabled at runtime.
> Threshold Alert Support:
>   High
> See Also:
>   `queue.messages.Count`, `queue.messages.DeliveredPerSecond`, `queue.messages.MaxAge`, `queue.messages.MaxDepth`, `queue.messages.ReceivedPerSecond`, `queue.messages.Size`

Overview | Index | Help
| Sonic Management API
SUMMARY: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS | DETAIL: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS

Copyright © 2002-2013 Aurea, Inc. All Rights Reserved.