winston

A MongoDB transport for winston.

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: The name of the database you want to log to.

• collection: The name of the collection you want to store log messages in, defaults to 'logs'.

• safe: Boolean indicating if you want eventual consistency on your log messages, if set to true it requires an extra round trip to the server to ensure the write was committed, defaults to true.

• nativeParser: Boolean indicating if you want the driver to use native parser feature or not.

• host: The host running MongoDB, defaults to localhost.

• port: The port on the host that MongoDB is running on, defaults to MongoDB's default port.

• 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.

• errorTimeout: Reconnect timeout upon connection error from Mongo, defaults to 10 seconds (10000).

• timeout: Timeout for keeping idle connection to Mongo alive, defaults to 10 seconds (10000).

• 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.

• label: Label stored with entry object if defined.

• ssl: Boolean indicating if you want to use SSL connections or not.

• authDb: Authentication database object.

• replSet: Replica set name.

• hosts: Array of replica set hosts (in format {host: 'string', port: 'number'})

• dbUri: Alternative way of specifying database connection data. Supported specifying database, host, port, username, password and replica sets.

Notice: db is required. You should specify it directly or in dbUri.

ReplicaSet Notice: If you use replica set, db, replSet and hosts are required. They may also be specified in dbUri.

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

Installing npm (node package manager)

  $ curl http://npmjs.org/install.sh | sh

Installing winston-mongodb

  $ npm install winston
  $ npm install winston-mongodb

Changelog

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