winston-splnkstrm

splunkstorm transport for winston

npm install winston-splnkstrm
1 downloads in the last week
5 downloads in the last month

winston-splnkstrm

Build Status

NPM

NPM

In their Logging Best Practises Splunk strongly encourages the usage of key-value pairs in logs. This winston plugin takes messages and meta data hashes and creates a key-value structured string out of it.

Installation

npm install winston-splnkstrm

Example Usage

var winston = require('winston');
var Splnkstrm = require('winston-splnkstrm');

winston.add(Splnkstrm, {
    apiKey: 'api-key',
    projectId: 'projectId'
});

winston.info({a: 'b'});

//output: 2013-12-09T07:10:49.522Z a=b, lvl=info, hst=fooHost

Parameters for the SplnkStrm constructor:

  • apiKey your apiKey at splunkstorm.com (mandatory)
  • projectId your projectId at splunkstorm.com (mandatory)
  • sourceType an arbitrary sourceType, defaults to 'syslog'
  • source your source, defaults to ''
  • host a host that should be used. defaults to os.hostname()
npm loves you