RabbitMQ (Management API)
- Product information
- Release notes
Overview
This python extension connects to your RabbitMQ cluster via the Nodes Management API, to collect metrics for:
- Clusters
- Nodes
- Virtual Hosts
- Queues
These entities are then created in Dynatrace with relationships between them. The extension provides customized screens and metrics for each entity.
Use cases
With this extension you are able to monitor your RabbitMQ clusters directly via the Management API.
Get individual details about queues, virtual hosts, nodes and clusters.
Get started
Create a monitoring configuration, the parameters are:
- Cluster name - A friendly name for the cluster or node.
- Nodes - A list of management API urls for the nodes in the cluster. Optionally you can also specify a load balancer url.
- Username - The username to use for the management API, it must have the
monitoringpermission. - Password - The password to use for the management API.
- Queues to monitor - A list of queues that should be monitored, it can be a regular expression.
Compatibility information
Your RabbitMQ broker must have the management plugin enabled. This is enabled by default.
Extension content
Content typeNumber of items included
metric metadata
39
list screen layout
4
screen layout
4
screen entities lists
11
dashboards
1
generic type
4
generic relationship
5
screen chart groups
7
Feature sets
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
Feature setsNumber of metrics included
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Messages (Cluster) | rabbitmq.cluster.messages | Total messages (ready + unacknowledged) in the cluster | Count |
| Messages Ready (Cluster) | rabbitmq.cluster.messages_ready | Total messages ready in the cluster | Count |
| Messages Unacknowledged (Cluster) | rabbitmq.cluster.messages_unacknowledged | Total messages unacknowledged in the cluster | Count |
| Consumers (Cluster) | rabbitmq.cluster.consumers | Number of consumers | Count |
| Connections (Cluster) | rabbitmq.cluster.connections | Number of connections | Count |
| Queues | rabbitmq.cluster.queues | Number of queues | Count |
| Exchanges | rabbitmq.cluster.exchanges | Number of exchanges | Count |
| Channels | rabbitmq.cluster.channels | Number of channels | Count |
| Messages Acknowledged (Cluster) | rabbitmq.cluster.ack.count | Total messages acknowledged in the cluster | Count |
| Messages Unacknowledged (Cluster) | rabbitmq.cluster.unack.count | Total messages unacknowledged in the cluster | Count |
| Messages Delivered (Cluster) | rabbitmq.cluster.deliver_get.count | Total messages delivered in the cluster | Count |
| Messages Published (Cluster) | rabbitmq.cluster.publish.count | Total messages published in the cluster | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Memory Used | rabbitmq.node.mem_used | Memory used in bytes. | Byte |
| Memory Limit | rabbitmq.node.mem_limit | Point at which the memory alarm will go off. | Byte |
| File Descriptors Used | rabbitmq.node.fd_used | Used file descriptors. | Count |
| File descriptors available | rabbitmq.node.fd_total | File descriptors available | Count |
| Sockets Used | rabbitmq.node.sockets_used | File descriptors used as sockets. | Count |
| Sockets Available | rabbitmq.node.sockets_total | File descriptors available to be used as sockets. | Count |
| Disk Free | rabbitmq.node.disk_free | Disk free space in bytes. | Byte |
| Partitions | rabbitmq.node.partitions | Number of network partitions this node is seeing. | Count |
| Uptime | rabbitmq.node.uptime | Time since the Erlang VM started, in milliseconds. | MilliSecond |
| Garbage Collection Count | rabbitmq.node.gc_num.count | Number of garbage collections. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Messages | rabbitmq.queue.messages | Sum of ready and unacknowledged messages (queue depth). | Count |
| Messages Ready | rabbitmq.queue.messages_ready | Number of messages ready to be delivered to clients. | Count |
| Messages Unacknowledged | rabbitmq.queue.messages_unacknowledged | Number of messages delivered to clients but not yet acknowledged. | Count |
| Message Bytes | rabbitmq.queue.message_bytes | Sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead. | Byte |
| Memory | rabbitmq.queue.memory | Bytes of memory allocated by the runtime for the queue, including stack, heap and internal structures. | Byte |
| Consumers | rabbitmq.queue.consumers | Number of consumers. | Count |
| Publish | rabbitmq.queue.publish.count | Count of messages published. | Count |
| Redeliver | rabbitmq.queue.redeliver.count | Count of subset of messages in deliver_get which had the redelivered flag set. | Count |
| Messages Delivered | rabbitmq.queue.messages_delivered.count | Messages delivered to consumers. | Count |
| Messages Delivered No Ack | rabbitmq.queue.messages_deliver_no_ack.count | Count of messages delivered in no-acknowledgement mode to consumers. | Count |
| Messages Dropped Unroutable | rabbitmq.queue.drop_unroutable.count | Count of messages dropped as unroutable. | Count |
| Messages Returned Unroutable | rabbitmq.queue.return_unroutable.count | Count of messages returned to the publisher as unroutable. | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Messages (Virtual Host) | rabbitmq.vhost.messages | Sum of ready and unacknowledged messages for all queues in the Virtual Host. | Count |
| Messages Ready (Virtual Host) | rabbitmq.vhost.messages_ready | Number of messages ready to be delivered to clients for all queues in the Virtual Host. | Count |
| Messages Unacknowledged (Virtual Host) | rabbitmq.vhost.messages_unacknowledged | Number of messages delivered to clients but not yet acknowledged for all queues in the Virtual Host. | Count |
| Bytes Received (Virtual Host) | rabbitmq.vhost.recv_oct.count | Total number of bytes received on the network for all queues in the Virtual Host. | Byte |
| Bytes Sent (Virtual Host) | rabbitmq.vhost.send_oct.count | Total number of bytes sent on the network for all queues in the Virtual Host. | Byte |
Full version history
To have more information on how to install the downloaded package, please follow the instructions on this page.
ReleaseDate
Full version history
Version 2.1.3
- Fix an issue where invalid characters like tabs were used on the virtual host name, creating invalid dimensions
Full version history
Version 2.1.2
- Fix an issue where queues with special characters like tabs in the name were not being ingested
Full version history
Version 2.1.1
- Fix an issue where certificates were validated even if the validate option was disabled.
Full version history
Version 2.1.0
- Allow the extension to run from the OneAgent
Note: Existing monitoring configurations must be recreated because of the schema change
Full version history
Version 2.0.2
- Add support for the credential vault
- Add an option to ignore certificate validation
- Add an option to provide the path to a custom certificate to validate the server ceritifcate
Full version history
Version 2.0.1
- Add the sourceEntityType for all metrics, allowing Management Zones to be created for the different entities
Full version history
Version 2.0.0
Initial version with RabbitMQ Management API
