RabbitMQ and Grafana Integration

Input and output integration overview

This plugin reads metrics from RabbitMQ servers, providing essential insights into the performance and state of the messaging system.

This plugin enables Telegraf to stream metrics directly to Grafana dashboards in real-time, leveraging Grafana Live for instantaneous data visualization and operational insights.

Integration details

RabbitMQ

The RabbitMQ plugin for Telegraf allows users to gather metrics from RabbitMQ servers via the RabbitMQ Management Plugin. This capability is crucial for monitoring the performance and health of RabbitMQ instances, which are widely utilized for message queuing and processing in various applications. The plugin provides comprehensive insights into key RabbitMQ metrics, including message rates, queue depths, and node health statistics, thereby enabling operators to maintain optimal performance and robustness of their messaging infrastructure. Additionally, it supports secret-stores for managing sensitive credentials securely, making integration with existing systems smoother. Configuration options allow for flexibility in specifying the nodes, queues, and exchanges to monitor, providing valuable adaptability for diverse deployment scenarios.

Grafana

Telegraf can be used to send real-time data to Grafana using the Websocket output plugin. Metrics collected by Telegraf are instantly pushed to Grafana dashboards, enabling real-time visualization and analysis. This plugin is ideal for use cases where low latency, live data visualization is essential, such as operational monitoring, real-time analytics, and immediate incident response scenarios. It supports authentication headers, customizable data serialization formats (like JSON), and secure communication via TLS, offering flexibility and ease of integration in dynamic, interactive dashboard environments.

Configuration

RabbitMQ

[[inputs.rabbitmq]]
  ## Management Plugin url. (default: http://localhost:15672)
  # url = "http://localhost:15672"
  ## Tag added to rabbitmq_overview series; deprecated: use tags
  # name = "rmq-server-1"
  ## Credentials
  # username = "guest"
  # password = "guest"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Optional request timeouts
  ## ResponseHeaderTimeout, if non-zero, specifies the amount of time to wait
  ## for a server's response headers after fully writing the request.
  # header_timeout = "3s"
  ##
  ## client_timeout specifies a time limit for requests made by this client.
  ## Includes connection time, any redirects, and reading the response body.
  # client_timeout = "4s"

  ## A list of nodes to gather as the rabbitmq_node measurement. If not
  ## specified, metrics for all nodes are gathered.
  # nodes = ["rabbit@node1", "rabbit@node2"]

  ## A list of queues to gather as the rabbitmq_queue measurement. If not
  ## specified, metrics for all queues are gathered.
  ## Deprecated in 1.6: Use queue_name_include instead.
  # queues = ["telegraf"]

  ## A list of exchanges to gather as the rabbitmq_exchange measurement. If not
  ## specified, metrics for all exchanges are gathered.
  # exchanges = ["telegraf"]

  ## Metrics to include and exclude. Globs accepted.
  ## Note that an empty array for both will include all metrics
  ## Currently the following metrics are supported: "exchange", "federation", "node", "overview", "queue"
  # metric_include = []
  # metric_exclude = []

  ## Queues to include and exclude. Globs accepted.
  ## Note that an empty array for both will include all queues
  # queue_name_include = []
  # queue_name_exclude = []

  ## Federation upstreams to include and exclude specified as an array of glob
  ## pattern strings.  Federation links can also be limited by the queue and
  ## exchange filters.
  # federation_upstream_include = []
  # federation_upstream_exclude = []

Grafana

[[outputs.websocket]]
  ## Grafana Live WebSocket endpoint
  url = "ws://localhost:3000/api/live/push/custom_id"

  ## Optional headers for authentication
  # [outputs.websocket.headers]
  #   Authorization = "Bearer YOUR_GRAFANA_API_TOKEN"

  ## Data format to send metrics
  data_format = "influx"

  ## Timeouts (make sure read_timeout is larger than server ping interval or set to zero).
  # connect_timeout = "30s"
  # write_timeout = "30s"
  # read_timeout = "30s"

  ## Optionally turn on using text data frames (binary by default).
  # use_text_frames = false

  ## TLS configuration
  # tls_ca = "/path/to/ca.pem"
  # tls_cert = "/path/to/cert.pem"
  # tls_key = "/path/to/key.pem"
  # insecure_skip_verify = false

Input and output integration examples

RabbitMQ

1. Monitoring Queue Performance Metrics: Use the RabbitMQ plugin to keep track of queue performance over time. This involves setting up monitoring dashboards that visualize crucial queue metrics such as message rates, the number of consumers, and message delivery rates. With this information, teams can proactively address any bottlenecks or performance issues by analyzing trends and making data-informed decisions about scaling or optimizing their RabbitMQ configuration.

2. Alerting on System Health: Integrate the RabbitMQ plugin with an alerting system to notify operational teams of potential issues within RabbitMQ instances. For example, if the number of unacknowledged messages reaches a critical threshold or if queues become overwhelmed, alerts can trigger, allowing for immediate investigation and swift remedial action to maintain the health of message flows.

3. Analyzing Message Processing Metrics: Employ the plugin to gather detailed metrics on message processing performance, such as the rates of messages published, acknowledged, and redelivered. By analyzing these metrics, teams can evaluate the efficiency of their message consumer applications and make adjustments to configuration or code where necessary, thereby enhancing overall system throughput and resilience.

4. Cross-System Data Integration: Leverage the metrics collected by the RabbitMQ plugin to integrate data flows between RabbitMQ and other systems or services. For example, use the gathered metrics to drive automated workflows or analytics pipelines that utilize messages processed in RabbitMQ, enabling organizations to optimize workflows and enhance data agility across their ecosystems.

Grafana

1. Real-Time Infrastructure Dashboards: Deploy Telegraf to stream server health metrics directly to Grafana dashboards, enabling IT teams to visualize infrastructure performance in real-time. This setup allows immediate detection and response to critical system events.

2. Interactive IoT Monitoring: Integrate IoT device metrics collected by Telegraf and push live data into Grafana, creating dynamic and interactive dashboards for monitoring smart city projects or manufacturing processes. This real-time visibility significantly enhances responsiveness and operational efficiency.

3. Instantaneous Application Performance Analysis: Stream application metrics in real-time from production environments into Grafana dashboards, enabling development teams to rapidly detect and diagnose performance bottlenecks or anomalies during deployments, minimizing downtime and improving reliability.

4. Live Event Analytics: Utilize Telegraf to capture and stream real-time audience or system metrics during major live events directly into Grafana dashboards. Event organizers can dynamically monitor and react to changing conditions or trends, significantly enhancing audience engagement and operational decision-making.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.