RabbitMQ

The RabbitMQ integration collects message metrics, such as the number of delivered, published, and dropped messages. The integration also collects RabbitMQ logs and parses them into a JSON payload. The result includes process ID, level, and message.

For more information about RabbitMQ, see the RabbitMQ documentation.

Prerequisites

To collect RabbitMQ telemetry, you must install the Ops Agent:

For metrics, install version 2.11.0 or higher.
For logs, install version 2.12.0 or higher.

This integration supports RabbitMQ versions 3.8 and 3.9.

You must enable the RabbitMQ management plugin by following the Getting started instructions.

You must configure a user with the monitoring tag.

Configure the Ops Agent for RabbitMQ

Following the guide for Configuring the Ops Agent, add the required elements to collect telemetry from RabbitMQ instances, and restart the agent.

Example configuration

The following commands create the configuration to collect and ingest telemetry for RabbitMQ and restarts the Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    rabbitmq:
      type: rabbitmq
      username: usr
      password: pwd
  service:
    pipelines:
      rabbitmq:
        receivers:
        - rabbitmq
logging:
  receivers:
    rabbitmq:
      type: rabbitmq
  service:
    pipelines:
      rabbitmq:
        receivers:
        - rabbitmq
EOF

sudo service google-cloud-ops-agent restart
sleep 30

Configure logs collection

To ingest logs from RabbitMQ, you must create receivers for the logs that RabbitMQ produces and then create a pipeline for the new receivers.

To configure a receiver for your rabbitmq logs, specify the following fields:

Field	Default	Description
`exclude_paths`		A list of filesystem path patterns to exclude from the set matched by `include_paths`.
`include_paths`	`[var/log/rabbitmq/*.log]`	A list of filesystem paths to read by tailing each file. A wild card (``) can be used in the paths; for example, `/var/log/rabbitmq/.log`.
`record_log_file_path`	`false`	If set to `true`, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the `agent.googleapis.com/log_file_path` label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
`type`		This value must be `rabbitmq`.
`wildcard_refresh_interval`	`60s`	The interval at which wildcard file paths in include_paths are refreshed. Given as a time duration parsable by `time.ParseDuration`, for example `30s` or `2m`. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

What is logged

The logName is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.

The rabbitmq logs contain the following fields in the LogEntry:

Field	Type	Description
`jsonPayload.message`	string	Log message, including detailed stacktrace where provided
`jsonPayload.process_id`	string	The process ID issuing the log
`severity`	string (`LogSeverity`)	Log entry level (translated).

Configure metrics collection

To ingest metrics from RabbitMQ, you must create receivers for the metrics that RabbitMQ produces and then create a pipeline for the new receivers.

To configure a receiver for your rabbitmq metrics, specify the following fields:

Field	Default	Description
`ca_file`		Path to the CA certificate. As a client, this verifies the server certificate. If empty, the receiver uses the system root CA.
`cert_file`		Path to the TLS certificate to use for mTLS-required connections.
`collection_interval`	`60s`	A time duration value, such as `30s` or `5m`.
`endpoint`	`http://localhost:15672`	The URL of the node to monitor.
`insecure`	`true`	Sets whether or not to use a secure TLS connection. If set to `false`, then TLS is enabled.
`insecure_skip_verify`	`false`	Sets whether or not to skip verifying the certificate. If `insecure` is set to `true`, then the `insecure_skip_verify` value is not used.
`key_file`		Path to the TLS key to use for mTLS-required connections.
`password`		The password used to connect to the server.
`type`		This value must be `rabbbitmq`.
`username`		The username used to connect to the server.

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the RabbitMQ instance.

Metric type
Kind, Type Monitored resources	Labels
`workload.googleapis.com/rabbitmq.consumer.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/rabbitmq.message.current`
`GAUGE`, `INT64` gce_instance	`state`

Sample dashboard

To view your RabbitMQ metrics, you must have a chart or dashboard configured. Cloud Monitoring provides a library of sample dashboards for integrations, which contain preconfigured charts. For information about installing these dashboards, see Installing sample dashboards.

Verify the configuration

This section describes how to verify that you correctly configured the RabbitMQ receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that the logs are ingested, go to the Logs Explorer and run the following query to view the RabbitMQ logs:

resource.type="gce_instance"
log_id("rabbitmq")

To verify that the metrics are ingested, go to Metrics Explorer and run the following query in the MQL tab:

fetch gce_instance
| metric 'workload.googleapis.com/rabbitmq.message.current'
| every 1m

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.