Streaming parser for the statsd protocol

npm install statsd-parser
75 downloads in the last day
596 downloads in the last week
3 173 downloads in the last month


a streaming parser for the statsd protocol



  1. install npm
  2. npm install statsd-parser
  3. var statsd_parser = require('statsd-parser');



var statsd_parser = require("statsd-parser")
  , parser = statsd_parser.parser()

parser.onerror = function (e) {
  // an error happened. e is the error

parser.onstat = function (txt, obj) {
  // got some value
parser.onend = function () {
  // parser stream is done, and ready to have more stuff written to it.

// stream usage
// takes the same options as the parser
var stream = require("statsd-parser").createStream(options);

stream.on("error", function (e) {
  // unhandled errors will throw, since this is a proper node
  // event emitter.
  console.error("error!", e);
  // clear the error
  this._parser.error = null;

stream.on("stat", function (txt, obj) {
  // same object as above
// pipe is supported, and it's readable/writable
// same chunks coming in also go out

you also have two helper functions to see if a string is a statsd stat isStatsd and one to check extract values from a statsd string (or null if it's not statsd)

> var statsd = require('statsd-parser');
> statsd.isStatsd('a:1|c|@0.1')
> statsd.matchStatsd('a:1|c|@0.1')
{ stat: 'a',
  value: '1',
  type: 'c',
  sample_rate: '0.1' }
> statsd.matchStatsd('b:200|s')
{ stat: 'b',
  value: '200',
  type: 's' }
> statsd.matchStatsd('b:200|s@INVALID')


everyone is welcome to contribute. patches, bug-fixes, new features

  1. create an issue so the community can comment on your idea
  2. fork statsd-parser
  3. create a new branch git checkout -b my_branch
  4. create tests for the changes you made
  5. make sure you pass both existing and newly inserted tests
  6. commit your changes
  7. push to your branch git push origin my_branch
  8. create an pull request


(oO)--',- in caos

npm loves you