Sentry transport + formatter for Bristol
Bristol transport + formatter to send events and errors to Sentry.
Installation
You will need to install this package, as well as raven
, which is the Sentry node.js client.
npm install --save bristol-sentry raven bristol
Getting started
const bristol = require('bristol');
const raven = require('raven');
const bristolSentry = require('bristol-sentry');
const target = bristolSentry({ client: new raven.Client('<your sentry dsn>') });
bristol.addTarget(target).withFormatter(bristolSentry.formatter);
bristol.debug('here come dat boi');
bristol.info('watch him rollin watch him go');
bristol.warn('he be rollin', { rollinWhere: 'down the street' });
bristol.error(new Error('o shit waddup'));
IMPORTANT! Sentry differentiates between errors and messages. An attempt to log an Error
object will trigger a captureException
, whereas anything else triggers a captureMessage
.
Since captureException
does not store any message other than the one from the error, bristol-sentry
will prepend the message (if any) to the extra
array.
Contributing
You will need a Sentry DSN to run the tests! Sign up for an account at Sentry.
You can either add it to your own environment (SENTRY_DSN
), or you can create an env.yaml
in the repository root, and add the following:
test:
SENTRY_DSN: <your dsn>
Usefull npm run scripts:
npm run test
: Runs tests oncenpm run test-watch
: Runs tests in watch-modenpm run lint
: Lints the code oncenpm run lint-watch
: Lints the code in watch-modenpm run cover
: Runs code coverage using istanbul
npm run coveralls
: Used by coveralls
Author
Jeff Hansen - @Jeffijoe