winstonjs / winston-riak

A Riak transport for winston

winston-riak

A Riak 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-riak` will expose 
  // `winston.transports.Riak`
  //
  require('winston-riak').Riak;
  
  winston.add(winston.transports.Riak, options);

In addition to the options accepted by the riak-js client, the Riak transport also accepts the following options. It is worth noting that the riak-js debug option is set to false by default:

• level: Level of messages that this transport should log.
• bucket: The name of the Riak bucket you wish your logs to be in or a function to generate bucket names dynamically.

  // Use a single bucket for all your logs
  var singleBucketTransport = new (winston.transports.Riak)({ bucket: 'some-logs-go-here' });
  
  // Generate a dynamic bucket based on the date and level
  var dynamicBucketTransport = new (winston.transports.Riak)({
    bucket: function (level, msg, meta, now) {
      var d = new Date(now);
      return level + [d.getDate(), d.getMonth(), d.getFullYear()].join('-');
    }
  });

Metadata: Logged as JSON literal in Riak

Installation

Installing npm (node package manager)

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

Installing winston-riak

  $ npm install winston
  $ npm install winston-riak

Author: Charlie Robbins

winston-riak's Issues

License?

I'd guess you'd license it FOSS but thought I'd ask. My dependencies-ci caught the lack of license when testing Flannel. Thanks!

I think you meant "A Riak transport for Winston"

Rather than "A Riak transport for MongoDB" :-)