This chapter describes the metrics information that a Message Queue broker can provide for monitoring, tuning, and diagnostic purposes. This information can be made available in a variety of ways:
In a log file (see Sending Metrics Data to Log Files)
Interactively with the Command utility's imqcmd metrics subcommand (see Using the Command Utility)
In metrics messages sent to a metrics topic destination (see Using the Message-Based Monitoring API)
Through JMX MBeans that can be accessed programmatically by Java applications using the JMX Administration API.
The tables in this chapter list the kinds of metrics information available and the forms in which it can be provided. For metrics provided through the Command utility's imqcmd metrics subcommand, the tables list the metric type with which they can be requested; for those provided in metrics messages, the tables list the metrics topic destination to which they are delivered. All the metrics information in this chapter can be accessed progamatically using the JMX Administration API as described in the Oracle GlassFish Server Message Queue Developer's Guide for JMX Clients
The chapter consists of the following sections:
Table 21-1 shows the metrics information that the broker reports for the broker process JVM (Java Virtual Machine) heap.
| Metrics Quantity | Description | Log File? | metrics bkrMetric Type |
Metrics Topic |
|---|---|---|---|---|
|
JVM heap: total memory |
Current total memory, in bytes |
Yes |
|
|
|
JVM heap: free memory |
Amount of memory currently available for use, in bytes |
Yes |
|
|
|
JVM heap: max memory |
Maximum allowable heap size, in bytes |
Yes |
None |
|
Table 21-2 shows the brokerwide metrics information that the broker reports.
| Metrics Quantity | Description | Log File? | metrics bkrMetric Type |
Metrics Topic |
|---|---|---|---|---|
|
Connections |
||||
|
Num connections |
Total current number of connections for all connection services |
Yes |
|
|
|
Num threads |
Total current number of threads for all connection services |
Yes |
|
None |
|
Min threads |
Total minimum number of threads for all connection services |
Yes |
|
None |
|
Max threads |
Total maximum number of threads for all connection services |
Yes |
|
None |
|
Stored Messages |
||||
|
Num messages |
Current number of payload messages stored in memory and persistent store |
No |
NoneFoot 1 |
|
|
Total message bytes |
Total size in bytes of payload messages currently stored in memory and persistent store |
No |
NoneFootref 1 |
|
|
Message Flow |
||||
|
Num messages in |
Cumulative number of payload messages received since broker started |
Yes |
|
|
|
Num messages out |
Cumulative number of payload messages sent since broker started |
Yes |
|
|
|
Rate messages in |
Current rate of flow of payload messages into broker |
Yes |
|
None |
|
Rate messages out |
Current rate of flow of payload messages out of broker |
Yes |
|
None |
|
Message bytes in |
Cumulative size in bytes of payload messages received since broker started |
Yes |
|
|
|
Message bytes out |
Cumulative size in bytes of payload messages sent since broker started |
Yes |
|
|
|
Rate message bytes in |
Current rate of flow of payload message bytes into broker |
Yes |
|
None |
|
Rate message bytes out |
Current rate of flow of payload message bytes out of broker |
Yes |
|
None |
|
Num packets in |
Cumulative number of payload and control packets received since broker started |
Yes |
|
|
|
Num packets out |
Cumulative number of payload and control packets sent since broker started |
Yes |
|
|
|
Rate packets in |
Current rate of flow of payload and control packets into broker |
Yes |
|
None |
|
Rate packets out |
Current rate of flow of payload and control packets out of broker |
Yes |
|
None |
|
Packet bytes in |
Cumulative size in bytes of payload and control packets received since broker started |
Yes |
|
|
|
Packet bytes out |
Cumulative size in bytes of payload and control packets sent since broker started |
Yes |
|
|
|
Rate packet bytes in |
Current rate of flow of payload and control packet bytes into broker |
Yes |
|
None |
|
Rate packet bytes out |
Current rate of flow of payload and control packet bytes out of broker |
Yes |
|
None |
|
Destinations |
||||
|
Num destinations |
Current number of physical destinations |
No |
None |
|
Footnote 1 Use query bkr command instead
Table 21-3 shows the metrics information that the broker reports for individual connection services.
Table 21-3 Connection Service Metrics
| Metrics Quantity | Description | Log File? | metrics svcMetric Type |
Metrics Topic |
|---|---|---|---|---|
|
Connections |
||||
|
Num connections |
Current number of connections |
No |
|
None |
|
Num threads |
Current number of threads |
No |
|
None |
|
Min threads |
Minimum number of threads assigned to service |
No |
|
None |
|
Max threads |
Maximum number of threads assigned to service |
No |
|
None |
|
Message Flow |
||||
|
Num messages in |
Cumulative number of payload messages received through connection service since broker started |
No |
|
None |
|
Num messages out |
Cumulative number of payload messages sent through connection service since broker started |
No |
|
None |
|
Rate messages in |
Current rate of flow of payload messages into broker through connection service |
No |
|
None |
|
Rate messages out |
Current rate of flow of payload messages out of broker through connection service |
No |
|
None |
|
Message bytes in |
Cumulative size in bytes of payload messages received through connection service since broker started |
No |
|
None |
|
Message bytes out |
Cumulative size in bytes of payload messages sent through connection service since broker started |
No |
|
None |
|
Rate message bytes in |
Current rate of flow of payload message bytes into broker through connection service |
No |
|
None |
|
Rate message bytes out |
Current rate of flow of payload message bytes out of broker through connection service |
No |
|
None |
|
Num packets in |
Cumulative number of payload and control packets received through connection service since broker started |
No |
|
None |
|
Num packets out |
Cumulative number of payload and control packets sent through connection service since broker started |
No |
|
None |
|
Rate packets in |
Current rate of flow of payload and control packets into broker through connection service |
No |
|
None |
|
Rate packets out |
Current rate of flow of payload and control packets out of broker through connection service |
No |
|
None |
|
Packet bytes in |
Cumulative size in bytes of payload and control packets received through connection service since broker started |
No |
|
None |
|
Packet bytes out |
Cumulative size in bytes of payload and control packets sent through connection service since broker started |
No |
|
None |
|
Rate packet bytes in |
Current rate of flow of payload and control packet bytes into broker through connection service |
No |
|
None |
|
Rate packet bytes out |
Current rate of flow of payload and control packet bytes out of broker through connection service |
No |
|
None |
Footnote 1 Also available with query svc command
Table 21-4 shows the metrics information that the broker reports for individual destinations.
Table 21-4 Physical Destination Metrics
| Metrics Quantity | Description | Log File? | metrics dstMetric Type |
Metrics Topic |
|---|---|---|---|---|
|
Message Consumers |
||||
|
Num consumers |
Current number of associated message consumers For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to "Num active consumers." |
No |
|
|
|
Peak num consumers |
Peak number of associated message consumers since broker started For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to "Peak num active consumers." |
No |
|
|
|
Avg num consumers |
Average number of associated message consumers since broker started For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to "Avg num active consumers." |
No |
|
|
|
Num active consumers |
Current number of associated active message consumers For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to "Num consumers." |
No |
|
|
|
Peak num active consumers |
Peak number of associated active message consumers since broker started For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to "Peak num consumers." |
No |
|
|
|
Avg num active consumers |
Average number of associated active message consumers since broker started For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to "Avg num consumers." |
No |
|
|
|
Num backup consumersFoot 1 |
Current number of associated backup message consumers |
No |
|
|
|
Peak num backup consumersFootref 1 |
Peak number of associated backup message consumers since broker started |
No |
|
|
|
Avg num backup consumersFootref 1 |
Average number of associated backup message consumers since broker started |
No |
|
|
|
Stored Messages |
||||
|
Num messages |
Current number of messages stored in memory and persistent store |
No |
|
|
|
Num messages remote |
Current number of messages stored in memory and persistent store that were sent from a remote broker in a cluster. This number does not include messages included in transactions. |
No |
Not AvailableFoot 3 |
Not Available |
|
Peak num messages |
Peak number of messages stored in memory and persistent store since broker started |
No |
|
|
|
Avg num messages |
Average number of messages stored in memory and persistent store since broker started |
No |
|
|
|
Total message bytes |
Current total size in bytes of messages stored in memory and persistent store |
No |
|
|
|
Total message bytes remote |
Current total size in bytes of messages stored in memory and persistent store that were sent from a remote broker in a cluster. This value does not include messages included in transactions. |
No |
Not Available Footref 3 |
Not Available |
|
Peak total message bytes |
Peak total size in bytes of messages stored in memory and persistent store since broker started |
No |
|
|
|
Avg total message bytes |
Average total size in bytes of messages stored in memory and persistent store since broker started |
No |
|
|
|
Message Flow |
||||
|
Num messages in |
Cumulative number of messages received since broker started |
No |
|
|
|
Num messages out |
Cumulative number of messages sent since broker started |
No |
|
|
|
Msg bytes in |
Cumulative size in bytes of messages received since broker started |
No |
|
|
|
Msg bytes out |
Cumulative size in bytes of messages sent since broker started |
No |
|
|
|
Peak message bytes |
Size in bytes of largest single message received since broker started |
No |
|
|
|
Rate num messages in |
Current rate of flow of messages received |
No |
|
None |
|
Rate num messages out |
Current rate of flow of messages sent |
No |
|
None |
|
Rate msg bytes in |
Current rate of flow of message bytes received |
No |
|
None |
|
Rate msg bytes out |
Current rate of flow of message bytes sent |
No |
|
None |
|
Disk Utilization |
||||
|
Disk reservedFoot 4 |
Amount of disk space, in bytes, reserved for destination |
No |
|
|
|
Disk usedFootref 4 |
Amount of disk space, in bytes, currently in use by destination |
No |
|
|
|
Disk utilization ratioFootref 4 |
Ratio of disk space in use to disk space reserved for destination |
No |
|
|
Footnote 1 Queue destinations only
Footnote 2 Also available with query dst command
Footnote 3 Available only with imqcmd query dst command
Footnote 4 File-based persistence only