base on Daemon for easy but powerful stats aggregation # 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 three ways: * The official container image on [GitHub Container Registry](https://github.com/statsd/statsd/pkgs/container/statsd) * The official container image on [DockerHub](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: <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 * [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 ", Assign "at most 3 tags" to the expected json: {"id":"12028","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"