Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Simple daemon for easy stats aggregation
JavaScript Java Erlang Scala Go PHP Other
Failed to load latest commit information.
backends Backend key name sanitization can be controlled with config flag
bin add bin/statsd
debian removing duplicated libs from debian package
docs add couchdb to backends
examples Julia statsd client implementation
lib Validate negative sampling
packager Enable packaging at https://packager.io/gh/pkgr/statsd
servers Initialise tcp buffer to empty string
test Merge pull request #470 from shaylang/pr_155_take2
utils clearer sample graphite url
.gitignore Added IDEA project files to .gitignore
.pkgr.yml Enable packaging at https://packager.io/gh/pkgr/statsd
.travis.yml run tests on v0.12.x
CONTRIBUTING.md move contributing information into CONTRIBUTING.md
Changelog.md bumping for v0.7.2 patch release
LICENSE Fix outdated copyright year (update to 2014)
README.md Add server documentation links
exampleConfig.js Backend key name sanitization can be controlled with config flag
exampleProxyConfig.js Proxy with cluster module
package.json add license information into package.json
proxy.js Proxy with cluster module
run_tests.sh Make failing tests exit with non-zero status
stats.js Backend key name sanitization can be controlled with config flag

README.md

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.

Inspiration

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

Usage

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 have StatsD running with the default UDP server on localhost would be:

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

More Specific Topics

Debugging

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.

Tests

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.

Meta

  • IRC channel: #statsd on freenode
  • Mailing list: statsd@librelist.com
Something went wrong with that request. Please try again.