Skip to main content

RabbitMQ

Plugin: go.d.plugin Module: rabbitmq

Overview

This collector monitors RabbitMQ instances.

It collects data using an HTTP-based API provided by the management plugin. The following endpoints are used:

  • /api/definitions (one-time retrieval, used to obtain the cluster ID and name)
  • /api/overview
  • /api/nodes
  • /api/vhosts
  • /api/queues (disabled by default)

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per cluster

These metrics refer to the RabbitMQ Cluster.

Labels:

LabelDescription
cluster_idUnique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_nameUser-defined name of the cluster as set using rabbitmqctl set_cluster_name. If not set, it will be "unset".

Metrics:

MetricDimensionsUnit
rabbitmq.messages_countready, unacknowledgedmessages
rabbitmq.messages_rateack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, get_empty, get_no_ack, deliver_get, redeliver, return_unroutablemessages/s
rabbitmq.objects_countchannels, consumers, connections, queues, exchangesmessages
rabbitmq.connection_churn_ratecreated, closedoperations/s
rabbitmq.channel_churn_ratecreated, closedoperations/s
rabbitmq.queue_churn_ratecreated, deleted, declaredoperations/s

Per node

These metrics refer to the RabbitMQ node.

Labels:

LabelDescription
cluster_idUnique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_nameUser-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be "unset".
nodeName of the node.

Metrics:

MetricDimensionsUnit
rabbitmq.node_avail_statusrunning, downstatus
rabbitmq.node_network_partition_statusclear, detectedstatus
rabbitmq.node_mem_alarm_statusclear, triggeredstatus
rabbitmq.node_disk_free_alarm_statusclear, triggeredstatus
rabbitmq.node_file_descriptors_usageusedfd
rabbitmq.node_sockets_usageusedsockets
rabbitmq.node_erlang_processes_usageusedprocesses
rabbitmq.node_erlang_run_queue_processes_countlengthprocesses
rabbitmq.node_memory_usageusedbytes
rabbitmq.node_disk_space_free_sizefreebytes
rabbitmq.node_uptimeuptimeseconds

Per cluster peer

These metrics refer to the RabbiMQ cluster peer.

Labels:

LabelDescription
cluster_idUnique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_nameUser-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be "unset".
nodeName of the node.
peerName of the remote node in the cluster.

Metrics:

MetricDimensionsUnit
rabbitmq.node_peer_cluster_link_trafficreceived, sentbytes/s

Per vhost

These metrics refer to the virtual host.

Labels:

LabelDescription
cluster_idUnique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_nameUser-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be "unset".
vhostName of the virtual host.

Metrics:

MetricDimensionsUnit
rabbitmq.vhost_statusrunning, stopped, partialstatus
rabbitmq.vhost_messages_countready, unacknowledgedmessages
rabbitmq.vhost_messages_rateack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, get_no_ack, deliver_get, redeliver, return_unroutablemessages/s

Per queue

These metrics refer to the virtual host queue.

Labels:

LabelDescription
cluster_idUnique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_nameUser-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be "unset".
nodeName of the node.
vhostName of the virtual host.
queueName of the queue.

Metrics:

MetricDimensionsUnit
rabbitmq.queue_statusrunning, down, idle, crashed, stopped, minority, terminatedstatus
rabbitmq.queue_messages_countready, unacknowledged, paged_out, persistentmessages
rabbitmq.queue_messages_rateack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, get_no_ack, deliver_get, redeliver, return_unroutablemessages/s

Alerts

The following alerts are available:

Alert nameOn metricDescription
rabbitmq_node_avail_status_down rabbitmq.node_avail_statusRabbitMQ node is down (node ${label:node} cluster ${label:cluster_id})
rabbitmq_node_network_partition_status rabbitmq.node_network_partition_statusRabbitMQ network partition detected (node ${label:node} cluster ${label:cluster_id})
rabbitmq_node_mem_alarm_status_triggered rabbitmq.node_mem_alarm_statusRabbitMQ mem alarm triggered (node ${label:node} cluster ${label:cluster_id})
rabbitmq.node_disk_free_alarm_status_triggered rabbitmq.node_disk_free_alarm_statusRabbitMQ disk free alarm triggered (node ${label:node} cluster ${label:cluster_id})
rabbitmq_vhost_status_unhealthy rabbitmq.vhost_statusRabbitMQ vhost is not healthy (vhost ${label:vhost} cluster ${label:cluster_id})
rabbitmq_queue_status_minority rabbitmq.queue_statusRabbitMQ queue insufficient online members (queue ${label:queue} node ${label:node} cluster ${label:cluster_id})
rabbitmq_queue_status_unhealthy rabbitmq.queue_statusRabbitMQ queue is unhealthy (queue ${label:queue} node ${label:node} cluster ${label:cluster_id})

Setup

You can configure the rabbitmq collector in two ways:

MethodBest forHow to
UIFast setup without editing filesGo to Nodes → Configure this node → Collectors → Jobs, search for rabbitmq, then click + to add a job.
FileIf you prefer configuring via file, or need to automate deployments (e.g., with Ansible)Edit go.d/rabbitmq.conf and add a job.
important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

Enable management plugin.

The management plugin is included in the RabbitMQ distribution, but disabled. To enable see Management Plugin documentation.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
GroupOptionDescriptionDefaultRequired
Collectionupdate_everyData collection interval (seconds).1no
autodetection_retryAutodetection retry interval (seconds). Set 0 to disable.0no
TargeturlTarget endpoint URL.http://localhost:15672"yes
timeoutHTTP request timeout (seconds).1no
Metrics Selectioncollect_queues_metricsCollect per-vhost, per-queue metrics. May cause significant overhead if many queues exist.nono
HTTP AuthusernameUsername for Basic HTTP authentication.guestno
passwordPassword for Basic HTTP authentication.guestno
bearer_token_filePath to a file containing a bearer token (used for Authorization: Bearer).no
TLStls_skip_verifySkip TLS certificate and hostname verification (insecure).nono
tls_caPath to CA bundle used to validate the server certificate.no
tls_certPath to client TLS certificate (for mTLS).no
tls_keyPath to client TLS private key (for mTLS).no
Proxyproxy_urlHTTP proxy URL.no
proxy_usernameUsername for proxy Basic HTTP authentication.no
proxy_passwordPassword for proxy Basic HTTP authentication.no
RequestmethodHTTP method to use.GETno
bodyRequest body (e.g., for POST/PUT).no
headersAdditional HTTP headers (one per line as key: value).no
not_follow_redirectsDo not follow HTTP redirects.nono
force_http2Force HTTP/2 (including h2c over TCP).nono
Virtual NodevnodeAssociates this data collection job with a Virtual Node.no

via UI

Configure the rabbitmq collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the rabbitmq data-collection job to run and click the (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type rabbitmq (or scroll the list) to locate the rabbitmq collector.
  5. Click the + next to the rabbitmq collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/rabbitmq.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/rabbitmq.conf
Examples
Basic

An example configuration.

Config
jobs:
- name: local
url: http://127.0.0.1:15672

Basic HTTP auth

Local server with basic HTTP authentication.

Config
jobs:
- name: local
url: http://127.0.0.1:15672
username: admin
password: password

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Local and remote instances.

Config
jobs:
- name: local
url: http://127.0.0.1:15672

- name: remote
url: http://192.0.2.0:15672

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the rabbitmq collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m rabbitmq

    To debug a specific job:

    ./go.d.plugin -d -m rabbitmq -j jobName

Getting Logs

If you're encountering problems with the rabbitmq collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep rabbitmq

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep rabbitmq /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep rabbitmq

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.