docs/reference/metricbeat/metricbeat-module-rabbitmq.md
% This file is generated! See metricbeat/scripts/mage/docs_collector.go
:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.
::::{dropdown} Learn more {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of {{beats}} and {{agent}}.
::::
:::::
The RabbitMQ module uses HTTP API created by the management plugin to collect metrics.
The default metricsets are connection, node, queue, exchange and shovel.
If management.path_prefix is set in RabbitMQ configuration, management_path_prefix has to be set to the same value in this module configuration.
The rabbitmq module is fully tested with RabbitMQ 3.7.4 and it should be compatible with any version supporting the management plugin (which needs to be installed and enabled). Exchange metricset is also tested with 3.6.0, 3.6.5 and 3.7.14
The RabbitMQ module supports the standard configuration options that are described in Modules. Here is an example configuration:
metricbeat.modules:
- module: rabbitmq
metricsets: ["node", "queue", "connection", "exchange", "shovel"]
enabled: true
period: 10s
hosts: ["localhost:15672"]
# Management path prefix, if `management.path_prefix` is set in RabbitMQ
# configuration, it has to be set to the same value.
#management_path_prefix: ""
#username: guest
#password: guest
This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.
The following metricsets are available:
stack: beta