Prometheus Exporter of Core (Raw, Unaggregated) RabbitMQ Metrics
Getting Started
This is a Prometheus exporter of core (raw, unaggregated) RabbitMQ metrics, developed by the RabbitMQ core team. It is largely a "clean room" design that reuses some prior work from Prometheus exporters done by the community.
Project Maturity
This plugin is new and relatively immature. It shipped in the RabbitMQ distribution starting with 3.8.0
.
Documentation
See Monitoring RabbitMQ with Prometheus and Grafana.
Installation
This plugin is included into RabbitMQ 3.8.x releases. Like all plugins, it has to be enabled before it can be used:
To enable it with rabbitmq-plugins:
rabbitmq-plugins enable rabbitmq_prometheus
Usage
See the documentation guide.
Default port used by the plugin is 15692
. In most environments there would be no configuration
necessary.
See the entire list of metrics exposed via the default port.
Configuration
This exporter supports the following options via a set of prometheus.*
configuration keys:
prometheus.path
defines a scrape endpoint. Default is"/metrics"
.prometheus.tcp.*
controls HTTP listener settings that match those used by the RabbitMQ HTTP APIprometheus.ssl.*
controls TLS (HTTPS) listener settings that match those used by the RabbitMQ HTTP API
Sample configuration snippet:
# these values are defaults
prometheus.path = /metrics
prometheus.tcp.port = 15692
Contributing
See CONTRIBUTING.md.
Makefile
This project uses erlang.mk, running make help
will return erlang.mk help.
To see all custom targets that have been documented, run make h
.
For BASH shell autocompletion, run eval "$(make autocomplete)"
, then type make a<TAB>
to see all Make targets starting with the letter a
, e.g.:
$ make a<TAB
ac all.coverdata app-build apps apps-eunit asciidoc-guide autocomplete
all app app-c_src apps-ct asciidoc asciidoc-manual
Copyright
(c) Pivotal Software Inc., 2007-2020.