statsd/docs/cluster_proxy.md

Network daemon for the collection and aggregation of realtime application metrics

# StatsD Cluster Proxy

StatsD Cluster Proxy is a udp proxy that sits infront of multiple StatsD instances.

Create a proxyConfig.js file:

  `cp exampleProxyConfig.js proxyConfig.js`

Once you have modified your config file run:

  `node proxy.js proxyConfig.js`


It uses a consistent hashring to send the unique metric names to the same StatsD instances so that
the aggregation works properly.

It handles a simple health check that dynamically recalculates the hashring if a StatsD instance goes offline.

Config Options are documented in the [exampleProxyConfig.js][exampleProxyConfig.js]

## Notes

In your StatsD configuration make sure to have the following configuration set: `deleteIdleStats: true`

We plan to remove this restriction in the near future: [#pull/348][pull_348]

[exampleProxyConfig.js]: https://github.com/etsy/statsd/blob/master/exampleProxyConfig.js
[pull_348]: https://github.com/etsy/statsd/pull/348