winston-graylog2

A graylog2 transport for winston based on the node-graylog2 Library

Updated version, this version supports Winston2 and updated other dependencies to their newest versions. Also makes use of YARN.

Installation

Tested on node-4.6.1, requires npm.

  $ yarn add winston
  $ yarn add winston2-graylog2

Usage

  var winston = require('winston');
  winston.add(require('winston2-graylog2'), options);

or

var WinstonGraylog2 = require('winston2-graylog2');
var logger = new(winston.Logger)({
        exitOnError: false,
        transports: [new(WinstonGraylog2)(options)]
      });

Options

• name: Transport name
• level: Level of messages this transport should log. (default: info)
• silent: Boolean flag indicating whether to suppress output. (default: false)
• handleExceptions: Boolean flag, whenever to handle uncaught exceptions. (default: false)
• exceptionsLevel: Level of exceptions logs when handleExceptions is true. (default: error)
• prelog: Pre-filtering function, to clean message before sending to graylog2 (default: empty function)
• graylog:
  • servers; list of graylog2 servers
    • host: your server address (default: localhost)
    • port: your server port (default: 12201)
  • hostname: the name of this host (default: os.hostname())
  • facility: the facility for these log messages (default: "Node.js")
  • bufferSize: max UDP packet size, should never exceed the MTU of your system (default: 1400)
• staticMeta: meta data to be always used by each logging message, for instance environment (development, staging, live)

example:

{
  name: 'Graylog',
  level: 'debug',
  silent: false,
  handleExceptions: false,
  prelog: function(msg) {
    return msg.trim();
  },
  graylog: {
    servers: [{host: 'localhost', port: 12201}, {host: 'remote.host', port: 12201}],
    hostname: 'myServer',
    facility: 'myAwesomeApp',
    bufferSize: 1400
  },
  staticMeta: {env: 'staging'}
}

Log Levels

Supported log levels, as from node-graylog2, are the following

Winston Level | Graylog2 level ---------------|--------------- emerg | emergency alert | alert crit | critical error | error warning | warning warn | warning notice | notice info | info debug | debug

All other possibile winston's level, or custom levels, will default to info