RabbitMQ Exporter

Prometheus exporter for RabbitMQ metrics, based on RabbitMQ HTTP API.

Dependencies

• Prometheus client for Golang
• Logging

Setting up locally rabbitMQ and exporter with docker

1. Start rabbitMQ

    $ docker run -d -e RABBITMQ_NODENAME=my-rabbit --name my-rabbit -p 15672:15672 -p 9090:9090 rabbitmq:3-management
   

2. Start rabbitmq_exporter in container.

    $ docker run -d --net=container:my-rabbit kbudde/rabbitmq-exporter
   

Now your metrics are available through http://localhost:9090/metrics.

The rabbitmq_exporter is sharing the network interface with the rabbitmq container -> it is possible to use localhost and default user/password. Disadvantage: you have to publish the port (9090) in the rabbitmq container.

Configuration

Rabbitmq_exporter uses environment variables for configuration. Settings:

• RABBIT_URL: "http://localhost:15672",
• RABBIT_USER: "guest",
• RABBIT_PASSWORD: "guest",
• PUBLISH_PORT: "9090",
• OUTPUT_FORMAT: "TTY", //change to JSON if needed
• LOG_LEVEL: "info", // can be "debug", "info", "warning", "error", "fatal", or "panic"
• CAFILE: "ca.pem", // default is ca.pem. If file does not exist it will be ignored.
• SKIPVERIFY: false or 0, true or 1 // will skip hostname/certificate check at all
• INCLUDE_QUEUES: ".*", // regex, matching queue names are exported
• SKIP_QUEUES: "^$", // regex, matching queue names are not exported (useful for short-lived rpc queues). First performed INCLUDE, after SKIP
• RABBIT_CAPABILITIES: "", // comma-separated list of extended scraping capabilities supported by the target RabbitMQ server

Example

OUTPUT_FORMAT=JSON PUBLISH_PORT=9099 ./rabbitmq_exporter

Extended RabbitMQ capabilities

Newer version of RabbitMQ can provide some features that reduce overhead imposed by scraping the data needed by this exporter. The following capabilities are currently supported in RABBIT_CAPABILITIES env var:

• no_sort: By default RabbitMQ management plugin sorts results using the default sort order of vhost/name. This sorting overhead can be avoided by passing empty sort argument (?sort=) to RabbitMQ starting from version 3.6.8. This option can be safely enabled on earlier 3.6.X versions, but it'll not give any performance improvements. And it's incompatible with 3.4.X and 3.5.X.
• bert: Since 3.6.9 (see rabbitmq/rabbitmq-management#367) RabbitMQ supports BERT encoding as a JSON alternative. Given that BERT encoding is implemented in C inside the Erlang VM, it's way more effective than pure-Erlang JSON encoding. So this greatly reduces monitoring overhead when we have a lot of objects in RabbitMQ.

Metrics

All metrics (except golang/prometheus metrics) are prefixed with "rabbitmq_".

Global

Queues

Labels: vhost, queue

Gauge

Counter

Exchanges - Counter

Labels: vhost, exchange

Docker

To create a docker image locally it is recommened to use the Makefile. Promu is used for building the statically linked binary which is added to the scratch image.

   make docker