RabbitMQ 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the RabbitMQ monitor type using the Smart Agent Receiver.

Use this monitor to keep track of an instance of RabbitMQ by using the RabbitMQ Python Plugin. This monitor uses the RabbitMQ Management HTTP API to poll for statistics on a RabbitMQ server, then reports them to the agent.

This integration is available for Kubernetes, Windows, and Linux.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Requirements 🔗

This monitor requires RabbitMQ 3.0 and higher.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Note

Provide a RabbitMQ monitor entry in your Collector or Smart Agent (deprecated) configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/rabbitmq:
    type: collectd/rabbitmq
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/rabbitmq receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/rabbitmq]

Smart Agent 🔗

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
  - type: collectd/rabbitmq
    ...  # Additional config

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings 🔗

The following table shows the configuration options for the RabbitMQ monitor:

Option	Required	Type	Description
`pythonBinary`	No	`string`	Path to the Python binary. If not set, a built-in runtime is used. This setting can include arguments to the binary.
`host`	Yes	`string`	Hostname or IP address of the RabbitMQ instance. For example, `127.0.0.1`.
`port`	Yes	`integer`	The port of the RabbitMQ instance. For example, `15672`.
`brokerName`	No	`string`	Name of the RabbitMQ instance. Can be a Go template using other configuration options. Used as the `plugin_instance` dimension. The default value is `{{.host}}-{{.port}}`.
`collectChannels`	No	`bool`	Whether to collect channels. The default value is`false`.
`collectConnections`	No	`bool`	Whether to collect connections. The default value is`false`.
`collectExchanges`	No	`bool`	Whether to collect exchanges. The default value is`false`.
`collectNodes`	No	`bool`	Whether to collect nodes. The default value is`false`.
`collectQueues`	No	`bool`	Whether to collect queues. The default value is`false`.
`httpTimeout`	No	`integer`	HTTP timeout for requests.
`verbosityLevel`	No	`string`	Verbosity level.
`username`	Yes	`string`	API username of the RabbitMQ instance.
`password`	Yes	`string`	API password of the RabbitMQ instance.
`useHTTPS`	No	`bool`	Whether to enable HTTPS. The default value is`false`.
`sslCACertFile`	No	`string`	Path to the SSL or TLS certificate of the root certificate authority implicitly trusted by this monitor.
`sslCertFile`	No	`string`	Path to this monitor’s own SSL or TLS certificate.
`sslKeyFile`	No	`string`	Path to this monitor’s private SSL or TLS key file.
`sslKeyPassphrase`	No	`string`	This monitor’s private SSL or TLS key file password, if any.
`sslVerify`	No	`bool`	Whether the monitor verifies the RabbitMQ Management plugin SSL or TLS certificate. The default value is`false`.

Note

You must enable each of the five collect* options to gather metrics pertaining to those facets of a RabbitMQ instance.

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics