Docs » Integrations Guide » Use the Smart Agent » Monitors » telegraf/statsd

telegraf/statsd 🔗

Monitor Type: telegraf/statsd (Source)

Accepts Endpoints: No

Multiple Instances Allowed: Yes

Overview 🔗

This monitor acts as a Telegraf StatsD listener for receiving telegrafstatsd metrics. This monitor is based on the Telegraf Statsd input plugin. More information about the Telegraf plugin can be found here.

Sample YAML configuration:

monitors:
 - type: telegraf/statsd
   protocol: udp
   serviceAddress: ":8125"
   parseDataDogTags: true
monitors:
 - type: telegraf/statsd
   protocol: udp
   serviceAddress: "127.0.0.1:0"
   parseDataDogTags: true
   metricSeparator: '.'

Configuration 🔗

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: telegraf/statsd
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
protocol no string Protocol to use with the listener: tcp, udp4, udp6, or udp. (default: udp)
serviceAddress no string The address and port to serve from (default: :8125)
maxTCPConnections no integer Maximum number of tcp connections allowed. (default: 250)
TCPKeepAlive no bool Indicates whether to keep the tcp connection alive. (default: false)
deleteGauges no bool Whether to clear the gauge cache every interval. Setting this to false means the cache will only be cleared when the monitor is restarted. (default: true)
deleteCounters no bool Whether to clear the counter cache every interval. Setting this to false means the cache will only be cleared when the monitor is restarted. (default: true)
deleteSets no bool Whether to clear the sets cache every interval. Setting this to false means the cache will only be cleared when the monitor is restarted. (default: true)
deleteTimings no bool Whether to clear the timings cache every interval. Setting this to false means the cache will only be cleared when the monitor is restarted. (default: true)
percentiles no list of integers The percentiles that are collected for timing and histogram stats.
allowedPendingMessages no integer Number of messages allowed to queue up between each collection interval. Packets will be dropped until the next collection interval if this buffer fills up. (default: 10000)
percentileLimit no integer The maximum number of histogram values to track each measurement when calculating percentiles. Increasing the limit will increase memory consumption but will also improve accuracy. (default: 1000)
metricSeparator no string The separator used to separate parts of a metric name (default: _)
templates no list of strings Templates that transform telegrafstatsd metrics into influx tags and measurements. Please refer to the Telegraf (documentation)[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/statsd#statsd-bucket---influxdb-line-protocol-templates] for more information on templates.
parseDataDogTags no bool Indicates whether to parse dogstatsd tags (default: false)

The agent does not do any built-in filtering of metrics coming out of this monitor.