Repository files navigation

A network daemon that runs on theNode.js platform andlistens for statistics, like counters and timers, sent overUDP orTCP and sends aggregates to one or more pluggable backend services (e.g.,Graphite).

• buckets

  Each stat is in its own "bucket". They are not predefined anywhere. Bucketscan 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. Ingeneral values should be integers.

• flush

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

StatsD supports docker in three ways:

• The official container image onGitHub Container Registry
• The official container image onDockerHub
• Building the image from the bundledDockerfile

• Install Node.js (AllCurrent andLTS Node.js versions are supported.)
• Clone the project
• Create a config file fromexampleConfig.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:

<metricname>:<value>|<type>

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

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

• Metric Types
• Graphite Integration
• Supported Servers
• Supported Backends
• Admin TCP Interface
• Server Interface
• Backend Interface
• Metric Namespacing
• StatsD Cluster Proxy

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 theexampleConfig.js.

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

Tests can be executed with./run_tests.sh.

StatsD was originally written atEtsy and released with ablog post 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