Dashboard - Message Queue for RabbitMQ - Alibaba Cloud Documentation Center

Message Queue for RabbitMQ uses Prometheus Service and Grafana Service that are provided by Application Real-Time Monitoring Service (ARMS) to offer the dashboard feature for Enterprise Edition and Platinum Edition instances. Prometheus Service is used to monitor performance and Grafana Service is used to store and display metrics. You can use the dashboard feature to view various metric data of Enterprise Edition and Platinum Edition instances, vhosts, queues, and exchanges. This helps you identify and locate issues at the earliest opportunity. This topic describes the metrics on dashboards and how to use the metrics.

Precautions

Instance editions

Enterprise Edition
Platinum Edition

Supported regions

This feature is available only in the China (Guangzhou) region.

Service-linked role

When you view the dashboard, Message Queue for RabbitMQ automatically creates the AliyunServiceRoleForAmqpMonitoring service-linked role for you.

If the service-linked role is not created, Message Queue for RabbitMQ automatically creates the service-linked role. This way, you can use the dashboard feature of Message Queue for RabbitMQ.
If the service-linked role is created, Message Queue for RabbitMQ does not create the role.

For more information about service-linked roles, see Service-linked roles.

Billing

Dashboard metrics that are used in Message Queue for RabbitMQ are basic metrics that are used in Alibaba Cloud ARMS Prometheus Service. You are not charged for the basic metrics. You are not charged for using the dashboard feature. For more information, see Basic metrics and Billing of Alibaba Cloud Prometheus Service.

Metrics

In Message Queue for RabbitMQ, the following sections display the metrics that are used in the dashboard of an instance:

Overview: displays metrics such as the number of messages, the number of connections, and the number of consumers in the instance.
Exchanges: displays the number of inbound messages and the number of outbound messages.
Queues: displays the number of messages, the API call rate, and the number of consumers in a queue.
VirtualHost: displays the API call rate, the number of channels, and the number of connections in a vhost.

Overview


Metric	Description
Ready messages	The number of messages that are ready to be consumed by consumers on the Message Queue for RabbitMQ broker. This metric shows the number of messages that are not processed by consumers. Unit: messages.
Current connections	The number of current connections to the Message Queue for RabbitMQ broker.
Current channels	The number of channels in the current connection to the Message Queue for RabbitMQ client.
Current consumers	The number of current Message Queue for RabbitMQ consumers.
Unacked deliver messages	The number of messages that are delivered but not acknowledged on the Message Queue for RabbitMQ broker. Unit: messages.
Unacked get messages	The number of messages that are received but not acknowledged on the Message Queue for RabbitMQ client. Unit: messages.
Exchange messages published in	The rate at which messages are published from the producer to the exchange. Unit: messages per second.
Exchange messages published out	The rate at which the exchange routes messages to a queue. Unit: messages per second.
Queue publish message rate	The rate at which the exchange routes messages to one or more queues. Unit: messages per second.
Queue deliver message rate	The rate at which the Message Queue for RabbitMQ instance delivers messages to a queue. Unit: messages per minute.
Queue ack message rate	The rate at which the consumer returns the number of ACK messages. Unit: messages per minute.
Queue get message rate	The rate at which the consumer consumes messages. The GET method is used to subscribe to the messages. Unit: messages per second.
Queue unack message rate	The rate at which the consumer delivers but does not acknowledge messages. Unit: messages per second.
Queue reject message rate	The rate at which messages are rejected. Unit: messages per second.
Queue recover message rate	The rate at which messages are recovered. Unit: messages per second.
Queue consumers	The number of consumers in a queue.

Exchange


Metric	Description
Exchange messages published in	The number of inbound messages in the exchange. Unit: messages.
Exchange messages published out	The number of outbound messages in the exchange. Unit: messages.

Queue


Metric	Description
Queue messages	The number of messages in a queue. Unit: messages.
Queue APIs rate	The API call rate at which messages are routed to a queue. Unit: messages per second.
Queue consumers	The number of consumers in a queue.

Virtual Host


Metric	Description
Rate per API	The average API call rate in a vhost. Unit: messages per second.
VirtualHost channels	The number of channels in a vhost.
VirtualHost connections	The number of connections to a vhost
Channels per Connection	The number of channels per connection.

Prerequisites

Message Queue for RabbitMQ is activated and an instance is created. For more information, see Activate Message Queue for RabbitMQ and Manage instances.
A vhost, a queue, and an exchange are created and available in the Message Queue for RabbitMQ instance. For more information, see Manage vhosts, Manage exchanges, and Manage queues.
ARMS is activated. For more information, see Enable ARMS Prometheus.

Procedure

Log on to the Message Queue for RabbitMQ console.
In the Resource Distribution section of the Overview page, select the region where your instance is located.
On the Instances page, click the name of your instance.
In the left-side navigation pane, click Dashboard. On the Dashboard page, view the dashboard.
You can specify the vhost, exchange, queue, and time range to view the dashboard based on your requirements.
- On the Dashboard page, click the drop-down arrow next to VirtualHost, ExchangeName, or QueueName. In the drop-down list that appears, enter the vhost, exchange, or queue that you want to view. If you do not enter vhost, exchange, and queue, the metrics of all vhosts, exchanges, and queues in the instance are displayed by default.
- In the upper-right corner of the Dashboard page, click the time picker. In the drop-down list that appears, select a predefined relative time range such as last 5 minutes, last 12 hours, or last 30 days. You can also specify the start time and end time to customize an absolute time range.
After the configuration is complete, you can view the metrics of the specified vhost, exchange, queue, or time range on the Dashboard page. For more information about the metrics, see Metrics.

Related operations

On the top of the metric panel of the Dashboard page, click the panel name. Then, you can perform the following operations:

To view the panel in full screen mode, click View or press the V key. Press Esc to exit the full screen mode.
To share the panel, click Share or press the P and SPS keys in sequence. In the Share Panel dialog box, obtain the sharing link, embedded link, or snapshot link of the panel.
To explore the panel, click Explore or press the X key. On the Explore page, check metrics, troubleshoot issues, or explore data.
To export the data of the panel as a CSV file, choose Inspect > Data. On the Data tab, click Download CSV to export data.
To obtain the JSON code of the panel, choose Inspect > Panel JSON. On the JSON tab, copy the JSON code.
To copy and paste the panel, choose More > Toggle legend, or press the P and D keys in sequence. The panel is copied and pasted into the current dashboard.