StatsD and DuckDB Integration

Input and output integration overview

The StatsD input plugin captures metrics from a StatsD server by running a listener service in the background, allowing for comprehensive performance monitoring and metric aggregation.

This plugin enables Telegraf to write structured metrics into DuckDB using SQLite-compatible SQL connections, supporting lightweight local analytics and offline metric analysis.

Integration details

StatsD

The StatsD input plugin is designed to gather metrics from a StatsD server by running a backgrounded StatsD listener service while Telegraf is active. This plugin leverages the format of the StatsD messages as established by the original Etsy implementation, which allows for various types of metrics including gauges, counters, sets, timings, histograms, and distributions. The capabilities of the StatsD plugin extend to parsing tags and extending the standard protocol with features that accommodate InfluxDB’s tagging system. It can handle messages sent via different protocols (UDP or TCP), manage multiple metric metrics effectively, and offers advanced configurations for optimal metric handling such as percentiles calculation and data transformation templates. This flexibility empowers users to track application performance comprehensively, making it an essential tool for robust monitoring setups.

DuckDB

Use the Telegraf SQL plugin to write metrics into a local DuckDB database. DuckDB is an in-process OLAP database designed for efficient analytical queries on columnar data. Although it does not provide a traditional client-server interface, DuckDB can be accessed via SQLite-compatible drivers in embedded mode. This allows Telegraf to store time series metrics in DuckDB using SQL, enabling powerful analytics workflows using familiar SQL syntax, Jupyter notebooks, or integration with data science tools like Python and R. DuckDB’s columnar storage and vectorized execution make it ideal for compact and high-performance metric archives.

Configuration

StatsD

[[inputs.statsd]]
  ## Protocol, must be "tcp", "udp4", "udp6" or "udp" (default=udp)
  protocol = "udp"

  ## MaxTCPConnection - applicable when protocol is set to tcp (default=250)
  max_tcp_connections = 250

  ## Enable TCP keep alive probes (default=false)
  tcp_keep_alive = false

  ## Specifies the keep-alive period for an active network connection.
  ## Only applies to TCP sockets and will be ignored if tcp_keep_alive is false.
  ## Defaults to the OS configuration.
  # tcp_keep_alive_period = "2h"

  ## Address and port to host UDP listener on
  service_address = ":8125"

  ## The following configuration options control when telegraf clears it's cache
  ## of previous values. If set to false, then telegraf will only clear it's
  ## cache when the daemon is restarted.
  ## Reset gauges every interval (default=true)
  delete_gauges = true
  ## Reset counters every interval (default=true)
  delete_counters = true
  ## Reset sets every interval (default=true)
  delete_sets = true
  ## Reset timings & histograms every interval (default=true)
  delete_timings = true

  ## Enable aggregation temporality adds temporality=delta or temporality=commulative tag, and
  ## start_time field, which adds the start time of the metric accumulation.
  ## You should use this when using OpenTelemetry output.
  # enable_aggregation_temporality = false

  ## Percentiles to calculate for timing & histogram stats.
  percentiles = [50.0, 90.0, 99.0, 99.9, 99.95, 100.0]

  ## separator to use between elements of a statsd metric
  metric_separator = "_"

  ## Parses tags in the datadog statsd format
  ## http://docs.datadoghq.com/guides/dogstatsd/
  ## deprecated in 1.10; use datadog_extensions option instead
  parse_data_dog_tags = false

  ## Parses extensions to statsd in the datadog statsd format
  ## currently supports metrics and datadog tags.
  ## http://docs.datadoghq.com/guides/dogstatsd/
  datadog_extensions = false

  ## Parses distributions metric as specified in the datadog statsd format
  ## https://docs.datadoghq.com/developers/metrics/types/?tab=distribution#definition
  datadog_distributions = false

  ## Keep or drop the container id as tag. Included as optional field
  ## in DogStatsD protocol v1.2 if source is running in Kubernetes
  ## https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=metrics#dogstatsd-protocol-v12
  datadog_keep_container_tag = false

  ## Statsd data translation templates, more info can be read here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/TEMPLATE_PATTERN.md
  # templates = [
  #     "cpu.* measurement*"
  # ]

  ## Number of UDP messages allowed to queue up, once filled,
  ## the statsd server will start dropping packets
  allowed_pending_messages = 10000

  ## Number of worker threads used to parse the incoming messages.
  # number_workers_threads = 5

  ## Number of timing/histogram values to track per-measurement in the
  ## calculation of percentiles. Raising this limit increases the accuracy
  ## of percentiles but also increases the memory usage and cpu time.
  percentile_limit = 1000

  ## Maximum socket buffer size in bytes, once the buffer fills up, metrics
  ## will start dropping.  Defaults to the OS default.
  # read_buffer_size = 65535

  ## Max duration (TTL) for each metric to stay cached/reported without being updated.
  # max_ttl = "10h"

  ## Sanitize name method
  ## By default, telegraf will pass names directly as they are received.
  ## However, upstream statsd now does sanitization of names which can be
  ## enabled by using the "upstream" method option. This option will a) replace
  ## white space with '_', replace '/' with '-', and remove characters not
  ## matching 'a-zA-Z_\-0-9\.;='.
  #sanitize_name_method = ""

  ## Replace dots (.) with underscore (_) and dashes (-) with
  ## double underscore (__) in metric names.
  # convert_names = false

  ## Convert all numeric counters to float
  ## Enabling this would ensure that both counters and guages are both emitted
  ## as floats.
  # float_counters = false

