Monitoring Metrics for RabbitMQ AMQP-0-9-1

Introduction

This section describes the metrics reported by DMS for RabbitMQ to Cloud Eye as well as their namespaces and dimensions. You can query the metrics and alarms of RabbitMQ instances through the Cloud Eye console or APIs. You can also view the metrics on the Monitoring Details page of the DMS for RabbitMQ console.

Cloud Eye supports a maximum of four hierarchical dimensions that are numbered from 0 to 3 (with level 3 being the deepest). For example, if the dimension information of a monitoring metric is rabbitmq_instance_id,rabbitmq_vhost, rabbitmq_instance_id indicates dimension level 0 and rabbitmq_vhost indicates dimension level 1.
According to the constraints on virtual host names, if a virtual host name contains special characters, these special characters will be displayed as underscores (_) on the monitoring page. For example, if virtual host 1 is named 1% and virtual host 2 is named 1/, both host names will be displayed as 1_ on the monitoring page. As a result, the monitoring data for the hosts with the same name will overlap.

Namespace

SYS.DMS

Instance Metrics

**Table 1** Instance metrics
Metric ID	Metric Name	Description	Value Range	Unit	Conversion Rule	Dimension	Monitoring Period (Raw Data)
connections	Connections	Number of connections in the RabbitMQ instance	≥ 0	Count	N/A	rabbitmq_instance_id	1 minute
channels	Channels	Number of channels in the RabbitMQ instance	0–2,000	Count	N/A	rabbitmq_instance_id	1 minute
queues	Queues	Number of queues in the RabbitMQ instance	0–1,000	Count	N/A	rabbitmq_instance_id	1 minute
consumers	Consumers	Number of consumers in the RabbitMQ instance	≥ 0	Count	N/A	rabbitmq_instance_id	1 minute
messages_ready	RabbitMQ instance Available Messages	Number of messages that can be consumed in the RabbitMQ instance	0–10,000,000	Count	N/A	rabbitmq_instance_id	1 minute
publish	Production Rate	Rate at which messages are produced in the RabbitMQ instance	≥ 0	Count/s	N/A	rabbitmq_instance_id	1 minute
instance_bytes_in_rate	Message Production	Number of bytes produced in the RabbitMQ instance per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id	1 minute
instance_bytes_out_rate	Message Consumption	Number of bytes consumed from the RabbitMQ instance per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id	1 minute
deliver_get	Consumption Rate	Number of messages consumed in real time by the RabbitMQ instance per second	≥ 0	Count/s	N/A	rabbitmq_instance_id	1 minute
instance_disk_usage	Instance Disk Usage	Instance disk usage	0–100	%	N/A	rabbitmq_instance_id	1 minute
instance_tps	Instance Transactions Per Second	Number of requests processed by a RabbitMQ instance per second	0–10,000,000	Count	N/A	rabbitmq_instance_id	1 minute
instance_connections_usage	Instance connections usage	Percentage of the total number of connections to the maximum number of connections allowed by the instance Some instances do not support this metric. Contact customer service.	0–100	%	N/A	rabbitmq_instance_id	1 minute

Virtual Host Metrics

**Table 2** Virtual host metrics
Metric ID	Metric Name	Description	Value Range	Unit	Conversion Rule	Dimension	Monitoring Period (Raw Data)
vhost_connections	Connections	Total number of connections in the virtual host	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_channels	Channels	Total number of channels in the virtual host	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_queues	Queues	Total number of queues in the virtual host	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_consumers	Consumers	Total number of consumers in the virtual host	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_messages_ready	RabbitMQ instance Available Messages	Total number of messages that can be consumed from the virtual host	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_messages_publish_rate	Production Rate	Number of messages produced in real time in the virtual host per second	≥ 0	Count/s	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_messages_deliver_get_rate	Consumption Rate	Number of messages consumed in real time in the virtual host per second	≥ 0	Count/s	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_bytes_in_rate	Message Creation	Number of bytes produced in the virtual host per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_bytes_out_rate	Message Retrieval	Number of bytes consumed from the virtual host per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id,rabbitmq_vhost	1 minute
vhost_tps	Vhost Transaction Per Second	Number of requests processed by the current virtual host per second	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost	1 minute

