This is a JavaScript client for the Sentry realtime event logging and aggregation platform.
Raven.js v1.0 and above requires Sentry v5.1.5 or later. If you are running an earlier version of Sentry, you should use Raven.js pre 1.0.
The stacktrace generation was inspired by the javascript-stacktrace project, and includes heavily modified portions of that project's code. The full and minified distribution files include parseUri and TraceKit.
Simply include the minified distribution file on your page:
<script type="text/javascript" src="//d3nslu0hdya83q.cloudfront.net/dist/1.0-beta10/raven.min.js"></script>First, you will need to configure Sentry to allow requests from the domain name that is hosting your JavaScript. Go to Account → Projects and select the project you want to configure. Under "Client Security", list the domains you want to access Sentry from.
Next, configure the client by passing the DSN as the first argument:
Raven.config('http://public@example.com/project-id');Or if you need to specify additional options:
Raven.config('http://public@example.com/project-id', {
logger: "yoursite.errors.javascript"
});logger - The logger name you wish to send with the message. Defaults to 'javascript'.
site - An optional site name to include with the message.
ignoreErrors - An array of error messages that should not get passed to Sentry.
ignoreUrls - An array of regular expressions matching urls which will not
get passed to Sentry. For example, you could set it to
[/ajax\.googleapis\.com\/ajax\/libs\/jquery/i] to ignore errors from the
Google Hosted jQuery library.
You can manually log errors like this:
try {
errorThrowingCode();
} catch(err) {
Raven.captureException(err);
// Handle error...
}To install error capturing globally, you need to install Raven.
Raven.install();
// or
Raven.config(...).install();Raven.setUser({
email: 'matt@example.com',
id: '123'
})setUser accepts an arbitrary object of data. The data is passed as-is.
If you need to unset the user object, you can just call setUser without an argument. This would be useful in a web app where the user is logging in/out without refreshing the page.
Raven.setUser();If your application loads a significant amount of JavaScript you may want to record errors which occur before the raven JavaScript has loaded, especially as this allows you to avoid the raven.js request temporarily delaying a user-visible resource.
This example installs a primitive error handler as early as possible — typically a <script> in
the HTML <head> — which will be replaced as soon as Raven loads:
<html>
<head>
<script>
var _ravenQueue = [];
window.onerror = function(message, file, lineNumber) {
var msg = lineNumber ? message + " at " + lineNumber : message;
_ravenQueue.push({message: msg, culprit: file});
}
</script>
</head>
<body>
…
<script src="{% static "external/raven-0.7.1.min.js" %}"></script>
<script>
Raven.config("{{ RAVEN_DSN|safe }}");
window.onerror = Raven.process;
for (var i = 0; i < _ravenQueue.length; i++) {
Raven.send(_ravenQueue[i]);
};
</script>
</body>
</html>The captureException and captureMessage functions allow an additional options argument which
you can use to pass various data (such as tags):
Raven.captureMessage('My error', {
tags: {key: "value"}
extra: {
color: "red",
something_neat: [1, 2, 3, 4]
}
});Raven requires you to set up the CORS headers within Sentry. These headers should include the base URI of which you plan to send events from.
For example, if you are using raven-js on http://example.com, you should list
http://example.com in your origins configuration. If you only
wanted to allow events from /foo, set the value to
http://example.com/foo.
- Bug Tracker
- IRC (chat.freenode.net, #sentry)