RabbitMQ

Use this Splunk Observability Cloud integration for the RabbitMQ monitor. See benefits, install, configuration, and metrics

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the rabbitmq monitor type to keep track of an instance of RabbitMQ.

Note: To monitor RabbitMQ instances with the OpenTelemetry Collector using native OpenTelemetry refer to the RabbitMQ receiver component.

The integration uses the RabbitMQ Python plugin and the RabbitMQ Management HTTP API to poll for statistics on a RabbitMQ server, then reports them to the agent.

This integration is available on Kubernetes and Linux, and requires RabbitMQ 3.0 and higher.

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 Splunk 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 Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata Catalog.

Installation

Follow these steps to deploy this integration:

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

Configuration

To use this integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
- See how to Use Smart Agent monitors with the Collector.
- See how to set up the Smart Agent receiver.
- For a list of common configuration options, refer to Common configuration settings for monitors.
- Learn more about the Collector at Get started: Understand and use the Collector.

Example

To activate this integration, add the following to your Collector configuration:

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

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

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

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 activate 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 activate each of the 5 collect* options to gather metrics pertaining to those facets of a RabbitMQ instance.

Metrics

The following metrics are available for this integration:

https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/collectd/rabbitmq/metadata.yaml

Notes

To learn more about the available in Splunk Observability Cloud see Metric types.
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics.

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal.
Contact Splunk Support.

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups.

Documentation