Skip to content
This repository

Airbrake Javascript

branch: master
README.md

Airbrake-JS

This is the JavaScript notifier for capturing errors in web browsers and reporting them to Airbrake.

Setup

Airbrake JavaScript notifier consists of 2 parts:

  • Notifier shim that collects exceptions until notifier is loaded. You are supposed to host it with your JavaScript files and modify as needed, e.g. add integration with framework of your choice.
  • Notifier itself loaded from our CDN.

Typical notifier setup looks like:

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="airbrake-shim.js" data-airbrake-project-id="FIXME" data-airbrake-project-key="FIXME" data-airbrake-environment-name="production"></script>
<script src="app.js"></script>

Note that notifier shim is loaded after jQuery but before application code. This way can setup integration with jQuery and shim is immediately available to be used in your code.

Look at examples for the notifier shim integrated with jQuery.

Note that the above example reflects a typical setup in a project using jQuery, however jQuery is not a dependency for Airbrake-JS. Airbrake-JS has no dependencies.

Basic Usage

The simplest method is to report errors directly:

try {
  // This will throw if the document has no head tag
  document.head.insertBefore(document.createElement("style"));
} catch(err) {
  Airbrake.push(err);
  throw err;
}

Alternatively you can wrap any code which may throw errors using the client's wrap method:

var wrapped = Airbrake.wrap(function() {
  // This will throw if the document has no head tag
  document.head.insertBefore(document.createElement("style"));
});
wrapped();

Advanced Usage

The notifier provides a few pieces of functionality to help reduce duplication when you report errors. In order to access this functionality, the full notifier needs to be loaded, not just the shim implelementation provided in the embed snippet.

Notifier onload

Fortunately, it's easy to register code to be run when the notifier loads. In the embed snippet, simply add a data-airbrake-onload attribute and specify the name of the function to be executed when the notifier is ready.

<script data-airbrake-onload="initAirbrake">
  function initAirbrake(client) {
    client.addSession({split_test: 10});
  }
</script>

An alternative way is to add onload property to the Airbrake shim:

Airbrake.onload = function(client) {
  client.setProject(projectId, projectKey);
}

Default Annotations

It's possible to annotate error notices with all sorts of useful information. Below, the various top-level interface methods are listed, along with their effects.

  • Airbrake.setEnvironmentName(string) Sets the environment name displayed alongside an error report.
  • Airbrake.addContext(object) Merges context information reported alongside all errors.
  • Airbrake.addEnvironment(object) Merges environment information about the application's environment.
  • Airbrake.addParams(object) Merges params information reported alongside all errors.
  • Airbrake.addSession(object) Merges session information reported alongside all errors.

Additionally, much of this information can be added to captured errors at the time they're captured by supplying it in the object being reported.

try {
  // This will throw if the document has no head tag
  document.head.insertBefore(document.createElement("style"));
} catch(err) {
  Airbrake.push({
    error: err,
    context: { component: 'style', userId: currentUser.id, userName: currentUser.name },
    environment: { navigator_vendor: window.navigator.vendor },
    params:  { search: document.location.search },
    session: { sessionid: sessionid }
  });
  throw err;
}

Error object

Instead of exception you can pass error object constructed manually. For example, window.onerror handler can look like:

window.onerror = function(message, file, line) {
  Airbrake.push({error: {message: message, fileName: file, lineNumber: line}});
}

Source map

In order to enable source map support you have to specify path to the source map file according to the source map specification. For example, airbrake.min.js has following line:

//# sourceMappingURL=airbrake.min.map

Filtering errors

There may be some errors thrown in your application that you're not interested in sending to Airbrake, such as errors thrown by 3rd-party libraries, or by browser extensions run by your users.

The Airbrake notifier makes it simple to ignore this chaff while still processing legitimate errors. Add filters to the notifier by providing filter functions to addFilter.

addFilter accepts the entire error notice to be sent to Airbrake, and provides access to the context, environment, params, and sessions values submitted with the notice, as well as the single-element errors array with its backtrace element and associated backtrace lines.

The return value of the filter function determines whether or not the error notice will be submitted.

  • If a falsey value is returned, the notice is suppressed.
  • If a truthy value is returned, the notice may be admissible for submission.

An error notice must pass all provided filters to be submitted.

// Here we suppress the notice if the top-level `session` key
// indicates the user is logged in as an admin
Airbrake.addFilter(function(notice) {
  // Suppress reports from admin sessions
  return !notice.session.admin;
});

Custom reporters

If you're interested in inspecting the information reported to Airbrake in your own code, you can register your own error reporter. Note that reporters added this way may be executed out-of-order.

In this example, reported errors are also logged to the console.

<script>
  Airbrake.addReporter(function(notice) {
    console.log(notice);
  });
</script>

Help

For help with using Airbrake and this notifier visit our support site.

Credits

Airbrake is maintained and funded by airbrake.io

Thank you to all the contributors.

The names and logos for Airbrake are trademarks of Rackspace Hosting Inc.

License

Airbrake is Copyright © 2008-2013 Rackspace Hosting Inc. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

Something went wrong with that request. Please try again.