Simple daemon for easy stats aggregation

Перейти к файлу

Patrick Koch a1b9b2169d bumping for v0.7.2 patch release Let's see if travis will upload a release to npm for us.		2014-09-22 17:34:36 +03:00
backends	Add missing space to console.log message about flushing stats.	2014-03-25 09:40:24 -07:00
bin	add bin/statsd	2012-06-28 16:07:37 +02:00
debian	statsd.upstart: exec to remove parent shell from process list	2014-06-08 15:04:23 +04:00
docs	fix typo	2014-04-22 16:26:32 +08:00
examples	Julia statsd client implementation	2014-02-26 12:03:17 -08:00
lib	Don't allow histogram bins contain dots	2014-04-18 12:17:18 +04:00
test	Don't allow histogram bins contain dots	2014-04-18 12:17:18 +04:00
utils	clearer sample graphite url	2013-02-19 19:02:37 -05:00
.gitignore	Be more nodeish... package.json and gitignore	2012-02-15 16:22:24 -05:00
.travis.yml	use travis ci to deploy npm packages from tags	2013-12-05 16:40:43 -05:00
CONTRIBUTING.md	move contributing information into CONTRIBUTING.md	2014-01-29 14:07:16 +01:00
Changelog.md	bumping for v0.7.2 patch release	2014-09-22 17:34:36 +03:00
LICENSE	Fix outdated copyright year (update to 2014)	2014-03-25 17:01:25 -07:00
README.md	Added the -w0 to the Usage example	2014-04-18 14:06:58 +03:00
exampleConfig.js	Merge pull request #423 from enriclluelles/patch-2	2014-05-15 15:53:45 -04:00
exampleProxyConfig.js	Update exampleProxyConfig.js	2014-05-10 23:37:16 +09:00
package.json	bumping for v0.7.2 patch release	2014-09-22 17:34:36 +03:00
proxy.js	Performance tweaks to proxy	2013-12-06 08:56:40 -05:00
run_tests.sh	Make failing tests exit with non-zero status	2012-07-20 22:17:08 -07:00
stats.js	Enhancement: inject logger object into backend	2013-11-28 18:01:16 +01:00

README.md

StatsD

A network daemon that runs on the Node.js platform and listens for statistics, like counters and timers, sent over UDP 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 via UDP in the format:

<metricname>:<value>|<type>

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

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

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.