Daemon for easy but powerful stats aggregation
Clone or download
benburry Fix for failing test on node 0.10
After merging #593, tests against node 0.10 started failing with

  ctor.prototype = Object.create(superCtor.prototype, {
TypeError: Object prototype may only be an Object or null
Latest commit 8d5363c Nov 22, 2016
Failed to load latest commit information.
backends pickling support. Jul 10, 2015
bin add bin/statsd Jun 28, 2012
debian Updates changelogs. closes #568 May 11, 2016
docs Add plugin Warp10 to statsd Jul 4, 2016
examples partable bash shebang Sep 25, 2015
lib Fix for failing test on node 0.10 Nov 21, 2016
packager Force statsd restart when updating package Nov 11, 2015
servers Fix node 0.10 error. May 5, 2016
test Merge pull request #564 from Nihn/allow-to-use-unix-domain-so May 5, 2016
utils Nagios and Keepalived check script Mar 18, 2016
.gitignore Added IDEA project files to .gitignore Sep 22, 2014
.pkgr.yml Remove all default dependencies in generated package Nov 11, 2015
.travis.yml Adding node 5.x to travis builds May 4, 2016
CONTRIBUTING.md move contributing information into CONTRIBUTING.md Jan 29, 2014
Changelog.md Updates changelogs. closes #568 May 11, 2016
Dockerfile Pin Node version to 5.x on Docker image. May 5, 2016
LICENSE Updated copyright to 2016 Jan 1, 2016
README.md Minor font style improvements Oct 23, 2015
docker-compose.yml Initial Docker Compose manifest. Apr 29, 2016
exampleConfig.js Merge pull request #564 from Nihn/allow-to-use-unix-domain-so May 5, 2016
exampleProxyConfig.js properly use ipv6 config when starting proxy, adds extra keys to exam… Mar 23, 2016
package.json fixes package.json May 11, 2016
proxy.js properly use ipv6 config when starting proxy, adds extra keys to exam… Mar 23, 2016
run_tests.sh Make failing tests exit with non-zero status Jul 21, 2012
stats.js Account for negative clock skew in flushMetrics May 7, 2016


StatsD Build Status

A network daemon that runs on the Node.js platform and listens for statistics, like counters and timers, sent over UDP or TCP and sends aggregates to one or more pluggable backend services (e.g., Graphite).

We (Etsy) blogged about how it works and why we created it.


StatsD was inspired (heavily) by the project (of the same name) at Flickr. Here's a post where Cal Henderson described it in depth: Counting and timing Cal re-released the code recently: Perl StatsD

Key Concepts

  • buckets Each stat is in its own "bucket". They are not predefined anywhere. Buckets can be named anything that will translate to Graphite (periods make folders, etc)

  • values Each stat will have a value. How it is interpreted depends on modifiers. In general values should be integer.

  • flush After the flush interval timeout (defined by config.flushInterval, default 10 seconds), stats are aggregated and sent to an upstream backend service.

Installation and Configuration

  • Install node.js
  • Clone the project
  • Create a config file from exampleConfig.js and put it somewhere
  • Start the Daemon:
    node stats.js /path/to/config


The basic line protocol expects metrics to be sent in the format:


So the simplest way to send in metrics from your command line if you have StatsD running with the default UDP server on localhost would be:

echo "foo:1|c" | nc -u -w0 8125

More Specific Topics


There are additional config variables available for debugging:

  • debug - log exceptions and print out more diagnostic info
  • dumpMessages - print debug info on incoming messages

For more information, check the exampleConfig.js.


A test framework has been added using node-unit and some custom code to start and manipulate statsd. Please add tests under test/ for any new features or bug fixes encountered. Testing a live server can be tricky, attempts were made to eliminate race conditions but it may be possible to encounter a stuck state. If doing dev work, a killall statsd will kill any stray test servers in the background (don't do this on a production machine!).

Tests can be executed with ./run_tests.sh.


  • IRC channel: #statsd on freenode
  • Mailing list: statsd@librelist.com