winston-cloudant

Cloudant NoSQL DB Transport for Winston

The winston-cloudant module allows you to log your winston messages to IBM's Cloudant NoSQL DB.

const winston = require('winston');
const WinstonCloudant = require('winston-cloudant');

const logger = winston.createLogger({
    transports: [
        new cloudantTransport({
            url: '...',
            db: '...'
        })
    ]
});

Installation

  $ npm install --save winston-cloudant

Usage

Winston-cloudant is just like any other transport for winston. When adding it to winston, it takes some options so that it knows where to log to Cloudant.

Note that the latest version of this transport is made for winston 3.0 and up. If using older version of winston, please use older version (1.x) of this library.

The Cloudant NoSQL DB transport takes the following options:

url         : Access url including user and password
username    : Username for the Cloudant DB instance
password    : Password for the Cloudant DB instance
host        : Host for the Cloudant DB instance
iamApiKey   : IAM session cookie
db          : Name of the databasename to put logs in
logstash    : Write logs in logstash format

url

The access url for a Cloudant DB instance can be retreived from IBM Cloud portal under Service credentials. The url option is equivalent to and, if provided, used in precedence of username/password/host.

username

The username for a Cloudant DB instance can be retreived from IBM Cloud portal under Service credentials.

password

The password for a Cloudant DB instance can be retreived from IBM Cloud portal under Service credentials.

host

The host for a Cloudant DB instance can be retreived from IBM Cloud portal under Service credentials.

iamApiKey

Used in conjection with url (without credentials) for token based login to iam-based Cloudant services instead of basic auth (username and password).

db

The name of the database where logs should be writen. Default if none priveded is winston-cloudant.

logstash

True or false indicating logs to be writen in logstash format. Default is false.

Result

In your Cloudant instance a new database will be created with the specified name containing a new document for each log. The timestamp will be in the root level of the document and thus aid in sorting. The child node params will vary in formatting depending on the logstash flag but always contain the log itself along with some metadata.

Author

Written by Håkan Öström