RabbitMQ icon

RabbitMQ

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.

Setup

You can configure the rabbitmq collector in two ways:

Method Best for How to
UI Fast setup without editing files Go to Nodes → Configure this node → Collectors → Jobs, search for rabbitmq, then click + to add a job.
File If 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.

Group Option Description Default Required
Collection update_every Data collection interval (seconds). 1 no
autodetection_retry Autodetection retry interval (seconds). Set 0 to disable. 0 no
Target url Target endpoint URL. http://localhost:15672" yes
timeout HTTP request timeout (seconds). 1 no
Metrics Selection collect_queues_metrics Collect per-vhost, per-queue metrics. May cause significant overhead if many queues exist. no no
HTTP Auth username Username for Basic HTTP authentication. guest no
password Password for Basic HTTP authentication. guest no
bearer_token_file Path to a file containing a bearer token (used for Authorization: Bearer). no
TLS tls_skip_verify Skip TLS certificate and hostname verification (insecure). no no
tls_ca Path to CA bundle used to validate the server certificate. no
tls_cert Path to client TLS certificate (for mTLS). no
tls_key Path to client TLS private key (for mTLS). no
Proxy proxy_url HTTP proxy URL. no
proxy_username Username for proxy Basic HTTP authentication. no
proxy_password Password for proxy Basic HTTP authentication. no
Request method HTTP method to use. GET no
body Request body (e.g., for POST/PUT). no
headers Additional HTTP headers (one per line as key: value). no
not_follow_redirects Do not follow HTTP redirects. no no
force_http2 Force HTTP/2 (including h2c over TCP). no no
Virtual Node vnode Associates 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 :gear: (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.

jobs:
  - name: local
    url: http://127.0.0.1:15672
Basic HTTP auth

Local server with basic HTTP authentication.

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.

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

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

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:

Label Description
cluster_id Unique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_name User-defined name of the cluster as set using rabbitmqctl set_cluster_name. If not set, it will be “unset”.

Metrics:

Metric Dimensions Unit
rabbitmq.messages_count ready, unacknowledged messages
rabbitmq.messages_rate ack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, get_empty, get_no_ack, deliver_get, redeliver, return_unroutable messages/s
rabbitmq.objects_count channels, consumers, connections, queues, exchanges messages
rabbitmq.connection_churn_rate created, closed operations/s
rabbitmq.channel_churn_rate created, closed operations/s
rabbitmq.queue_churn_rate created, deleted, declared operations/s

Per node

These metrics refer to the RabbitMQ node.

Labels:

Label Description
cluster_id Unique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_name User-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be “unset”.
node Name of the node.

Metrics:

Metric Dimensions Unit
rabbitmq.node_avail_status running, down status
rabbitmq.node_network_partition_status clear, detected status
rabbitmq.node_mem_alarm_status clear, triggered status
rabbitmq.node_disk_free_alarm_status clear, triggered status
rabbitmq.node_file_descriptors_usage used fd
rabbitmq.node_sockets_usage used sockets
rabbitmq.node_erlang_processes_usage used processes
rabbitmq.node_erlang_run_queue_processes_count length processes
rabbitmq.node_memory_usage used bytes
rabbitmq.node_disk_space_free_size free bytes
rabbitmq.node_uptime uptime seconds

Per cluster peer

These metrics refer to the RabbiMQ cluster peer.

Labels:

Label Description
cluster_id Unique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_name User-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be “unset”.
node Name of the node.
peer Name of the remote node in the cluster.

Metrics:

Metric Dimensions Unit
rabbitmq.node_peer_cluster_link_traffic received, sent bytes/s

Per vhost

These metrics refer to the virtual host.

Labels:

Label Description
cluster_id Unique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_name User-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be “unset”.
vhost Name of the virtual host.

Metrics:

Metric Dimensions Unit
rabbitmq.vhost_status running, stopped, partial status
rabbitmq.vhost_messages_count ready, unacknowledged messages
rabbitmq.vhost_messages_rate ack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, get_no_ack, deliver_get, redeliver, return_unroutable messages/s

Per queue

These metrics refer to the virtual host queue.

Labels:

Label Description
cluster_id Unique identifier for the cluster, automatically assigned by RabbitMQ.
cluster_name User-defined name of the cluster as set using rabbitmqctl set_cluster_name <NAME>. If not set, it will be “unset”.
node Name of the node.
vhost Name of the virtual host.
queue Name of the queue.

Metrics:

Metric Dimensions Unit
rabbitmq.queue_status running, down, idle, crashed, stopped, minority, terminated status
rabbitmq.queue_messages_count ready, unacknowledged, paged_out, persistent messages
rabbitmq.queue_messages_rate ack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, get_no_ack, deliver_get, redeliver, return_unroutable messages/s

Alerts

The following alerts are available:

Alert name On metric Description
rabbitmq_node_avail_status_down rabbitmq.node_avail_status RabbitMQ node is down (node ${label:node} cluster ${label:cluster_id})
rabbitmq_node_network_partition_status rabbitmq.node_network_partition_status RabbitMQ network partition detected (node ${label:node} cluster ${label:cluster_id})
rabbitmq_node_mem_alarm_status_triggered rabbitmq.node_mem_alarm_status RabbitMQ mem alarm triggered (node ${label:node} cluster ${label:cluster_id})
rabbitmq.node_disk_free_alarm_status_triggered rabbitmq.node_disk_free_alarm_status RabbitMQ disk free alarm triggered (node ${label:node} cluster ${label:cluster_id})
rabbitmq_vhost_status_unhealthy rabbitmq.vhost_status RabbitMQ vhost is not healthy (vhost ${label:vhost} cluster ${label:cluster_id})
rabbitmq_queue_status_minority rabbitmq.queue_status RabbitMQ queue insufficient online members (queue ${label:queue} node ${label:node} cluster ${label:cluster_id})
rabbitmq_queue_status_unhealthy rabbitmq.queue_status RabbitMQ queue is unhealthy (queue ${label:queue} node ${label:node} cluster ${label:cluster_id})

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

The observability platform companies need to succeed

Sign up for free

Want a personalised demo of Netdata for your use case?

Book a Demo