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/overview
  • /api/node/{node_name}
  • /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 RabbitMQ instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
rabbitmq.messages_countready, unacknowledgedmessages
rabbitmq.messages_rateack, publish, publish_in, publish_out, confirm, deliver, deliver_no_ack, get, 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
rabbitmq.file_descriptors_countavailable, usedfd
rabbitmq.sockets_countavailable, usedsockets
rabbitmq.erlang_processes_countavailable, usedprocesses
rabbitmq.erlang_run_queue_processes_countlengthprocesses
rabbitmq.memory_usageusedbytes
rabbitmq.disk_space_free_sizefreebytes

Per vhost

These metrics refer to the virtual host.

Labels:

LabelDescription
vhostvirtual host name

Metrics:

MetricDimensionsUnit
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
vhostvirtual host name
queuequeue name

Metrics:

MetricDimensionsUnit
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

There are no alerts configured by default for this integration.

Setup

Prerequisites

Enable management plugin.

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

Configuration

File

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

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

Options

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

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://localhost:15672yes
collect_queues_metricsCollect stats per vhost per queues. Enabling this can introduce serious overhead on both Netdata and RabbitMQ if many queues are configured and used.nono
timeoutHTTP request timeout.1no
usernameUsername for basic HTTP authentication.no
passwordPassword for basic HTTP authentication.no
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient TLS certificate.no
tls_keyClient TLS key.no

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

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

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