Supervisor and Zabbix Integration

Input and output integration overview

This plugin gathers information about processes running under Supervisor using the XML-RPC API.

This plugin sends metrics to Zabbix via traps, allowing for efficient monitoring of systems and applications. It supports automated configuration and data sending based on dynamic metrics collected by Telegraf.

Integration details

Supervisor

The Supervisor plugin for Telegraf is designed to collect metrics about processes managed by the Supervisor process control system using its XML-RPC API. The plugin is able to track various metrics, including process states and uptime, and provides options for configuring which metrics to collect through include or exclude lists. This integration is particularly useful for monitoring applications running under Supervisor, providing insights into their operational status and performance metrics. A minimum tested Supervisor version is 3.3.2, and it is recommended to secure the HTTP server with basic authentication for better security.

Zabbix

The Telegraf Zabbix plugin is designed to send metrics to Zabbix, an open-source monitoring solution, using the trap protocol. It supports various versions from 3.0 to 6.0, ensuring compatibility with recent updates. The plugin facilitates easy integration with the Zabbix ecosystem, allowing users to send collected metrics and monitor system performance seamlessly. Key functionalities include the ability to define the address and port of the Zabbix server, options for prefixing keys, determining the type of data sent (active vs. trapper), and features for low-level discovery (LLD) enabling dynamic item creation based on the metrics observed. Configuration options also allow for autoregistration and resending intervals for LLD data, ensuring that the metrics are up-to-date and relevant. Additionally, the trap format used for sending metrics is structured to facilitate efficient data transfer and processing in Zabbix.

Configuration

Supervisor

[[inputs.supervisor]]
  ## Url of supervisor's XML-RPC endpoint if basic auth enabled in supervisor http server,
  ## than you have to add credentials to url (ex. http://login:pass@localhost:9001/RPC2)
  # url="http://localhost:9001/RPC2"
  ## With settings below you can manage gathering additional information about processes
  ## If both of them empty, then all additional information will be collected.
  ## Currently supported supported additional metrics are: pid, rc
  # metrics_include = []
  # metrics_exclude = ["pid", "rc"]

Zabbix

[[outputs.zabbix]]
  ## Address and (optional) port of the Zabbix server
  address = "zabbix.example.com:10051"

  ## Send metrics as type "Zabbix agent (active)"
  # agent_active = false

  ## Add prefix to all keys sent to Zabbix.
  # key_prefix = "telegraf."

  ## Name of the tag that contains the host name. Used to set the host in Zabbix.
  ## If the tag is not found, use the hostname of the system running Telegraf.
  # host_tag = "host"

  ## Skip measurement prefix to all keys sent to Zabbix.
  # skip_measurement_prefix = false

  ## This field will be sent as HostMetadata to Zabbix Server to autoregister the host.
  ## To enable this feature, this option must be set to a value other than "".
  # autoregister = ""

  ## Interval to resend auto-registration data to Zabbix.
  ## Only applies if autoregister feature is enabled.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # autoregister_resend_interval = "30m"

  ## Interval to send LLD data to Zabbix.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # lld_send_interval = "10m"

  ## Interval to delete stored LLD known data and start capturing it again.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # lld_clear_interval = "1h"

Input and output integration examples

Supervisor

1. Centralized Monitoring Dashboard: Implement this plugin to feed Supervisor metrics directly into a centralized monitoring dashboard, allowing teams to visualize the health and performance of their applications in real-time. This integration enables quick identification of issues, helps track service performance over time, and aids in capacity planning based on observed trends.

2. Alerting for Process Failures: Utilize the metrics gathered by the Supervisor plugin to create an alerting mechanism that notifies engineers when critical processes go down or enter a fatal state. By setting thresholds in your monitoring system, teams can respond proactively to potential problems, minimizing downtime and ensuring system reliability.

3. Historical Analysis of Process States: Store the metrics collected over time to analyze process state changes and patterns. By examining historical data, teams can identify recurring issues, track the impact of deployment changes, and optimize resource allocation based on process trends, leading to improved overall system performance.

4. Integration with Incident Management Systems: Configure the Supervisor plugin to automatically send alerts to incident management systems like PagerDuty or OpsGenie when a process reaches a critical state. This integration streamlines the incident response process, ensuring that the right team members are notified promptly and can take action without delay.

Zabbix

1. Dynamic Monitoring of Containerized Applications: Integration of the Zabbix plugin can be leveraged to monitor Docker containers dynamically. As containers are created and removed, the plugin can automatically update Zabbix with the appropriate metrics, ensuring that monitoring stays current without manual configuration. This enhances visibility into resource usage and performance metrics for microservices orchestrated with Kubernetes or Docker Swarm.

2. Real-Time Performance Monitoring with Auto-registration: By enabling the autoregister feature, the plugin can automatically register hosts in Zabbix based on the metrics received. This scenario provides a streamlined approach to add new hosts to monitoring without manual setup, which is particularly useful in environments where hosts may frequently spin up and down, such as serverless architectures or cloud-based deployments.

3. Leveraging Low-level Discovery for Flexible Metric Capture: Using low-level discovery, this plugin allows Zabbix to adaptively create items for metrics that are not predefined. In a scenario involving multiple network devices reporting different performance metrics, the plugin can dynamically inform Zabbix about new metrics as they appear, thus ensuring comprehensive monitoring capabilities that evolve with the monitored systems.

4. Centralized Monitoring of Distributed Systems: The Zabbix plugin can be utilized in a centralized monitoring setup for distributed systems where multiple Telegraf instances are running across different geographical locations. By sending all metrics to a central Zabbix server, organizations can achieve a holistic view of their infrastructure’s performance and make informed operational decisions.

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.