Supervisor and OpenTSDB Integration

Input and output integration overview

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

The OpenTSDB plugin facilitates the integration of Telegraf with OpenTSDB, allowing users to push time-series metrics to an OpenTSDB backend seamlessly.

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.

OpenTSDB

The OpenTSDB plugin is designed to send metrics to an OpenTSDB instance using either the telnet or HTTP mode. With the introduction of OpenTSDB 2.0, the recommended method for sending metrics is via the HTTP API, which allows for batch processing of metrics by configuring the ‘http_batch_size’. The plugin supports several configuration options including metrics prefixing, server host and port specification, URI path customization for reverse proxies, and debug options for diagnosing communication issues with OpenTSDB. This plugin is particularly useful in scenarios where time series data is generated and needs to be efficiently stored in a scalable time series database like OpenTSDB, making it suitable for a wide range of monitoring and analytics applications.

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"]

OpenTSDB

[[outputs.opentsdb]]
  ## prefix for metrics keys
  prefix = "my.specific.prefix."

  ## DNS name of the OpenTSDB server
  ## Using "opentsdb.example.com" or "tcp://opentsdb.example.com" will use the
  ## telnet API. "http://opentsdb.example.com" will use the Http API.
  host = "opentsdb.example.com"

  ## Port of the OpenTSDB server
  port = 4242

  ## Number of data points to send to OpenTSDB in Http requests.
  ## Not used with telnet API.
  http_batch_size = 50

  ## URI Path for Http requests to OpenTSDB.
  ## Used in cases where OpenTSDB is located behind a reverse proxy.
  http_path = "/api/put"

  ## Debug true - Prints OpenTSDB communication
  debug = false

  ## Separator separates measurement name from field
  separator = "_"

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.

OpenTSDB

1. Real-time Infrastructure Monitoring: Utilize the OpenTSDB plugin to collect and store metrics from various infrastructure components. By configuring the plugin to push metrics to OpenTSDB, organizations can have a centralized view of their infrastructure health and performance over time.

2. Custom Application Metrics Tracking: Integrate the OpenTSDB plugin into custom applications to track key performance indicators (KPIs) such as response times, error rates, and user interactions. This setup allows developers and product teams to visualize application performance trends and make data-driven decisions.

3. Automated Anomaly Detection: Leverage the plugin in conjunction with machine learning algorithms to automatically detect anomalies in time-series data sent to OpenTSDB. By continuously monitoring the incoming metrics, the system can train models that alert users to potential issues before they affect application performance.

4. Historical Data Analysis: Use the OpenTSDB plugin to store and analyze historical performance data for capacity planning and trend analysis. This provides valuable insights into system behavior over time, helping teams to understand usage patterns and prepare for future growth.

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.