winston-mongodb

A MongoDB transport for winston

winston


A MongoDB transport for winston.

Current version supports only mongodb driver version 2.x. If you want to use winston-mongodb with mongodb version 1.4.x use winston-mongodb <1.x.

Motivation

tldr;?: To break the winston codebase into small modules that work together.

The winston codebase has been growing significantly with contributions and other logging transports. This is awesome. However, taking a ton of additional dependencies just to do something simple like logging to the Console and a File is overkill.

Usage

  var winston = require('winston');
  
  /**
   * Requiring `winston-mongodb` will expose
   * `winston.transports.MongoDB`
   */
  require('winston-mongodb').MongoDB;
  
  winston.add(winston.transports.MongoDB, options);

The MongoDB transport takes the following options. 'db' is required:

• level: Level of messages that this transport should log, defaults to 'info'.
• silent: Boolean flag indicating whether to suppress output, defaults to false.
• db: MongoDB connection uri or preconnected db object.
• options: MongoDB connection parameters (optional, defaults to {db: {native_parser: true}, server: {poolSize: 2, socketOptions: {autoReconnect: true}}}).
• collection: The name of the collection you want to store log messages in, defaults to 'logs'.
• storeHost: Boolean indicating if you want to store machine hostname in logs entry, if set to true it populates MongoDB entry with 'hostname' field, which stores os.hostname() value.
• username: The username to use when logging into MongoDB.
• password: The password to use when logging into MongoDB. If you don't supply a username and password it will not use MongoDB authentication.
• label: Label stored with entry object if defined.
• name: Transport instance identifier. Useful if you need to create multiple MongoDB transports.
• capped: In case this property is true, winston-mongodb will try to create new log collection as capped, defaults to false.
• cappedSize: Size of logs capped collection in bytes, defaults to 10000000.

Metadata: Logged as a native JSON object in 'meta' property.

Logging unhandled exceptions: For logging unhandled exceptions specify winston-mongodb as handleExceptions logger according to winston documentation.

Querying and streaming logs

Besides supporting the main options from winston, this transport supports the following extra options:

• includeIds: Whether the returned logs should include the _id attribute settled by mongodb, defaults to false.

Installation

  $ npm install winston
  $ npm install winston-mongodb

Changelog

Brief 1.0.0 changelog

• migrated to mongodb 2.x driver;
• changed configuration format to MongoDB uri string;
• added support of passing preconnected db object instead of MongoDB uri string;
• added support of passing MongoDB connection parameters in options property;
• added support of replica sets through new options and db properties;
• migrated to Semantic Versioning in package versions names;
• changed comments format to JSDoc;
• removed authDb from configuration options (it's impossible to handle all possible authorization scenarios, so, if you need to use complicated authorization pattern, please provide winston-mongodb with already prepared db connection object).

Brief 0.5 changelog

• metadata is now stored into separate property meta; so, there is no risk that some of the metadata object's properties will conflict with logging entry properties.

Author: Charlie Robbins

Contributors: Yurij Mikhalevich, Kendrick Taylor, Yosef Dinerstein, Steve Dalby