JavaScript

Raven.js is the official browser JavaScript client for Sentry. It automatically reports uncaught JavaScript exceptions triggered from a browser environment, and provides a rich API for reporting your own errors.

Installation

The easiest way to load Raven.js is to load it directly from our CDN. This script tag should be included after other libraries are loaded, but before your main application code (e.g. app.js):

<script
  src="https://cdn.ravenjs.com/3.26.4/raven.min.js"
  crossorigin="anonymous"
></script>

For installation using npm or other package managers, see Installation.

Configuring the Client

Next you need to configure Raven.js to use your Sentry DSN:

Raven.config("https://examplePublicKey@o0.ingest.sentry.io/0").install();

It is additionally recommended (but not required) to wrap your application start using Raven.context. This can help surface additional errors in some execution contexts.

Raven.context(function () {
  initMyApp();
});

At this point, Raven is ready to capture any uncaught exception.

Once you have Raven up and running, we highly recommended you check out Configuration and Usage.

Manually Reporting Errors

By default, Raven makes a best effort to capture any uncaught exception.

To report errors manually, wrap potentially problematic code with a try...catch block and call Raven.captureException:

try {
  doSomething(a[0]);
} catch (e) {
  Raven.captureException(e);
}

There are more ways to report errors. For a complete guide on this see Reporting Errors Correctly.

Adding Context

While a user is logged in, you can tell Sentry to associate errors with user data. This data is then submitted with each error which allows you to figure out which users are affected.

Raven.setUserContext({
  email: "matt@example.com",
  id: "123",
});

If at any point, the user becomes unauthenticated, you can call Raven.setUserContext() with no arguments to remove their data.

Other similar methods are Raven.setExtraContext and Raven.setTagsContext as well as Raven.context. See Passing Additional Data for more info.

Breadcrumbs

Breadcrumbs are browser and application lifecycle events that are helpful in understanding the state of the application leading up to a crash.

By default, Raven.js instruments browser built-ins and DOM events to automatically collect a few useful breadcrumbs for you:

• XMLHttpRequests
• URL / address bar changes
• UI clicks and keypress DOM events
• console log statements
• previous errors

You can also record your own breadcrumbs. For more information, see Recording Breadcrumbs.

Dealing with Minified Source Code

Raven and Sentry support Source Maps. If you provide source maps in addition to your minified files that data becomes available in Sentry. For more information see Source Maps.

Browser Compatibility

Raven.js supports all major browsers. In older browsers, error reports collected by Raven.js may have a degraded level of detail – for example, missing stack trace data or missing source code column numbers.

The table below describes what features are available in each supported browser:

For browsers with Web Worker support, Raven.js is designed to work inside a Web Worker context.

For unlisted browsers (e.g. IE7), Raven.js is designed to fail gracefully. Including it on your page should have no effect on your page; it will just not collect and report uncaught exceptions.

Deep Dive

For more detailed information about how to get most out of Raven.js there is additional documentation available that covers all the rest:

• Installation
• Configuration
• Usage
• Integrations
  • AngularJS
  • Angular
  • Backbone
  • Ember
  • React
  • Vue.js (2.0)
• Source Maps
• Tips and Tricks

Resources:

• Downloads and CDN
• Bug Tracker
• GitHub Project