Exchange Metrics

**Table 3** Exchange metrics
Metric ID	Metric Name	Description	Value Range	Unit	Conversion Rule	Dimension	Monitoring Period (Raw Data)
exchange_messages_publish_rate	Production Rate	Number of messages produced in real time in the exchange per second	≥ 0	Count/s	N/A	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_exchange	1 minute
exchange_bytes_in_rate	Message Creation	Number of bytes produced in the exchange per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_exchange	1 minute

Queue Metrics

**Table 4** Queue metrics
Metric ID	Metric Name	Description	Value Range	Unit	Conversion Rule	Dimension	Monitoring Period (Raw Data)
queue_messages_ready	Queue Available Messages	Number of messages that can be retrieved in a RabbitMQ queue	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_queue	1 minute
queue_consumers	Consumers	Number of consumers that are subscribed to the queue	≥ 0	Count	N/A	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_queue	1 minute
queue_messages_publish_rate	Production Rate	Number of messages sent to the queue each second	≥ 0	Count/s	N/A	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_queue	1 minute
queue_messages_deliver_get_rate	Consumption Rate	Number of messages sent from the queue each second	≥ 0	Count/s	N/A	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_queue	1 minute
queue_bytes_in_rate	Message Production	Number of messages produced in real time in the queue per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_queue	1 minute
queue_bytes_out_rate	Message Consumption	Number of messages consumed in real time in the queue per second	≥ 0	Byte/s	1024(IEC)	rabbitmq_instance_id,rabbitmq_vhost,rabbitmq_vhost_queue	1 minute

If a monitored object has multiple dimensions, the dimensional level of specific metrics is required when you use APIs to query the metrics.

For example, to query the total number of connections (vhost_connections) of a RabbitMQ virtual host, its dimension is "rabbitmq_instance_id,rabbitmq_vhost", indicating that rabbitmq_instance_id is numbered 0 and rabbitmq_vhost is numbered 1.

To query a single metric by calling the API, the rabbitmq_vhost dimension is used as follows:
```
dim.0=rabbitmq_instance_id,0186688d-fxxx-497bfdda6c8e&dim.1=rabbitmq_vhost,default
```
0186688d-fxxx-497bfdda6c8e and default are the dimension values of rabbitmq_instance_id and rabbitmq_vhost. For details about how to obtain them, see the guide in the Dimension table.

To batch query metrics by calling the API, the rabbitmq_vhost dimension is used as follows:

"dimensions": [ 
                 { 
                     "name": "rabbitmq_instance_id", 
                     "value": "0186688d-fxxx-497bfdda6c8e"    
                 }, 
                 { 
                     "name": "rabbitmq_vhost", 
                     "value": "default" 
                 } 
             ]

0186688d-fxxx-497bfdda6c8e and default are the dimension values of rabbitmq_instance_id and rabbitmq_vhost. For details about how to obtain them, see the guide in the Dimension table.

Dimension

Key	Value
rabbitmq_instance_id	RabbitMQ instance ID, for example, 0186688d-fxxx-497bfdda6c8e. To obtain the value, call the Listing All Instances API and extract the value from the response parameters.
rabbitmq_vhost	RabbitMQ instance virtual host name, for example, default. To obtain the value, call the Querying Instance Monitoring Dimensions API and extract the value from the response parameters.
rabbitmq_vhost_exchange	RabbitMQ instance exchange name, for example, Exchange-01. To obtain the value, call the Querying Instance Monitoring Dimensions API and extract the value from the response parameters.
rabbitmq_vhost_queue	RabbitMQ instance queue name, for example, Queue-01. To obtain the value, call the Querying Instance Monitoring Dimensions API and extract the value from the response parameters.

Parent topic: Viewing Metrics and Configuring Alarms

Previous topic: Monitoring Metrics for RabbitMQ 3.x.x

Next topic: Configuring RabbitMQ Alarms

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.