node-statsd
A node.js client for Etsy's StatsD server.
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.
Installation
$ npm install node-statsd
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
cacheDns
: Cache the initial dns lookup to hostdefault: false
mock
: Create a mock StatsD instance, sending no stats to the server?default: false
global_tags
: Optional tags that will be added to every metricdefault: []
All StatsD methods have the same API:
name
: Stat namerequired
value
: Stat valuerequired except in increment/decrement where it defaults to 1/-1 respectively
sampleRate
: Sends only a sample of data to StatsDdefault: 1
tags
: The Array of tags to add to metricsdefault: []
callback
: The callback to execute once the metric has been sent
If an array is specified as the name
parameter each item in that array will be sent along with the specified value.
var 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; // Histogram: send data for histogram stat client; // Gauge: Gauge a stat by a specified amount 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; // Tags, this will add user-defined tags to the data client; // Using the callback client; // Sampling, tags and callback are optional and could be used in any combination client; // 25% Sample Rate client; // User-defined tag client; // Callback client; client; client; 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.