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 rabbitmq.com/.

Prerequisites

To collect and ingest RabbitMQ logs and metrics, you must install Ops Agent version 2.12.0 or higher.

This receiver 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 metrics from your RabbitMQ instances, and restart the agent.

Example configuration

The following command creates the configuration file to collect and ingest metrics for RabbitMQ and restarts the Ops Agent on Linux.

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

To connect to your RabbitMQ instance using a TCP connection with a username and password, specify the username and password in your metrics receiver. For example:

metrics:
  receivers:
    rabbitmq:
      type: rabbitmq
      password: pwd
      username: usr
      insecure: false
      insecure_skip_verify: false
      cert_file: /path/to/cert
      ca_file: /path/to/ca
  service:
    pipelines:
      rabbitmq:
        receivers:
          - rabbitmq

Configure logs collection

To ingest logs from RabbitMQ, you must create receivers for the logs 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
`type`		This value must be `rabbitmq`.
`include_paths`	`[/var/log/rabbitmq/rabbit*.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`.
`exclude_paths`	`[]`	A list of filesystem path patterns to exclude from the set matched by `include_paths`.
`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.
`wildcard_refresh_interval`	`60s`	The interval at which wildcard file paths in `include_paths` are refreshed. Given as a time duration, 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 of the rabbitmq logs are derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.

Field	Type	Description
`jsonPayload.process_id`	string	The process ID issuing the log.
`jsonPayload.message`	string	Log message.
`severity`	string (`LogSeverity`)	Log entry level (translated).
`timestamp`	string (`Timestamp`)	Time the entry was logged.

Configure metrics collection

To collect metrics from RabbitMQ, you must create a receiver for RabbitMQ metrics and then create a pipeline for the new receiver. To configure a receiver for your RabbitMQ metrics, specify the following fields:

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

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

You can view the metrics from this integration using a sample Cloud Monitoring dashboard. Complete the Installing sample dashboards procedures to import the RabbitMQ GCE Overview dashboard from the Sample library and view charts that display your RabbitMQ metrics.

Verify the configuration

You can use the Logs Explorer and Metrics Explorer to verify that you correctly configured the RabbitMQ receiver. It might take one or two minutes for the Ops Agent to begin collecting logs and metrics.

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

resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/rabbitmq")

To verify 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.delivered'
| align rate(1m)
| 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.