StatsD

Supported OS Linux Windows Mac OS

Integration version1.12.0

Overview

This check monitors the availability and uptime of non-Datadog StatsD servers. It also tracks the number of metrics, by metric type, received by StatsD.

This check does NOT forward application metrics from StatsD servers to Datadog. It collects metrics about StatsD itself.

Setup

Installation

The StatsD check is included in the Datadog Agent package, so you don’t need to install anything else on any servers that run StatsD.

Configuration

Host

To configure this check for an Agent running on a host:

  1. Edit the statsd.d/conf.yaml in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample statsd.d/conf.yaml for all available configuration options:

    init_config:
    
    instances:
      - host: localhost
        port: 8126 # or wherever your statsd listens
    
  2. Restart the Agent to start sending StatsD metrics and service checks to Datadog.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

ParameterValue
<INTEGRATION_NAME>statsd
<INIT_CONFIG>blank or {}
<INSTANCE_CONFIG>{"host": "%%host%%", "port":"8126"}

Log collection

  1. Collecting logs is disabled by default in the Datadog Agent, you need to enable it in datadog.yaml:

    logs_enabled: true
    
  2. Add this configuration block to your statsd.d/conf.yaml file to start collecting your Supervisord Logs:

    logs:
      - type: file
        path: /path/to/my/directory/file.log
        source: statsd
    

    Change the path parameter value and configure it for your environment. See the sample statsd.d/conf.yaml for all available configuration options.

  3. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for statsd under the Checks section.

Data Collected

Metrics

statsd.counters.count
(gauge)
The number of counter metrics currently seen by StatsD
statsd.gauges.count
(gauge)
The number of gauge metrics currently seen by StatsD
statsd.timers.count
(gauge)
The number of timer metrics currently seen by StatsD

Events

The StatsD check does not include any events.

Service Checks

statsd.can_connect
Returns Critical if the Agent cannot send data to the StatsD endpoint, OK otherwise.
Statuses: ok, critical

statsd.is_up
Returns Critical if the Agent cannot connect to the StatsD url, OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles:

PREVIEWING: esther/docs-8632-slo-blog-links