Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 3.97 KB

README.md

File metadata and controls

115 lines (76 loc) · 3.97 KB
Raw

Raven.js

Build Status

This is a JavaScript client for the Sentry realtime event logging and aggregation platform.

Raven.js v0.4 and above requires Sentry v4.1 or later. If you are running an earlier version of Sentry, you should use Raven.js v0.3.

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.

Install

Download the latest version here.

Raven.js requires either jQuery (>1.5) or Zepto.js (>0.8).

First include jQuery or Zepto in your document's head. Then include the minified distribution file from the 'dist' directory:

<script type="text/javascript" src="js/jquery.js"></script>
<script type="text/javascript" src="js/raven-0.5.3.min.js"></script>

Configuration

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.

Client Security

Next, configure the client by passing the DSN as the first argument:

Raven.config('http://[email protected]/project-id');

Or if you need to specify additional options:

Raven.config({
    "publicKey": "e89652ec30b94d9db6ea6f28580ab499",
    "servers": ["http://your.sentryserver.com/"],
    "projectId": "project-id",
    "logger": "yoursite.errors.javascript"
});

publicKey - The desired user's public key.

servers - (required) An array of servers to send exception info to. This should be just the base URL. For example, if your API store URL is "http://mysentry.com/api/4/store/", then the base URL is "http://mysentry.com/" and the projectId is 4. This is a backwards-incompatible change introduced in v0.5.

projectId - The id of the project to log the exception to. Defaults to '1'.

logger - The logger name you wish to send with the message. Defaults to 'javascript'.

site - An optional site name to include with the message.

fetchHeaders - Generate a HEAD request to gather header information to send with the message. This defaults to 'false' because it doesn't work on cross-domain requests.

signatureUrl - Use a server side url to get a signature for the message. See below in the "Security" section for more details.

ignoreErrors - An array of error messages that should not get passed to sentry. You'll probably want to set this to ["Script error."].

Logging Errors

You can manually log errors like this:

try {
    errorThrowingCode();
} catch(err) {
    Raven.captureException(err);
    // Handle error...
}

On browsers that support it, you can attach the Raven.process method directly to the window.onerror attribute:

window.onerror = Raven.process;

This should be harmless on browsers that don't support window.onerror, and in those cases it will simply do nothing.

Security

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.

Support