dmitrig01 / winston-syslogUdp

winston-syslogUdp

A UDP Only Syslog transport for [winston], developed for use with Loggly but compliant with syslog standards.

Installation

  $ npm install winston 
  $ npm install winston-syslogudp

Motivation

This module is based on winston-syslog and syslogUdp and intended to provide a lightweight UDP only winston syslog transport. It was created when the authors experienced challenges with winston-syslog and with winston-loggly.

Usage

To use the Syslog transport in [winston], you simply need to require it and then either add it to an existing [winston] logger or pass an instance to a new [winston] logger:

  var winston = require('winston');
  require('winston-syslogudp').Syslog;  
  winston.add(winston.transports.Syslog, options);

Options:

• host: The host running syslogd, defaults to localhost.
• port: The port on the host that syslog is running on, defaults to syslogd's default port.
• pid: PID of the process that log messages are coming from (Default process.pid).
• facility: Syslog facility to use (Default: local0).
• localhost: Host to indicate that log messages are coming from (Default: localhost).
• type: The type of the syslog protocol to use (Default: BSD).
• logglyHeader: The additional information required for loggly v2. example: logglyHeader = '[41a111bb-12f1-9c9c-b14c-12345a678aaa@41058] tags="foo"' (Default: null).

Metadata: Logged as string compiled by [glossy].

Log Levels

Because syslog only allows a subset of the levels available in [winston], levels that do not match will be ignored. Therefore, in order to use winston-syslogudp effectively, you should indicate to [winston] that you want to use the syslog levels:

  var winston = require('winston');
  winston.setLevels(winston.config.syslog);

The Syslog transport will only log to the level that are available in the syslog protocol. These are (in increasing order of severity):

• debug
• info
• notice
• warning
• error
• crit
• alert
• emerg