auth0/bunyan-kinesis

Name: bunyan-kinesis

Owner: Auth0

Description: Kinesis writteable stream for bunyan.

Created: 2015-08-05 20:19:26.0

Updated: 2016-09-06 19:57:02.0

Pushed: 2017-09-25 11:23:10.0

Homepage: null

Size: 14

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Deprecated. Use aws-kinesis-writable

Kinesis writteable stream for bunyan.

Installation

i bunyan-kinesis --save

Usage

BunyanKinesis = require('bunyan-kinesis');

log = bunyan.createLogger({
reams: [
{
  stream: new BunyanKinesis({
    accessKeyId:     'KEY_ID',
    secretAccessKey: 'SECRET_KEY',
    region:          'AWS_REGION',
    streamName:      'MyKinesisStream',
    partitionKey:    'MyApp'
  })
}

Configuration Parameters

buffer (defaults to true): This library uses by default an smart buffering approach. Events are sent when one of the following conditions are meet:

• 5 seconds after the last batch of messages sent.
• 10 messages are queued waiting to be sent.
• an entry with one of the following levels comes in WARN, ERROR or FATAL

partitionKey can be either an string or a function that accepts an log entry and returns a string. Example:

BunyanKinesis({
gion:          'AWS_REGION',
reamName:      'MyKinesisStream',
rtitionKey:     function (entry) { return entry.level + '|' + entry.name; }

streamName is the name of the Kinesis Stream.

Note: Amazon Credentials are not required. It will either use the environment variables, ~/.aws/credentials or roles as every other aws sdk.

License

MIT 2015 - AUTH0 INC.