RabbitMQ metrics

The OpenTelemetry Collector, when configured with a Prometheus receiver, provides an integration with RabbitMQ to ingest metrics. The Collector fetches metrics from the configured path in the RabbitMQ configuration file and sends it to the Prometheus exporter. From there the metrics are received and processed by the Prometheus receiver and exported to Cloud Observability.

To complete the integration, you will:

  • Configure RabbitMQ to use the Prometheus exporter.
  • Configure the Collector to use the RabbitMQ endpoint as a scrape target for the Prometheus receiver.
  • Enable the integration by adding it to a pipeline

Prerequisites

  • RabbitMQ v3.8 or later
  • You’ve configured the Collector to export metric data to Cloud Observability.

Configure RabbitMQ reporting

You need to configure RabbitMQ to use the Prometheus exporter.

In the RabbitMQ configuration file, add the Prometheus port.

1

prometheus.tcp.port = 15692

For more details about using RabbitMQ with the Prometheus exporter, see the official RabbitMQ documentation.

Configure the Collector receiver

In the Collector configuration file, configure the Prometheus receiver to use the RabbitMQ endpoint as a scrape target.

The targets attribute must be the same as the Prometheus port configured in the previous section.

1
2
3
4
5
6
7
8
9
10
11

receivers:
  prometheus/rabbitmq:
  	scrape_configs:
    	- job_name: 'rabbitmq-scraper'
      	metrics_path: "/metrics/per-object"
      	static_configs:
        	- targets: [":15692"]

  pipelines:
	metrics:
  	receivers: [prometheus/rabbitmq]

The OpenTelemetry repo’s readme provides additional details about Prometheus receiver configuration.

Enable the Collector receiver

Once the RabbitMQ receiver is configured, enable it by adding it to one or more pipelines as described in the Collector configuration documentation.

Validate metrics are reporting to Cloud Observability

You can validate that metrics are reporting to Cloud Observability on the Metrics details page in Settings.

  1. In Cloud Observability, click Settings > Metric details.

  2. Search for RabbitMQ metric names. Search for metric

    See the receiver’s metadata file for a complete list of emitted metrics.

  3. If needed, click on the metric to edit the description and how the units are displayed in Cloud Observability.

Create a dashboard for the metrics

Use the Cloud Observability Terraform Provider to create a dashboard for the metrics.

Additional resources

For a more complete example that’s ready to run, see the RabbitMQ integration in Cloud Observability OpenTelemetry Examples.

See also

Create and manage dashboards

Create alerts

Updated Dec 1, 2022