+1
Daily
18,076
stars
1,934
forks
436
watchers
475
prs
282
issues
0
releases
README
StatsD
A network daemon that runs on the [Node.js][node] platform and
listens for statistics, like counters and timers, sent over [UDP][udp] or
[TCP][tcp] and sends aggregates to one or more pluggable backend services (e.g.,
[Graphite][graphite]).
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 integers.
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
Docker
StatsD supports docker in three ways:
The official container image on GitHub Container Registry
The official container image on DockerHub
Building the image from the bundled Dockerfile
Manual installation
Install Node.js (All Current and LTS Node.js versions are supported.)
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:
:|
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
[Metric Types][docs_metric_types]
[Graphite Integration][docs_graphite]
[Supported Servers][docs_server]
[Supported Backends][docs_backend]
[Admin TCP Interface][docs_admin_interface]
[Server Interface][docs_server_interface]
[Backend Interface][docs_backend_interface]
[Metric Namespacing][docs_namespacing]
[StatsD Cluster Proxy][docs_cluster_proxy]
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.
History
StatsD was originally written at [Etsy][etsy] and released with a
[blog post][blog post] 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][counting-timing].
Cal re-released the code recently:
[Perl StatsD][Flicker-StatsD]
[graphite]: http://graphite.reaTop issues
#443Number of StatsD instances in a single host12 comments · 2014-08-14#710Command line arguments11 comments · 2020-07-14#30920% of lost values after statsd9 comments · 2013-07-01#713Gauge type metric stops populating in AWS CloudWatch after some period of time8 comments · 2020-09-30#682IANA port assignment7 comments · 2019-08-22#283Support Cormode-Muthukrishnan percentiles7 comments · 2013-03-29#715How to run the docker image?6 comments · 2020-12-04#585How to escape metrics with colon in the name6 comments · 2016-08-22