kinson/bunyan-bugsnag

A Bunyan stream for logging errors and warnings to Bugsnag

Bunyan Bugsnag Stream

Bugsnag is great for tracking errors. Even when an error is handled it is often still desired to log that error on Bugsnag using the bugsnag.notify() method. When Bunyan is used for logging errors are already being logged throughout an app; this stream allows sending logged errors to Bugsnag without adding Bugsnag calls in the application code as well.

Requires Node.js v4.7.3 or higher.

Installation

Install via npm:

npm install --save bunyan-bugsnag

Usage

Just add a bugsnagStream() to the Bunyan streams already in use:

import bugsnagStream from 'bunyan-bugsnag'

const logger = bunyan.createLogger({
  name: 'appName',
  streams: [{
    level: 'info',
    stream: process.stdout,
  }, {
    type: 'raw',
    level: 'warn',
    stream: bugsnagStream(),
  }],
})

Specifying the raw type is optional, but improves efficiency.

The stream takes the following options, with these values as defaults:

bugsnagStream({
  systemInfo: ['name', 'hostname', 'pid', 'req_id', 'level', 'time', 'v'],
  warningLevel: 'warn',
  errorLevel: 'error',
  bugsnag: require('bugsnag')
})

Use the warningLevel and errorLevel settings to specify which severity will be indicated to Bugsnag. For example, to send log.error() calls as a warning and only log.fatal() calls as errors set errorLevel: 'fatal'. Any level below warningLevel will be sent with info severity if the Bunyan stream config level is set to pass lower levels in the first place. Levels can be specified by name or as a number.

The systemInfo option determines which fields in the logged object will be sent as system info with the remaining items sent as info. The equivalent call would be:

bugsnag.notify(error, {
  system: {
    name: 'appName',
    hostname: 'HostName',
    pid: 25540,
    req_id: 'a4f81850-f5e4-11e6-9a41-7f186ecc7af4',
    level: 50,
    time: '2017-02-18T14:15:05.126Z',
    v: 0,
  },
  info: {
    msg: 'Something bad happened!',
    // Any other properties passed to the bunyan log method ...
  }
})

This will create system and info tabs in the Bugsnag report providing this information.

Passing a registered bugsnag instance as an option will override the bugsnag instance that is imported from the node library. You can register the bugsnag library before you create the bugsnagStream:

const bugsnag = require('bugsnag')
bugsnag.register('yourbugsnagkey')

bugsnagStream({ bugsnag })

Contributing

This library is pretty new, any thoughts/PRs are welcome.

License

This software is free to use under the MIT license. See the LICENSE file for license text and copyright information.