Setup Requirements

Data Collection Setup

The collector interacts with the Management Plugin to collect metrics for BindPlane, so the Management Plugin must be enabled.

Network Requirements

Enable the Management Plugin for RabbitMQ

  • Click the text above to read more!

Least Privileged User

The RabbitMQ Management Plugin requires authentication and authorization using a username and password. The user must at least have the "management" tag in order for it to be authorized to access the plugin.

One way to create a new user with the required tag is using rabbitmqctl. For example:

# User 'bindplane_collector' is created with the password 'p@55w0rd', but does not have the required tag yet
rabbitmqctl add_user bindplane_collector p@55w0rd

# 'Monitoring' tag is added to the user, giving it the required permissions
rabbitmqctl set_user_tags bindplane_collector monitoring

# Give the user read access to all queues in order to collect queue metrics
rabbitmqctl set_permissions bindplane_collector '' '' '.*'

# To restrict access to only specific queues, replace '.*' with a regex pattern for the queue name(s)
# rabbitmqctl set_permissions bindplane_collector '' '' '.*-development'

Users can also be created and updated from the management plugin's web interface. See the RabbitMQ documentation for details on creating users and the different available tags.

Supported Versions

RabbitMQ: All versions of 3.x

Connection Parameters

HostRequiredHostname or IP address of the RabbitMQ host.
PortPort that the RabbitMQ Management Plugin is running on.
SSL Configuration
UsernameRequiredUsername for authenticating with the RabbitMQ Management Plugin.
PasswordRequiredPassword for authenticating with the RabbitMQ Management Plugin.
Maximum Parallel RequestsMaximum number of requests to make to the RabbitMQ host at one time.