Need private packages and team management tools?Check out npm Teams »

@pager/hapi-raven

10.0.0 • Public • Published

hapi-raven

Build Status Code Climate

A Hapi plugin for sending exceptions to Sentry through Raven.

This is a fork of @bendrucker's hapi-raven package tweaked to better adjust to Pager's requirements.

Setup

Options:

  • dsn: Your Sentry DSN (required)
  • client: An options object that will be passed directly to the client as its second argument (optional)
  • patchGlobal: Boolean value that will trigger raven's patchGlobal functionality (optional)

Note that DSN configuration using process.env is not supported. If you wish to replicate the default environment variable behavior, you'll need to supply the value directly:

server.register({
  register: require('hapi-raven'),
  options: {
    dsn: process.env.SENTRY_DSN,
    patchGlobal: true,
    captureUnhandledRejections: true
  }
});

Usage

Once you register the plugin on a server, logging will happen automatically.

The plugin listens for 'request-error' events which are emitted any time reply is called with an error where err.isBoom === false. Note that the 'request-error' event is emitted for all thrown exceptions and passed errors that are not Boom errors. Transforming an error at an extension point (e.g. 'onPostHandler' or 'onPreResponse') into a Boom error will not prevent the event from being emitted on response.


Boom Non-500 Errors are Not Logged

server.route({
  method: 'GET',
  path: '/',
  handler: function (request, reply) {
    reply(Hapi.error.notFound());
  }
});
 
server.inject('/', function (response) {
  // nothing was logged
});

500 Errors are Logged

server.route({
  method: 'GET',
  path: '/throw',
  handler: function (request, reply) {
    throw new Error();
  }
});
 
server.inject('/throw', function (response) {
  // thrown error is logged to Sentry
});
server.route({
  method: 'GET',
  path: '/reply',
  handler: function (request, reply) {
    reply(new Error());
  }
});
 
server.inject('/throw', function (response) {
  // passed error is logged to Sentry
});

For convenience, hapi-raven exposes the node-raven client on your server as server.plugins.raven.client. If you want to capture errors other than those raised by 'request-error', you can use the client directly inside an 'onPreResponse' extension point.

Example: Capture all 404 errors

server.ext('onPreResponse', function (request, reply) {
  if (request.isBoom && request.response.statusCode === 404) {
    server.plugins.raven.client.captureError(request.response);
  }
});

Install

npm i @pager/hapi-raven

DownloadsWeekly Downloads

48

Version

10.0.0

License

MIT

Unpacked Size

6.58 kB

Total Files

4

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar