# statsd > Network daemon for the collection and aggregation of realtime application metrics Latest version **0.9.0** (published 2020-08-27) · MIT license · 0 weekly downloads ## Install ```sh npm install statsd pnpm add statsd yarn add statsd bun add statsd ``` Provides the command `statsd`. ## Health **Score 20/100 (F)** — status: abandoned. Positive: no vulnerabilities; popular repo. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.9.0 | | Published | 2020-08-27 | | First published | 2012-02-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8 | | Dependencies | 4 | | Unpacked size | 306.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 18076 | | Author | Etsy | | Maintainers | bluehat, mheffner, mrtazz | | Keywords | statsd, etsy, metric, aggregation, realtime | ## Links - npm: https://www.npmjs.com/package/statsd - Repository: https://github.com/statsd/statsd - Issues: https://github.com/statsd/statsd/issues - npm.io page: https://npm.io/package/statsd ## Dependencies (4) - [winser](https://npm.io/package/winser.md) =0.1.6 - [hashring](https://npm.io/package/hashring.md) 3.2.0 - [generic-pool](https://npm.io/package/generic-pool.md) 2.2.0 - [modern-syslog](https://npm.io/package/modern-syslog.md) 1.2.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 0.9.0 (latest) — 2020-08-27 - 0.8.6 — 2020-02-26 - 0.8.5 — 2019-07-23 - 0.8.4 — 2019-07-11 - 0.8.3 — 2019-07-11 - 0.8.2 — 2019-07-11 - 0.8.0 — 2016-05-11 - 0.7.2 — 2014-09-11 - 0.7.1 — 2014-02-06 - 0.7.0 — 2013-12-06 - 0.6.0 — 2013-03-15 - 0.5.0 — 2012-07-20 - 0.4.0 — 2012-06-29 - 0.3.0 — 2012-05-16 - 0.2.1 — 2012-05-14 - … 2 more at https://npm.io/package/statsd/versions ## README # StatsD [![Build Status][travis-ci_status_img]][travis-ci_statsd] [![Join the chat at https://gitter.im/statsd/statsd](https://badges.gitter.im/statsd/statsd.svg)](https://gitter.im/statsd/statsd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Docker Pulls](https://img.shields.io/docker/pulls/statsd/statsd)](https://hub.docker.com/r/statsd/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 two ways: * The official docker image on [docker hub](https://hub.docker.com/r/statsd/statsd) * Building the image from the bundled [Dockerfile](./Dockerfile) ### Manual installation * Install Node.js (All [`Current` and `LTS` Node.js versions](https://nodejs.org/en/about/releases/) 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.readthedocs.org/ [etsy]: http://www.etsy.com [blog post]: https://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/ [node]: http://nodejs.org [nodemods]: http://nodejs.org/api/modules.html [counting-timing]: http://code.flickr.com/blog/2008/10/27/counting-timing/ [Flicker-StatsD]: https://github.com/iamcal/Flickr-StatsD [udp]: http://en.wikipedia.org/wiki/User_Datagram_Protocol [tcp]: http://en.wikipedia.org/wiki/Transmission_Control_Protocol [docs_metric_types]: https://github.com/statsd/statsd/blob/master/docs/metric_types.md [docs_graphite]: https://github.com/statsd/statsd/blob/master/docs/graphite.md [docs_server]: https://github.com/statsd/statsd/blob/master/docs/server.md [docs_backend]: https://github.com/statsd/statsd/blob/master/docs/backend.md [docs_admin_interface]: https://github.com/statsd/statsd/blob/master/docs/admin_interface.md [docs_server_interface]: https://github.com/statsd/statsd/blob/master/docs/server_interface.md [docs_backend_interface]: https://github.com/statsd/statsd/blob/master/docs/backend_interface.md [docs_namespacing]: https://github.com/etsy/statsd/blob/master/docs/namespacing.md [docs_cluster_proxy]: https://github.com/etsy/statsd/blob/master/docs/cluster_proxy.md [travis-ci_status_img]: https://travis-ci.org/statsd/statsd.svg?branch=master [travis-ci_statsd]: https://travis-ci.org/statsd/statsd --- _Source: https://npm.io/package/statsd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._