winston-statsd

generates `statsd` from winston logs — extremely tailored to nodejitsu internal needs, use accordingly

npm install winston-statsd
8 downloads in the last month

winston-statsd

generates statsd from winston logs — extremely tailored to nodejitsu internal needs, use accordingly

don't use this unless you know what you are doing

don't use this module unless you read all the code — it's documented well enough. if you end up using it please feel free to add to this read-me file and make it so others can to

if you don't work at nodejitsu, you probably don't want to use this

installation

  1. install npm
  2. npm install winston winston-statsd --save

setup

just require it as any other transport and use the logger:

var winston = require('winston');

require('winston-statsd');

new (winston.Logger)(
  { transports:
    [ new (winston.transports.Statsd)(
      { hostname: 'localhost', port: 8125 })
    ]
  });

refer to the lynx documentation for more configuration parameters you might wish to use, e.g. scope to prefix all messages you send with your package name

var winston = require('winston')
  , scope   = require('./package.json').name.replace(/[^a-zA-Z\d_]/, '')
  ;

require('winston-statsd');

new (winston.Logger)(
  { transports:
    [ new (winston.transports.Statsd)(
      { hostname: 'localhost', port: 8125, scope: scope })
    ]
  });

you can also define a separator in the options. by default this will ignore any log message that does not respond to the following regex:

/^[a-z\d]+([:\.\-_][a-z\d]+)*$/

the : is the separator, and will be replaced by something else if you specify your own separator

usage

just log something that has no spaces and uses the separator you defined:

logger.log('info', 'foo:bar');

the default operation is to increment info.foo.bar by one.

specifying other stats and sample rate

counts are just a subset of what statsd supports. here is how you can change your log message from a count to something else:

logger.log('info', 'baz',
  { "statsd_v"          : 1     // any number
  , "statsd_s"          : "c"   // /c|ms|g|s/
  , "statsd_sample_rate": 1     // number between 0—1
  });

nodejitsu specific

if you specify user, app, message, or error in your metadata we will send more stuff to statsd:

logger.log('error', 'app:slave:tell', 
  { app: "test"
  , username: "marak"
  , error: "connect ECONNREFUSED"
  });

will produce the following metrics:

error.app.slave.tell.connect_econnrefused:1|c
users.marak.error.app.slave.tell:1|c
apps.marak.test.error.app.slave.tell:1|c
errors.marak.test.connect_econnrefused.error.app.slave.tell:1|c

you are right, this should be generalized and specified at setup time. feel free to send a pull request if you care that much

tests

to run (and configure) the test suite simply:

cd winston-statsd
npm install
npm test

meta

       /l、  < STATSD NAO!
     (゚、 。 7
___ l、 ~ヽ__
      じしf_, )ノ \
___________ \
 ̄ ̄ ̄ ̄ ̄ ̄ ̄ ̄ ̄| | ̄
_________| |
 ̄ ̄ ̄ ̄ ̄ ̄ ̄ ̄ ̄| |

credit: http://dis.4chan.org/read/sjis/1223854889

(oo)--',- in caos

the mit license

copyright 2012 nuno job (oo)--',--

permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "software"), to deal in the software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, and to permit persons to whom the software is furnished to do so, subject to the following conditions:

the above copyright notice and this permission notice shall be included in all copies or substantial portions of the software.

the software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement. in no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

npm loves you