RabbitMQ

The RabbitMQ Integration enables real-time visibility into your message broker performance. Monitor your queues, exchanges, channels, and nodes by creating custom visualizations to track the metrics that matter most to your system.

Prerequisites

Middleware Host Agent (MW Agent) v 1.13.0+ must be installed on your local machine. To install the MW Agent, see our Installation Guide.

This integration supports RabbitMQ versions 3.8 and 3.9.

The RabbitMQ Management Plugin must be enabled by following the official instructions.

Also, a user with at least monitoring level permissions must be used for monitoring.

RabbitMQ Configuration

Enable the Management Plugin

The Middleware Agent requires the RabbitMQ management plugin to collect telemetry data:

1rabbitmq-plugins enable rabbitmq_management

Create a Monitoring User

Create a dedicated user for monitoring:

1# Create user (replace <username> and <password> with your values)
2rabbitmqctl add_user <username> <password>
3
4# Set user tags (monitoring tag allows read-only access to management API)
5rabbitmqctl set_user_tags <username> monitoring
6
7# Grant permissions to the default vhost
8rabbitmqctl set_permissions -p / <username> ".*" ".*" ".*"

Verify User Permissions

Check that the user has the correct permissions:

1rabbitmqctl list_user_permissions <username>

Test the Connection

Verify that the monitoring user can access the management API:

1curl -u <username>:<password> http://localhost:15672/api/overview

If successful, this command should return JSON data about your RabbitMQ server.

Setup

Step 1: Access Integrations

Login to your Middleware account, navigate to the Rabbit MQ integration, and connect RabbitMQ:

Step 2: Add RabbitMQ Host

Select the host on which you want to install the the rabbitmq integration.

Step 3: Add Configuration for RabbitMQ Host.

Add your RabbitMQ endpoint, credentials for a user with at least monitoring, and collection interval for the metrics.

Visualize Data

To see how the data is flowing from RabbitMQ, you can create your own widget from scratch. To do so, navigate to the Dashboard Builder and select the dashboard you would like to create a widget in. Select Add New Widget and choose RabbitMQ as a data source.

Metrics Collected

Create your own widget from scratch. Navigate to the Dashboard Builder and select the dashboard you would like to create a widget in. Select Add New Widget and choose the RabbitMQ data source.