rabbitmq_exporter

1.0.0 Opens a new window with list of versions in this module.

Prometheus exporter for RabbitMQ For more information about how to use this package see README

Latest version published 2 months ago

GitHub

Package Health Score

86 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Popularity

Recognized

Imported By: 0
GitHub Stars: 673
Forks: 193
Contributors: 40

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package rabbitmq_exporter, we found that it has been 673 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Mar 18, 2024

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like rabbitmq_exporter is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 3
Open PR: 6
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of github.com/kbudde/rabbitmq_exporter based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that github.com/kbudde/rabbitmq_exporter demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the github.com/kbudde/rabbitmq_exporter repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like github.com/kbudde/rabbitmq_exporter is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

📣 EOL Announcement

IMPORTANT: This exporter only works with RabbitMQ 3. Please use the official exporter for RabbitMQ 4 or newer. See https://github.com/kbudde/rabbitmq_exporter/issues/383 for details.

RabbitMQ Exporter

Prometheus exporter for RabbitMQ metrics. Data is scraped by prometheus.

Please note this an unofficial plugin. There is also an official plugin from RabbitMQ.com. See comparison to official exporter

Installation

Binary release

You can download the latest release on the release page. Docker images are push to docker hub

docker: rabbitmq container with network sharing

The rabbitmq_exporter is sharing the network interface with the rabbitmq container -> it is possible to use localhost and default user/password (guest).

Start rabbitMQ

 docker run -d -e RABBITMQ_NODENAME=my-rabbit --name my-rabbit -p 9419:9419 rabbitmq:3-management

Start rabbitmq_exporter in container.

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

Now your metrics are exposed through https://host:9419/metrics. The management plugin does not need to be exposed.

Configuration

Rabbitmq_exporter can be configured using json config file or environment variables for configuration.

Config file

Rabbitmq_exporter expects config file in "conf/rabbitmq.conf". If you are running the exporter in a container (docker/kubernetes) the config must be in "/conf/rabbitmq.conf" The name of the file can be overriden with flag:

./rabbitmq_exporter -config-file config.example.json

You can find an example here. Note: If you are using a config file, you must provide all values as there is no default value.

Settings

Environment variable	default	description
RABBIT_URL		url to rabbitMQ management plugin (must start with http(s)😕/)
RABBIT_USER	guest	username for rabbitMQ management plugin. User needs monitoring tag!
RABBIT_PASSWORD	guest	password for rabbitMQ management plugin
RABBIT_CONNECTION	direct	direct or loadbalancer, strips the self label when loadbalancer
RABBIT_USER_FILE		location of file with username (useful for docker secrets)
RABBIT_PASSWORD_FILE		location of file with password (useful for docker secrets)
PUBLISH_PORT	9419	Listening port for the exporter
PUBLISH_ADDR	""	Listening host/IP for the exporter
OUTPUT_FORMAT	TTY	Log ouput format. TTY and JSON are suported
LOG_LEVEL	info	log level. possible values: "debug", "info", "warning", "error", "fatal", or "panic"
CAFILE	ca.pem	path to root certificate for access management plugin. Just needed if self signed certificate is used. Will be ignored if the file does not exist
CERTFILE	client-cert.pem	path to client certificate used to verify the exporter's authenticity. Will be ignored if the file does not exist
KEYFILE	client-key.pem	path to private key used with certificate to verify the exporter's authenticity. Will be ignored if the file does not exist
SKIPVERIFY	false	true/0 will ignore certificate errors of the management plugin
SKIP_VHOST	^$	regex, matching vhost names are not exported. First performs INCLUDE_VHOST, then SKIP_VHOST. Applies to queues and exchanges
INCLUDE_VHOST	.*	regex vhost filter. Only matching vhosts are exported. Applies to queues and exchanges
INCLUDE_QUEUES	.*	regex queue filter. Just matching names are exported
SKIP_QUEUES	^$	regex, matching queue names are not exported (useful for short-lived rpc queues). First performed INCLUDE, after SKIP
INCLUDE_EXCHANGES	.*	regex exchange filter. (Only exchanges in matching vhosts are exported)
SKIP_EXCHANGES	^$	regex, matching exchanges names are not exported. First performed INCLUDE, after SKIP
RABBIT_CAPABILITIES	bert,no_sort	comma-separated list of extended scraping capabilities supported by the target RabbitMQ server
RABBIT_EXPORTERS	exchange,node,queue	List of enabled modules. Possible modules: connections,shovel,federation,exchange,node,queue,memory
RABBIT_TIMEOUT	30	timeout in seconds for retrieving data from management plugin.
MAX_QUEUES	0	max number of queues before we drop metrics (disabled if set to 0)
EXCLUDE_METRICS		Metric names to exclude from export. comma-seperated. e.g. "recv_oct, recv_cnt". See exporter_*.go for names

Example and recommended settings:

SKIP_QUEUES="RPC_.*" MAX_QUEUES=5000 ./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 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.

Comparison to official exporter

official exporter:

has runtime/erlang metrics
aggregated or per-object metrics
missing filter

This exporter:

works also with older versions of rabbitmq
has more configuration options/ filtering of objects
(bad) depends on data from management interface which can be slow/delayed

probalby best solution is to use both exporters: comment from shamil

common errors / FAQ

msg: Error while retrieving data from rabbitHost statusCode: 500

This exporter expects capabilities from rabbitmq 3.6.8 or newer by default. If you are running older than 3.6.8 you must disable bert and no_sort with the setting RABBIT_CAPABILITIES=compat. If you are running 3.13.0 or newer you must disable no_sort with the setting RABBIT_CAPABILITIES=no_sort.

missing data in graphs

If there is a load balancer between the exporter and the RabbitMQApi, the setting RABBIT_CONNECTION=loadbalancer must be activated. See https://github.com/kbudde/rabbitmq_exporter/issues/131 for details.

build and test

This project uses goreleaser to build and release the project. You can build the project with the following command:

goreleaser build --snapshot

go build will also work, but it will not include the version information, uses cgo, etc.

To run the tests, use the following command:

go test -v ./...

If you have docker installed, you can run the tests with the following command:

go test -v ./... --tags integration

This will start a rabbitmq container and run the tests against it.

Metrics

The metrics are documented in the metrics.md file.

FAQs

What is rabbitmq_exporter?

Prometheus exporter for RabbitMQ. Visit Snyk Advisor to see a full health score report for rabbitmq_exporter, including popularity, security, maintenance & community analysis.

Is rabbitmq_exporter popular?

The golang package rabbitmq_exporter receives a total of ? weekly downloads. As such, rabbitmq_exporter popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is rabbitmq_exporter well maintained?

We found that rabbitmq_exporter demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is rabbitmq_exporter safe to use?

The golang package rabbitmq_exporter was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 May-2024, at 00:55 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP