Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Graylog2 transport for winston, a nodejs logging module
JavaScript
Branch: master

Merge pull request #28 from slang800/master

add SPDX license code to package.json
latest commit cc103cc1e1
@unlucio unlucio authored

readme.md

winston-graylog2 Build Status

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

Installation

Tested on node-0.10.x, requires npm.

  $ npm install winston
  $ npm install winston-graylog2

Usage

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

or

var WinstonGraylog2 = require('winston-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)
  • 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)

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
  }
}

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
notice notice
info info
debug debug

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

Something went wrong with that request. Please try again.