Node.js client for airbrake.io
npm install airbrake
The common use case for this module is to catch all
events on the
process object and send them to airbrake:
var airbrake = require'airbrake'createClient"your api key";airbrakehandleExceptions;throw 'I am an uncaught exception';
Please note that the above will re-throw the exception after it has been successfully delivered to airbrake, caushing your process to exit with status 1.
If you want more control over the delivery of your errors, you can also manually submit errors to airbrake.
var airbrake = require'airbrake'createClient"your api key";var err = 'Something went terribly wrong';airbrakenotifyerrif err throw err;// Error has been delivered, url links to the error in airbrake;
A custom error handler will need to be set for Express:
var airbrake = require'airbrake'createClient"your api key";appuseairbrakeexpressHandler
var airbrake = require'airbrake'createClient"your api key";app.errorairbrakeexpressHandler
This screenshot shows an airbrake error send from this module:
- Automatically add
process.envas well as other information when sending notifications
- Detect and fix circular references in error context information
- Support for all features of the 2.1 notification API
- Support for long-stack-traces
- Optional auto-handler for
- Provides notification url linking to airbrake in
- Timeout airbrake requests after 30 seconds, you never know
notify() method automatically adds the following context information to
each delivered error:
- error.class: (
err.typestring if set, or
- error.message: (
- error.backtrace: (
err.stackas parsed by stack-trace)
- request.url: (
- request.component: (
err.componentstring if set);
- request.action: (
err.actionstring if set);
- request.cgi-data: (
process.env, merged all other properties of
- request.params: (
err.paramsobject if set)
- request.session: (
err.sessionobject if set)
- server-environment.project-root: (
airbrake.projectRootstring if set)
- server-environment.environment-name: (
- server-environment.app-version: (`airbrake.appVersion string if set)
- server-environment.hostname: (
airbrake.hostnamestring if set)
You can add additional context information by modifying the error properties listed above:
var airbrake = require'airbrake'createClient"your api key";var http = require'http';httpcreateServerif reqheaders'X-Secret' !== 'my secret'var err = '403 - Permission denied';reqwriteHead403;reqenderrmessage;errurl = requrl;errparams = ip: reqsocketremoteAddress;airbrakenotifyerr;;
uncaughtException events cannot be traced back to particular
requests, so you should still try to handle errors where they occur.
In some scenarios you might want to filter some context to never show up in Airbrake. For example you might have a private key loaded in your environment memory, or your user has some critical data in his session, and you want to hide that.
This can be done by hooking into the
'vars' event like so:
airbrakeon'vars'if type === 'cgi-data'delete varsSECRET;;
This client supports airbrake's deployment tracking:
var airbrake = require'airbrake'createClient"your api key";var deployment =rev: '98103a8fa850d5eaf3666e419d8a0a93e535b1b2'repo: 'email@example.com:felixge/node-airbrake.git';airbraketrackDeploymentdeploymentif errthrow err;console.log'Tracked deployment of %s to %s' paramsrev paramsenv;;
Check out the
airbrake.trackDeployment() API docs below for a list of all
Returns a new Airbrake instance.
The API key to use.
The name of the server environment this is running in.
The base url for errors. If
err.url is not set,
airbrake.host is used
err.url is a relative url starting with
'/', it is appended
err.url is an absolute url,
airbrake.host is ignored.
The root directory of this project.
The version of this app. Set to a semantic version number, or leave unset.
The protocol to use.
Do not post to Airbrake when running in these environments.
The timeout after which to give up trying to notify airbrake in ms.
Additional request options that are merged with the default set of options that are passed to
process.on('uncaughtException') listener. When an uncaught
exception occurs, the error is send to airbrake, and then re-thrown to
kill the process.
Sends the given
err to airbrake.
The callback parameter receives two arguments,
err is set if
the delivery to airbrake failed.
cb is given, and the delivery fails, an
error event is emitted. If
there is no listener for this event, node will kill the process as well. This
is done to avoid silent error delivery failure.
Notifies airbrake about a deployment.
params is an object with the following
env:The environment being deployed, defaults to
user:The user doing the deployment, defaults to
repo:The github url of this repository. Defaults to
rev:The revision of this deployment. Defaults to
Besides bug fixes, I'd be happy to accept patches for:
- Automatically parsing
revfrom the local git repository when calling
airbrake.trackDeployment(). This can be done via
exec(), but must not be done when specifying
revby hand, or if they are set to
If you have other feature ideas, please open an issue first, so we can discuss it.
airbrake is licensed under the MIT license.