RabbitMQ is an open-source message-broker software that originally implemented the Advanced Message Queuing protocol and has since been extended with a plug-in architecture to support Streaming Text Oriented Messaging Protocol, MQ Telemetry Transport, and other protocols.

Prerequisite

For Virtual Machines, install the Linux Agent.

Configuring the credentials

Configure the credentials in the directory /opt/opsramp/agent/conf/app.d/creds.yaml

rabbitmq:
- name: rabbitmq
  user: <username>
  pwd: <Password>
  encoding-type: plain
  labels:
    key1: val1
    key2: val2

Configuring the application

Virtual machine

Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-detection.yaml

- name: rabbitmq
  instance-checks:
    service-check:
      - rabbitmq-server
    process-check:
      - rabbitmq
    port-check:
      - 15672
      - 5672

Docker environment

Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-container-detection.yaml

- name: rabbitmq
  container-checks:
    image-check:
      - rabbitmq
    port-check:
      - 15672
      - 5672

Kubernetes environment

Configure the application in config.yaml

- name: rabbitmq
  container-checks:
    image-check:
      - rabbitmq
    port-check:
      - 15672
      - 5672

Validate

Go to Resources under the Infrastructure tab to check if your resources are onboarded and the metrics are collected.

Metrics

OpsRamp MetricMetric Display NameUnit
rabbitmq_connections

Number of connections at a given time
Connections
rabbitmq_connections_state

Number of connections in the specified connection state
Connections State
rabbitmq_exchange_messages_publish_count

Count of messages in exchanges published (instance name will be displayed in the format 'name_type_vhost')
Exchange Messages Publish
rabbitmq_exchange_messages_publish_in_count

Count of messages published from channels into this exchange (instance name will be displayed in the format 'name_type_vhost')
Exchange Messages Publish In
rabbitmq_exchange_messages_publish_in_rate

Rate of messages published from channels into this exchange per sec (instance name will be displayed in the format 'name_type_vhost')
Exchange Messages Publish In Rate
rabbitmq_exchange_messages_publish_out_count

Count of messages published from this exchange into queues (instance name will be displayed in the format 'name_type_vhost')
Exchange Messages Publish Out
rabbitmq_exchange_messages_publish_out_rate

Rate of messages published from this exchange into queues per second (instance name will be displayed in the format 'name_type_vhost')
Exchange Messages Publish Out Rate
rabbitmq_exchange_messages_publish_rate

Rate of messages in exchanges published per second (instance name will be displayed in the format 'name_type_vhost')
Exchange Messages Publish Rate
rabbitmq_node_disk_alarm

Does the node have disk alarm
Disk Alarm
rabbitmq_node_disk_free

Free disk of the rabbitmq node
Free DiskFree Disk,MB
rabbitmq_node_fd_used

Number of open file descriptors used
Open FDsOpen FDs
rabbitmq_node_mem_alarm

Does the host has memory alarm
Node Memory Alarm
rabbitmq_node_mem_limit

Limit of Memory usage
Node Memory LimitMemory,MB
rabbitmq_node_mem_used

Memory used by the rabbitmq node
Node Memory Utilizationmegabytes
rabbitmq_node_partitions

Number of network partitions this node is observing
Node Network Partitions
rabbitmq_node_proc_used

Number of Erlang processes used
Erlang Processes UsedProcs
rabbitmq_node_run_queue

Average number of Erlang processes waiting to run
Node Run Queue
rabbitmq_node_running

Is the node running or not
Node Running
rabbitmq_node_sockets_used

Number of sockets used
Node Sockets UsedSockets
rabbitmq_node_uptime

Uptime of the RabbitMQ server
UptimeMinutes
rabbitmq_objects_overview

Overview of all objects
Overview ObjectsObjects
rabbitmq_overview_messages_ack_count

Number of messages delivered to clients and acknowledged
Overview Messages Acknowledged
rabbitmq_overview_messages_ack_rate

Rate of messages delivered to clients and acknowledged per second
Overview Messages Acknowledged Rate
rabbitmq_overview_messages_deliver_get_count

Sum of messages delivered in acknowledgement mode to consumers, in no-acknowledgement mode to consumers, in acknowledgement mode in response to basic.get, and in no-acknowledgement mode in response to basic.get
Overview Messages Deliver
rabbitmq_overview_messages_deliver_get_rate

Rate per second of the sum of messages delivered in acknowledgement mode to consumers, in no-acknowledgement mode to consumers, in acknowledgement mode in response to basic.get, and in no-acknowledgement mode in response to basic.get
Overview Messages Deliver Rate
rabbitmq_overview_messages_publish_count

Count of messages published
Overview Messages Publish
rabbitmq_overview_messages_publish_rate

Rate of messages published per second
Overview Messages Publish Rate
rabbitmq_overview_messages_redeliver_count

Count of subset of messages in deliver_get which had the redelivered flag set
Overview Messages Redeliver
rabbitmq_overview_messages_redeliver_rate

Rate of subset of messages in deliver_get which had the redelivered flag set per second
Overview Messages Redeliver Rate
rabbitmq_overview_object_totals_channels

Total number of channels
Overview Objects Channels
rabbitmq_overview_object_totals_connections

Total number of connections
Overview Objects Connections
rabbitmq_overview_object_totals_consumers

Total number of consumers
Overview Objects Consumers
rabbitmq_overview_object_totals_queues

Total number of queues
Overview Objects Queues
rabbitmq_overview_queue_totals_messages_count

Total number of messages (ready plus unacknowledged)
Overview Queue Messages
rabbitmq_overview_queue_totals_messages_rate

Rate of number of messages (ready plus unacknowledged)
Overview Queue Messages Rate
rabbitmq_overview_queue_totals_messages_ready_count

Number of messages ready for delivery
Overview Queue Messages Ready
rabbitmq_overview_queue_totals_messages_ready_rate

Rate of number of messages ready for delivery
Overview Queue Messages Ready Rate
rabbitmq_overview_queue_totals_messages_unacknowledged_count

Number of unacknowledged messages
Overview Queue Messages Unaknowledged
rabbitmq_overview_queue_totals_messages_unacknowledged_rate

Rate of number of unacknowledged messages
Overview Queue Messages Unaknowledged Rate
rabbitmq_queue_consumer_utilisation

Ratio of time that a queue's consumers can take new messages (instance name will be displayed in the format 'name_vhost')
Queue Consumer Utilisation
rabbitmq_queue_consumers

Number of consumers. (instance name will be displayed in the format 'name_vhost')
ConsumersConsumers
rabbitmq_queue_consumers_active

Number of active consumers. An active consumer is one which could immediately receive any messages sent to the queue. (instance name will be displayed in the format 'name_vhost')
Active ConsumersConsumers
rabbitmq_queue_memory

Memory consumed by the Erlang process associated with the queue, including stack, heap and internal structures. (instance name will be displayed in the format 'name_vhost')
Memorymegabytes
rabbitmq_queue_messages

Sum of ready and unacknowledged messages (queue depth). (instance name will be displayed in the format 'name_vhost')
MessagesMessages
rabbitmq_queue_messages_ack_count

Number of messages in queues delivered to clients and acknowledged (instance name will be displayed in the format 'name_vhost')
Queue Messages Acknowledged
rabbitmq_queue_messages_ack_rate

Number per second of messages delivered to clients and acknowledged (instance name will be displayed in the format 'name_vhost')
Queue Messages Acknowledged Rate
rabbitmq_queue_messages_deliver_count

Count of messages delivered in acknowledgement mode to consumers (instance name will be displayed in the format 'name_vhost')
Queue Messages Deliver
rabbitmq_queue_messages_deliver_get_count

Sum of messages in queues delivered in acknowledgement mode to consumers, in no-acknowledgement mode to consumers, in acknowledgement mode in response to basic.get, and in no-acknowledgement mode in response to basic.get. (instance name will be displayed in the format 'name_vhost')
Queue Messages Deliver Get
rabbitmq_queue_messages_deliver_get_rate

Rate per second of the sum of messages in queues delivered in acknowledgement mode to consumers, in no-acknowledgement mode to consumers, in acknowledgement mode in response to basic.get, and in no-acknowledgement mode in response to basic.get. (instance name will be displayed in the format 'name_vhost')
Queue Messages Deliver Get Rate
rabbitmq_queue_messages_deliver_rate

Rate of messages delivered in acknowledgement mode to consumers (instance name will be displayed in the format 'name_vhost')
Queue Messages Deliver Rate
rabbitmq_queue_messages_publish_count

Count of messages in queues published (instance name will be displayed in the format 'name_vhost')
Queue Messages Publish
rabbitmq_queue_messages_publish_rate

Rate per second of messages published (instance name will be displayed in the format 'name_vhost')
Queue Messages Publish Rate
rabbitmq_queue_messages_rate

Count per second of the total messages in the queue (instance name will be displayed in the format 'name_vhost')
Queue Messages Rate
rabbitmq_queue_messages_ready

Number of messages ready to be delivered to clients. (instance name will be displayed in the format 'name_vhost')
Messages ReadyMessages Ready
rabbitmq_queue_messages_ready_rate

Rate of messages ready to be delivered to clients. (instance name will be displayed in the format 'name_vhost')
Messages Ready Rate
rabbitmq_queue_messages_redeliver_count

Count of subset of messages in queues in deliver_get which had the redelivered flag set (instance name will be displayed in the format 'name_vhost')
Queue Messages Redeliver
rabbitmq_queue_messages_redeliver_rate

Rate per second of subset of messages in deliver_get which had the redelivered flag set (instance name will be displayed in the format 'name_vhost')
Queue Messages Redeliver Rate
rabbitmq_queue_messages_unacknowledged

Number of messages delivered to clients but not yet acknowledged. (instance name will be displayed in the format 'name_vhost')
Messages UnacknowledgedMessages Unacknowledged
rabbitmq_queue_messages_unacknowledged_rate

Rate of messages delivered to clients but not yet acknowledged. (instance name will be displayed in the format 'name_vhost')
Messages Unacknowledged Rate