Logger

Wrapping the winston module.

The wrapper is for creating as many winston transport as you wish by passing a JSON argument (like in a config file) It is made for easily changing parameters for logging when changing environnement without touching the logging code The return object is simply a winston Logger, so you can still use all of its methods (like removing/adding transport, setting levels...)

Usage

var Logger = require('winston-wrapper')
var goodConf =
{
  konsole: {
    type: 'Console',
    opts: {
      level: 'silly',
      colorize: true,
      json: false,
      handleExceptions: true,
      prettyPrint: true
    }
  },
  file: {
    type: 'File',
    opts: {
      name: 'first',
      filename: 'test.log',
      level: 'silly',
      json: false,
      maxsize: 1048576,
      maxFiles: 5
    }
  },
  http: {
    type: 'Http',
    opts: {
      level: 'warn',
      host: 'localhost',
      port: '8080',
      level: 'silly'
    }
  },
  exception: {
     type: 'File',
    opts: {
      filename: 'exception.log',
    }
  }
}
var mylogger = Logger(conf)

This will instantiate a logger with 3 transports.

• type : the name of the transport to use.
• instance : you can add an exceptionHandlers by setting this property to 'exception'
• opts : the options supported by the transport defined by Type.

View here to see all type and all options.

Advanced Usage

If you wish to use non standard winston transport, or even your own, you just have to require the module before passing the JSON.

var Logger = require('winston-wrapper')
var Mail = require('winston-mail').Mail //expose winston.Transports.Mail

var conf = {
    mail: {
    type: 'Mail',
    opts: {
      to: 'toto@example.vcom',
      from: 'tata@example.com',
      ...
    },
    ...
}
var mylogger = Logger(conf)

By default :

• the colors and levels used for logging are the npm basic ones. You can modify them using the winston method once the logger is created (configure(), setLevels()...see doc)
• has the property 'exitOnError' set to false