RabbitMQ Metrics

Collect and ship RabbitMQ service metrics to Logstash and Elasticsearch.

Metricbeat is a lightweight shipper that helps you monitor RabbitMQ server by collecting metrics running on the Redis server. Configure Metricbeat using the pre-defined examples below to collect and ship RabbitMQ service metrics and statistics to Logstash or Elasticsearch.

Step 1 - Install Metricbeat

To get started first follow the steps below:

Install
Root access
Verify the required port is open

Older versions can be found here 7, 6, 5

Step 3 - Copy configuration file

The configuration file below is pre-configured to send data to your Logit.io Stack via Logstash.

Copy the configuration file below and overwrite the contents of metricbeat.yml.

###################### Logit.io Metricbeat Configuration #######################
# =========================== Modules configuration ============================

metricbeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s
# ======================= Elasticsearch template setting =======================
setup.template.settings:
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false

# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
<div class="sw-warning">
    <div>
        <img src="/images/source-wizard/warning-triangle.svg">
    </div>
    <div>
       <b>No input available! </b> Your stack is missing the required input for this data source <a href="#" onclick="Intercom('showNewMessage')" class="btn btn-info btn-sm">Talk to support to add the input</a>
    </div>
</div>

Step 3 - Enable module

There are several built in metricbeat modules you can use. To enable the RabbitMQ module, run the following:

deb/rpm

metricbeat modules list
metricbeat modules enable rabbitmq

macOS

./metricbeat modules list
./metricbeat modules enable rabbitmq

Windows

PS > .\metricbeat.exe modules enable rabbitmq

Step 4 - Configure module

Each module has its own configuration file where different metricsets can be enabled / disabled. Locate the configuration file for the rabbitmq module.

deb/rpm /etc/metricbeat/modules.d/rabbitmq.yml

mac/win ~/<EXTRACTED_ARCHIVE>/modules.d/rabbitmq.yml

By default the following metrics are disabled. To enable or disable a metric simply comment or uncomment the line out.

- module: rabbitmq
  #metricsets:
  #  - node
  #  - queue
  #  - connection
  period: 10s
  hosts: ["localhost:15672"]
  #username: guest
  #password: guest

Step 5 - Start Metricbeat

Start or restart to apply the configuration changes.

Step 6 - how to diagnose no data in Stack

If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.

Step 7 - Compatibility

The rabbitmq module is tested with RabbitMQ 3.7.4, and it should be compatible with any version supporting the management plugin. This plugin needs to be enabled.

Expand View