dogstatsd-node
A node.js client for Etsy's StatsD server extended with Datadog's histogram and tags.
Most of the code (including parts of this readme) is copied directly from the excellent https://github.com/sivy/node-statsd (v0.0.7), and the datadog parts wrote in by looking at https://github.com/joybro/node-dogstatsd, but with an added twist in the API.
IMPORTANT: This is not a drop-in replacement for node-statsd or node-dogstatsd, the API has changed.
This client will let you fire stats at your StatsD server from a node.js application.
node-statsd Runs and is tested on Node 0.6+ on all *nix platforms and 0.8+ on all platforms including Windows. (So this should work too.)
Usage
All initialization parameters are optional.
Parameters (specified as an options hash):
host
: The host to send stats todefault: localhost
port
: The port to send stats todefault: 8125
prefix
: What to prefix each stat name withdefault: ''
suffix
: What to suffix each stat name withdefault: ''
globalize
: Expose this StatsD instance globally?default: false
dnsCache
: Cache the initial dns lookup to hostdefault: false
mock
: Create a mock StatsD instance, sending no stats to the server?default: false
All StatsD/DataDog methods have the same API:
name
: Stat namerequired
value
: Stat valuerequired except in increment/decrement where it defaults to 1/-1 respectively
which returns a Stat Object which can sent by calling .send() on them. Additional options to the stat maybe chained by calling stat.sampleRate(value).tags(['x:1']) before sending.
If an array is specified as the name
parameter each item in that array will be sent along with the specified value.
var StatsD = StatsD client = ; // Timing: sends a timing command with the specified milliseconds client; // Increment: Increments a stat by a value (default is 1) client; // Decrement: Decrements a stat by a value (default is -1) client; // Gauge: Gauge a stat by a specified amount client; // Histogram: Datadog's histogram client; // Set: Counts unique occurrences of a stat (alias of unique) client; client; // Incrementing multiple items client; // Sampling, this will sample 25% of the time the StatsD Daemon will compensate for sampling client; // Datadog's Tags clienttags'host:xyz'; // Using the callback client;
Errors
In the event that there is a socket error, node-statsd
will allow this error to bubble up. If you would like to catch the errors, just attach a listener to the socket property on the instance.
clientsocket;
If you want to catch errors in sending a message then use the callback provided.
License
node-statsd is licensed under the MIT license. So is this.