Giter Site home page Giter Site logo

winston-mongodb's Introduction

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. [required]

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

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

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

Metadata: Logged as a native JSON object.

Installation

Installing npm (node package manager)

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

Installing winston-mongodb

  $ npm install winston
  $ npm install winston-mongodb

winston-mongodb's People

Contributors

awlawl avatar chjj avatar indexzero avatar sixcircuit avatar yosefd avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.