Package Exports

parseable-bunyan
parseable-bunyan/dist/cjs/packages/bunyan/src/index.js
parseable-bunyan/dist/es6/packages/bunyan/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (parseable-bunyan) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Parseable-Bunyan

Parseable buffered stream plugin for the popular Node-Bunyan logging framework.

Dependencies

Installation

npm install parseable-bunyan

yarn add parseable-bunyan

Usage

Package is cjs and es6 compatible.

Logs are buffered in memory and flushed periodically for more efficient ingestion. By default a maxEntries of 250, and flushInterval of 5 seconds are used.

const { ParseableStream } = require('parseable-bunyan')
const bunyan = require('bunyan')

const parseable = new ParseableTransport({
  url: process.env.PARSEABLE_URL, // Ex: 'https://parsable.myserver.local/api/v1/logstream'
  username: process.env.PARSEABLE_USERNAME,
  password: process.env.PARSEABLE_PASSWORD,
  logstream: process.env.PARSEABLE_LOGSTREAM, // The logstream name
  tags: { tag1: 'tagValue' } // optional tags to be added with each ingestion
})

const logger = winston.createLogger({
  levels: winston.config.syslog.levels,
  transports: [parseable],
  defaultMeta: { instance: 'app', hostname: 'app1' }
})

logger.info('User took the goggles', { userid: 1, user: { name: 'Rainier Wolfcastle' } })
logger.warning('The goggles do nothing', { userid: 1 })

Tuning the default buffering options

const parseable = new ParseableTransport({
  url: process.env.PARSEABLE_LOGS_URL,
  username: process.env.PARSEABLE_LOGS_USERNAME,
  password: process.env.PARSEABLE_LOGS_PASSWORD,
  logstream: process.env.PARSEABLE_LOGS_LOGSTREAM,
  buffer: { maxEntries: 100, flushInterval: 5000 }
})

Other optional parameters

disableTLSCerts: Default to false. Set to true to ignore invalid certificate
http2: Default to true. Set to false to use HTTP/1.1 instead of HTTP/2.0

LICENCE

MIT