Docs » Available host and application monitors » Configure application receivers for messaging » RabbitMQ

RabbitMQ πŸ”—

Description πŸ”—

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.

Note

This monitor is not available on Windows as collectd plugins are only supported in Linux and Kubernetes.

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:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration πŸ”—

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

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Splunk Distribution of OpenTelemetry Collector πŸ”—

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

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

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

Smart Agent πŸ”—

To activate this monitor in the Smart Agent (deprecated), 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 isfalse.

collectConnections

No

bool

Whether to collect connections. The default value isfalse.

collectExchanges

No

bool

Whether to collect exchanges. The default value isfalse.

collectNodes

No

bool

Whether to collect nodes. The default value isfalse.

collectQueues

No

bool

Whether to collect queues. The default value isfalse.

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 isfalse.

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 isfalse.

Note

You must activate 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:

Notes πŸ”—

  • Learn more about the available metric types in Observability Cloud.

  • Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.

  • To add additional metrics, see how to configure extraMetrics using the Collector.

Get help πŸ”—

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

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