Skip to main content

RabbitMQ on Instances

Monitoring RabbitMQ Message Broker running on Instances

Overview

Rabbitmq sfAgent plugin provides metrics related to RabbitMQ message broker.

Metrics collected by the plugin are organized across the following categories

  • clusterDetails
  • nodeStats
  • connectionStats
  • channelStats
  • exchangeStats
  • queueStats
  • consumerStats

Note: node-is-quorum-critical and node-is-mirror-sync-critical is supported on 3.9 and above.

Tested on: RabbitMQ version 3.9 and 3.7

Configuration

sfAgent section provides steps to install and automatically generate plugin configurations. User can also manually add the configuration shown below to config.yaml under /opt/sfagent/ directory

Metrics

plugins 

      name: rabbitmq
enabled: true
interval: 60
config:
documentsTypes:
- clusterDetails
- nodeStats
- connectionStats
- channelStats
- exchangeStats
- queueStats
- consumerStats
host: localhost
password: <password>
port: 15672
secure: false
username: <username>

Parameters required in metrics plugin  

  • Username: username of the RabbitMQ user
  • password: password for RabbitMQ
  • port: Broker Port
  • secure: http(false) or https(true)
  • documentTypes: User can either leave this empty to collect all documentTypes or mention specific documentTypes to collect. Available options for plugin type RabbitMQ are clusterDetails, nodeStats, connectionStats, exchangeStats, queueStats, consumerStats

Viewing data and dashboards

  • Data generated by plugin can be viewed in browse data page inside the respective application under plugin=RabbitMQ and documentType=Cluster_details.
  • Dashboard for this data can be instantiated by Importing dashboard template RabbitMQ to the application dashboard.