Supervisor and SQLite Integration

Input and output integration overview

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

Telegraf’s SQL output plugin stores metrics in an SQL database by creating tables dynamically for each metric type. When configured for SQLite, it utilizes a file-based DSN and a minimal SQL schema tailored for lightweight, embedded database usage.

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.

SQLite

The SQL output plugin writes Telegraf metrics to an SQL database using a dynamic schema where each metric type corresponds to a table. For SQLite, the plugin uses the modernc.org/sqlite driver and requires a DSN in the format of a file URI (e.g., ‘file:/path/to/telegraf.db?cache=shared’). This configuration leverages standard ANSI SQL for table creation and data insertion, ensuring compatibility with SQLite’s capabilities.

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

SQLite

[[outputs.sql]]
  ## Database driver
  ## Valid options: mssql (Microsoft SQL Server), mysql (MySQL), pgx (Postgres),
  ## sqlite (SQLite3), snowflake (snowflake.com), clickhouse (ClickHouse)
  driver = "sqlite"

  ## Data source name
  ## For SQLite, the DSN is a filename or URL with the scheme "file:".
  ## Example: "file:/path/to/telegraf.db?cache=shared"
  data_source_name = "file:/path/to/telegraf.db?cache=shared"

  ## Timestamp column name
  timestamp_column = "timestamp"

  ## Table creation template
  ## Available template variables:
  ##  {TABLE}        - table name as a quoted identifier
  ##  {TABLELITERAL} - table name as a quoted string literal
  ##  {COLUMNS}      - column definitions (list of quoted identifiers and types)
  table_template = "CREATE TABLE {TABLE} ({COLUMNS})"

  ## Table existence check template
  ## Available template variables:
  ##  {TABLE} - table name as a quoted identifier
  table_exists_template = "SELECT 1 FROM {TABLE} LIMIT 1"

  ## Initialization SQL (optional)
  init_sql = ""

  ## Maximum amount of time a connection may be idle. "0s" means connections are never closed due to idle time.
  connection_max_idle_time = "0s"

  ## Maximum amount of time a connection may be reused. "0s" means connections are never closed due to age.
  connection_max_lifetime = "0s"

  ## Maximum number of connections in the idle connection pool. 0 means unlimited.
  connection_max_idle = 2

  ## Maximum number of open connections to the database. 0 means unlimited.
  connection_max_open = 0

  ## Metric type to SQL type conversion
  ## The values on the left are the data types Telegraf has and the values on the right are the SQL types used when writing to SQLite.
  #[outputs.sql.convert]
  #  integer       = "INT"
  #  real          = "DOUBLE"
  #  text          = "TEXT"
  #  timestamp     = "TIMESTAMP"
  #  defaultvalue  = "TEXT"
  #  unsigned      = "UNSIGNED"
  #  bool          = "BOOL"

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.

SQLite

1. Local Monitoring Storage: Configure the plugin to write metrics to a local SQLite database file. This is ideal for lightweight deployments where setting up a full-scale database server is not required.
2. Embedded Applications: Use SQLite as the backend for applications embedded in edge devices, benefiting from its file-based architecture and minimal resource requirements.
3. Quick Setup for Testing: Leverage SQLite’s ease of use to quickly set up a testing environment for Telegraf metrics collection without the need for external database services.
4. Custom Schema Management: Adjust the table creation templates to predefine your schema if you require specific column types or indexes, ensuring compatibility with your application’s needs.

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.