Report Error

Real-time error reporting & tracking using popular error tracking services with fallback to console messages.

About

This module is a wraper which allows to use one of many error reporting services with the single API.

Why

We work on many modules for NodeJS and having an unified way to report handled errors, warnings and info messages across all modules helps to detect easily when something goes wrong or might go wrong.

Installation

Using npm:

$ npm install report-error --save

Using yarn:

$ yarn add report-error

Usage

Standalone:

// Load the module.
const report = require('report-error')

// Load custom reporter service.
report.init({
  // We currently support only Bugsnag service.
  bugsnag: 'BUGSNAG_API_KEY'
})

// Send an error message.
report.send(new Error('Something went wrong!'))
report.error(new Error('Something went wrong!'))

// Send a warning message.
report.warning('Something went wrong!')

// Send an info message.
report.info('Something went wrong!')

// Every type of message supports meta information.
// This is an Object containing additional information about the message.
resport.send(new Error('Sign up failed'), { username: 'foo' })

In ExpressJS:

// Load the module.
const report = require('report-error')

// Load custom reporter service.
report.init({
  // We currently support only Bugsnag service.
  bugsnag: 'BUGSNAG_API_KEY'
})

// Express app.
const app = express()

// Add the requestHandler middleware as the first middleware
// of your application.
app.use(report.requestHandler)

// Add the errorHandler after all other middleware,
// but before any "error" middleware.
app.use(report.errorHandler)

Supported services

Console

The default error reporting services is the default console. All messages received by this service are sent to STDOUT and STDERR.

Bugsnag

Bugsnag is an awesome service which allows real-time error tracking with a great full-featured dashboard.

Bugsnag has a forever-free plan with up to 250 events per day, with no credit card required.

More services will be added in future versions.

API

• init(options) : Initiate a reporter service.
• name : Returns the name of the current reporting service.
• reporter : Returns the reporter service object.
• send(message, [meta]) : Send an error message.
• error(message, [meta]) : Send an error message.
• warning(message, [meta]) : Send a warning message.
• info(message, [meta]) : Send an info message.
• requestHandler(...) : The request handler middleware.
• errorHandler(...) : The error handler middleware.

License

The MIT License (MIT)

Copyright (c) 2017 Ion Suman [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.