A tiny statsd client that supports timing, counters and gauges.
npm install statsdc
npm install https://github.com/martinrue/statsdc/tarball/master
var stats = require('statsdc');
stats.init({ host: 'localhost', port: 8125 }, function(err) {
// set timer to 100ms
stats.ms('some-timer', 100);
// set timer to 500ms, sampling one in ten events
stats.ms('some-timer', 500, 0.1);
// set gauge to 11
stats.g('some-gauge', 11);
// increment counter by 1
stats.c('some-counter', 1);
// decrement counter by 10
stats.c('some-counter', -10);
});The following config options are supported:
{
// required: hostname of statsd server
host: 'localhost',
// required: statsd server port
port: 8125,
// optional: prefix to attach to all metrics
prefix: 'my-app',
// optional: show stats on console
debug: true
}If host is set to a hostname rather than an IP address, a single DNS lookup is performed and cached during init.
If prefix is set, it'll be attached to all outgoing metrics. E.g. with { ... , prefix: 'my-app' }, a call to stats.c('some-counter', 1); will add 1 to the counter named my-app.some-counter.
If you need to shut down the client, stats.close() will gracefully unbind the UDP socket.
Metrics are submitted to statsd on every respective call via UDP. A single UDP socket is created during init and reused.
MIT