DuckDB

[[outputs.sql]]
  ## Use the SQLite driver to connect to DuckDB via Go's database/sql
  driver = "sqlite3"

  ## DSN should point to the DuckDB database file
  dsn = "file:/var/lib/telegraf/metrics.duckdb"

  ## SQL INSERT statement with placeholders for metrics
  table_template = "INSERT INTO metrics (timestamp, name, value, tags) VALUES (?, ?, ?, ?)"

  ## Optional: manage connection pooling
  # max_open_connections = 1
  # max_idle_connections = 1
  # conn_max_lifetime = "0s"

  ## DuckDB does not require TLS or authentication by default

Input and output integration examples

StatsD

1. Real-time Application Performance Monitoring: Utilize the StatsD input plugin to monitor application performance metrics in real-time. By configuring your application to send various metrics to a StatsD server, teams can leverage this plugin to analyze performance bottlenecks, track user activity, and ensure resource optimization dynamically. The combination of historical and real-time metrics allows for proactive troubleshooting and enhances the responsiveness of issue resolution processes.

2. Tracking User Engagement Metrics in Web Applications: Use the StatsD plugin to gather user engagement statistics, such as page views, click events, and interaction times. By sending these metrics to the StatsD server, businesses can derive valuable insights into user behavior, enabling them to make data-driven decisions to improve user experience and interface design based on quantitative feedback. This can significantly enhance the effectiveness of marketing strategies and product development efforts.

3. Infrastructure Health Monitoring: Deploy the StatsD plugin to monitor the health of your server infrastructure by tracking metrics such as resource utilization, server response times, and network performance. With this setup, DevOps teams can gain detailed visibility into system performance, effectively anticipating issues before they escalate. This enables a proactive approach to infrastructure management, minimizing downtimes and ensuring optimal service delivery.

4. Creating Comprehensive Service Dashboards: Integrate StatsD with visualization tools to create comprehensive dashboards that reflect the status and health of services across an architecture. For instance, combining data from multiple services logged through StatsD can transform raw metrics into actionable insights, showcasing system performance trends over time. This capability empowers stakeholders to maintain oversight and drive decisions based on visualized data sets, enhancing overall operational transparency.

DuckDB

1. Embedded Metric Warehousing for Notebooks: Write metrics to a local DuckDB file from Telegraf and analyze them in Jupyter notebooks using Python or R. This workflow supports reproducible analytics, ideal for data science experiments or offline troubleshooting.

2. Batch Time-Series Processing on the Edge: Use Telegraf with DuckDB on edge devices to log metrics locally in SQL format. The compact storage and fast analytical capabilities of DuckDB make it ideal for batch processing and low-bandwidth environments.

3. Exploratory Querying of Historical Metrics: Accumulate system metrics over time in DuckDB and perform exploratory data analysis (EDA) using SQL joins, window functions, and aggregates. This enables insights that go beyond what typical time-series dashboards provide.

4. Self-Contained Metric Snapshots: Use DuckDB as a portable metrics archive by shipping .duckdb files between systems. Telegraf can collect and store data in this format, and analysts can later load and query it using the DuckDB CLI or integrations with tools like Tableau and Apache Arrow.

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.