Metadata-Version: 2.0
Name: datadog-statsd
Version: 1.1.0
Summary: The StatsD check
Home-page: https://github.com/DataDog/integrations-core
Author: Datadog
Author-email: packages@datadoghq.com
License: BSD
Keywords: datadog agent statsd check
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: datadog-checks-base

# Agent Check: StatsD

## 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][1] package, so you don't need to install anything else on any servers that run StatsD.

### Configuration

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

    ```yaml
        init_config:

        instances:
            - host: localhost
            port: 8126 # or wherever your statsd listens
    ```

    Configuration Options

    - `host` (Optional) - Host to be checked. This will be included as a tag: `host:<host>`. Defaults to `localhost`.
    - `port` (Optional) - Port to be checked. This will be included as a tag: `port:<port>`. Defaults to `8126`.
    - `timeout` (Optional) - Timeout for the check. Defaults to 10 seconds.
    - `tags` (Optional) - Tags to be assigned to the metric.

2. [Restart the Agent][3] to start sending StatsD metrics and service checks to Datadog.

### Validation

[Run the Agent's `status` subcommand][4] and look for `statsd` under the Checks section.

## Data Collected
### Metrics
See [metadata.csv][5] for a list of metrics provided by this integration.

### Events
The StatsD check does not include any events at this time.

### Service Checks

**statsd.is_up**:

Returns CRITICAL if the StatsD server does not respond to the Agent's health status request, otherwise OK.

**statsd.can_connect**:

Returns CRITICAL if the Agent cannot collect metrics about StatsD, otherwise OK.

## Troubleshooting
Need help? Contact [Datadog Support][6].

## Further Reading
If you don't know what StatsD is and how does it work, check out [our blog post about it][7]

To get a better idea of how (or why) to visualize StatsD metrics with Counts Graphing with Datadog, check out our [series of blog posts][8] about it.


[1]: https://app.datadoghq.com/account/settings#agent
[2]: https://github.com/DataDog/integrations-core/blob/master/statsd/conf.yaml.example
[3]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[5]: https://github.com/DataDog/integrations-core/blob/master/statsd/metadata.csv
[6]: http://docs.datadoghq.com/help/
[7]: https://www.datadoghq.com/blog/statsd/
[8]: https://www.datadoghq.com/blog/visualize-statsd-metrics-counts-graphing/


