winston-graylog2

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

Installation

Tested on node-0.10.x, requires npm. Recently rewritten to use ES6 for better compatibility with Winston@3, so please use only with NodeJS >=8.

If you need to support older versions of Node, please use a version compatible with ^[email protected].

$ npm install winston
$ npm install winston-graylog2

Usage

var winston = require('winston');
var WinstonGraylog2 = require('winston-graylog2');

var options = { ...<your config options here>... };
winston.add(new winstonGraylog2(options));

var winston
var WinstonGraylog2 = require('winston-graylog2');

var options = { ...<your config options here>... };
var logger = winston.createLogger({
  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)
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)

Older versions of winston-graylog2 allowed the prelog and processMeta options for pre-processing logs and metadata attached to messages (such as stack traces). Winston 3 has implemented independent, custom formatters for handling these things, and they are not longer supported at the transport level. See the Winston docs for details on formatters.

example:

{
  name: 'Graylog',
  level: 'debug',
  silent: false,
  handleExceptions: false,
  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

fdt2k / winston-graylog2 Goto Github PK