The following documentation is for Raygun4js V1 only. Raygun4js V1 should only be used by legacy customers or for applications that can't use asynchronous loading, such as mobile apps in webviews (Cordova etc).
Go to V2 documentation.
Step 1
Load Raygun4JS directly from Raygun's content delivery network:
<script type="text/javascript" src="//cdn.raygun.io/raygun4js/raygun.min.js"></script>It is available using HTTP or HTTPS.
The most current release is always available in /raygun4js/, while previous releases are available as subdirectories, for instance /raygun4js/1.14.0/raygun.js. The vanilla versions are also available as below.
Note that the CDN's current unversioned release (/raygun4js/raygun.js) may lag behind the package managers by around a week, to ensure stability. When a new version is released, this will be available immediately from its versioned folder as above.
Step 2
Add the following lines to your JS site code and paste in your API key (from your Raygun dashboard), to set up the provider to automatically send errors to your Raygun:
<script type="text/javascript">
Raygun.init('yourApiKey', {
// Setup options here - see Initialization Options below
});
Raygun.attach();
</script>This will configure the provider to send to your Raygun app, and to automatically send all unhandled errors.
That's it for the basic setup! See Usage below for more info on how to send errors.
For mutating the provider after initial setup, you can interact with the global Raygun object after page load. By example with plain jQuery:
$(window).load(function () {
Raygun.withTags(["Loaded"]);
});The Raygun4JS library can be interacted with in two ways - the V1 API and the V2 API. The V1 API is available as 'public' functions on the global Raygun object, and is intended to be used to control the provider during runtime. Legacy setup methods remain on the V1 API for backwards compatibility with 1.x releases. The V2 API is made available when using a snippet, and is used to asynchronously configure the provider during onLoad. This is the recommended approach for new setups.
If you are installing the provider locally using a package manager or manually, you can either use the V2 API by adding the snippet and replace the second-last parameter with the URL of your hosted version of the script, or use the V1 API. The snippet/V2 approach does not support the script being bundled with other vendor scripts, but the V1 API does.
Note that using these methods will not catch errors thrown while the page is loading. The script needs to be referenced before your other site/app scripts, and will block the page load while it is being downloaded.
Run bower install raygun4js
npm install raygun4js --save
This lets you require the library with tools such as Webpack or Browserify.
Visual Studio users can get it by opening the Package Manager Console and typing Install-Package raygun4js
Download the production version or the development version. You can also download a version without the jQuery hooks if you are not using jQuery or you wish to provide your own hooks. Get this as a production version or development version.
To send errors manually:
Raygun.init("apikey");
try {
throw new Error("Description of the error");
}
catch(e) {
Raygun.send(e);
}In order to get stack traces, you need to wrap your code in a try/catch block like above. Otherwise the error hits window.onerror handler and may only contain the error message, line number, and column number.
You also need to throw errors with throw new Error('foo') instead of throw 'foo'.
To automatically catch and send unhandled errors, you can attach the automatic window.onerror handler callback:
Raygun.attach();If you need to detach it (this will disable automatic unhandled error sending):
Raygun.detach();This provider supports two APIs for interacting with the provider, V1 and V2. For initial setup, all functions are interchangeable and available using either method. The public functions available on the global Raygun object can be accessed by calling Raygun.functionName(value) or rg4js(functionName, value) (with the exception of send()).
V1
V1 remains unchanged from previous versions, and all current code is backwards compatible. This API is of the form where functions can be called on the global Raygun object, for instance Raygun.init('your_apikey').attach().
The V1 API is available as 'public' functions on the global Raygun object, and is intended to be used to control the provider during runtime.
V1 supports the script being bundled with other vendor scripts, and V2 does not.
V2
V2 lets you asynchronously configure the provider during onLoad. A new global function is made available, rg4js() (configurable), which accepts parameters that are applied to the provider once it is download asynchronously. This API is of the form rg4js('init', 'your_apikey'). This is the recommended approach for new setups.
Using the snippet to fetch the script from the CDN, along with the V2 API, is superior as errors that occur while the page is loading but Raygun4JS hasn't been downloaded will now be caught. With any of the synchronous methods these will not be sent to Raygun, and the script load will block the page load. Thus, you should use the snippet, the CDN and the V2 API for the best experience for your users.
If you are installing the provider locally using a package manager or manually, you can either use the V2 API by adding the snippet and replace the second-last parameter with the URL of your hosted version of the script.
To configure the provider, call this and pass in an options object:
Raygun.init('your_apikey', {
// Add some or all of the options below
});The second parameter should contain one or more of these keys and a value to customize the behavior:
ignoreAjaxAbort - User-aborted Ajax calls result in errors - if this option is true, these will not be sent.
ignoreAjaxError - Ajax requests that return error codes will not be sent as errors to Raygun if this options is true.
debugMode - Raygun4JS will log to the console when sending errors.
wrapAsynchronousCallbacks - if set to false, async callback functions triggered by setTimeout/setInterval will not be wrapped when attach() is called. Defaults to true
ignore3rdPartyErrors - ignores any errors that have no stack trace information. This will discard any errors that occur completely
within 3rd party scripts - if code loaded from the current domain called the 3rd party function, it will have at least one stack line
and will still be sent.
excludedHostnames - Prevents errors from being sent from certain hostnames (domains) by providing an array of strings or RegExp
objects (for partial matches). Each should match the hostname or TLD that you want to exclude. Note that protocols are not tested.
excludedUserAgents - Prevents errors from being sent from certain user agents by providing an array of strings. This is very helpful to exclude errors reported by certain browsers or test automation with CasperJS, PhantomJS or any other testing utility that sends a custom user agent. If a part of the client's navigator.userAgent matches one of the given strings in the array, then the client will be excluded from error reporting.
disableCrashReporting - Prevent uncaught errors from being sent.
disablePulse - Prevent real user monitoring events from being sent.
apiEndpoint - A string URI containing the protocol, domain and port (optional) where all payloads will be sent to. This can be used to proxy payloads to the Raygun API through your own server. When not set this defaults internally to the Raygun API, and for most usages you won't need to set this.
pulseMaxVirtualPageDuration - The maximum time a virtual page can be considered viewed, in milliseconds (defaults to 30 minutes).
pulseIgnoreUrlCasing - Ignore URL casing when sending data to RUM.
An example:
Raygun.init('apikey', {
ignoreAjaxAbort: true,
ignoreAjaxError: true,
debugMode: true,
ignore3rdPartyErrors: false,
wrapAsynchronousCallbacks: true,
excludedHostnames: ['\.local'],
excludedUserAgents: ['Mosaic'],
disableErrorTracking: false,
disablePulse: false,
pulseMaxVirtualPageDuration: 1800000,
pulseIgnoreUrlCasing: false
})
.attach(); // This enables Crash Reporting by attaching the automatic window.onerror handler callbackRaygun RUM supports client-side SPAs through the trackEvent function:
Raygun.trackEvent('pageView', { path: '/' + foo });When a route or view change is triggered in your SPA, this function should be called with pageView as the first parameter and an object with a path key set to a path representing the new view or route. RUM will collect up all timing information that is available and send it to the dashboard. These are then viewable as 'virtual pages'.
The following are a couple of configuration examples that you can use or adapt for your client-side view library/framework. Naturally, if you are using a more full-featured routing system, you should trigger a pageView inside there when the route changes.
jQuery
$(window).hashchange(function() {
Raygun.trackEvent('pageView', {
path: '/' + location.hash
});
});AngularJS
$scope.$on('$routeChangeSuccess', function () {
Raygun.trackEvent('pageView', {
path: '/' + $scope.area
});
});You can now have multiple Raygun objects in global scope. This lets you set them up with different API keys for instance, and allow you to send different errors to more than one application in the Raygun web app.
To create a new Raygun object and use it call:
var secondRaygun = Raygun.constructNewRaygun();
secondRaygun.init('apikey');
secondRaygun.send(...);Only one Raygun object can be attached as the window.onerror handler at one time, as onerror can only be bound to one function at once. Whichever Raygun object had attach() called on it last will handle the unhandle errors for the page. Note that you should use the V1 API to send using the second Raygun object, and it should be created and called once the page is loaded (for instance in an onload callback).
If you already have an variable called Raygun attached to window, you can prevent the provider from overwriting this by enabling NoConflict mode:
Raygun.noConflict();Raygun.onBeforeSend(function (payload) {
return payload;
});Call this function and pass in a function which takes one parameter (see the example below). This callback function will be called immediately before the payload is sent. The one parameter it gets will be the payload that is about to be sent. Thus from your function you can inspect the payload and decide whether or not to send it.
From the supplied function, you should return either the payload (intact or mutated as per your needs), or false.
If your function returns a truthy object, Raygun4JS will attempt to send it as supplied. Thus, you can mutate it as per your needs - preferably only the values if you wish to filter out data that is not taken care of by filterSensitiveData(). You can also of course return it as supplied.
If, after inspecting the payload, you wish to discard it and abort the send to Raygun, simply return false.
By example:
var myBeforeSend = function (payload) {
console.log(payload); // Modify the payload here if necessary
return payload; // Return false here to abort the send
}
Raygun.onBeforeSend(myBeforeSend);Raygun.onAfterSend(function (xhrResponse) {
// Inspect the XHR response here
});Call this function and pass in a function which takes one parameter (see the example below). This callback function will be immediately called after the XHR request for a Crash Reporting or RUM event responds successfully, or errors out (its onerror was called). You can inspect the one parameter, which is the XHR object containing the HTTP response data.
Raygun.onBeforeXHR(function (xhr) {
// Mutate the xhr parameter as per your needs
});Call this function when you want control over the XmlHttpRequest object that is used to send error payloads to the API. Pass in a callback that receives one parameter (which is the XHR object). Your callback will be called after the XHR object is opened, immediately before it is sent.
For instance, you can use this to add custom HTTP headers.
You can control custom grouping for error instances by passing in a callback. This will override the automatic grouping and be used to group error instances together. Errors with the same key will be placed within the same error group. The callback's signature should take in the error payload, stackTrace and options and return a string, ideally 64 characters or less. If the callback returns null or or a non-string the error will be grouped using Raygun's server side grouping logic (this can be useful if you only wish to use custom grouping for a subset of your errors).
var groupingKeyCallback = function (payload, stackTrace, options) {
// Inspect the above parameters and return a hash derived from the properties you want
return payload.Details.Error.Message; // Naive message-based grouping only
};
Raygun.groupingKey(groupingKeyCallback);The Raygun object has a withCustomData() function where you can pass in JavaScript objects that will be sent with each error that occurs. This allows you to provide any useful data that is global or in scope.
There are two ways to do this:
Custom data variables (objects, arrays etc) can be added by calling the withCustomData function on the Raygun object:
Raygun.withCustomData({ foo: 'bar' });During a send:
You can also pass custom data with manual send calls, with the second parameter. This lets you add variables that are in scope or global when handled in catch blocks. For example:
Raygun.send(err, [{ foo: 'bar' }]);To send the state of variables at the time an error occurs, you can pass withCustomData a callback function. This needs to return an object. By example:
var desiredNum = 1;
function getMyData() {
return { num: desiredNum };
}
Raygun.withCustomData(getMyData);When an error is thrown, the custom data will contain a 'num' key with a value of 2.
getMyData will be called when Raygun4JS is about to send an error, which will construct the custom data. This will be merged with any custom data provided on a Raygun.send() call.
The Raygun dashboard can also display tags for errors. These are arrays of strings or Numbers. This is done similar to the above custom data, like so:
On initialization:
Raygun.init('apikey').withTags(array)Or
Raygun.withTags(['tag1', 'tag2']);Pass tags in as the third parameter:
Raygun.send(err, null, ['tag']];As above for custom data, withTags can now also accept a callback function. This will be called when the provider is about to send, to construct the tags. The function you pass to withTags should return an array (ideally of strings/Numbers/Dates).
By default, Raygun4JS assigns a unique anonymous ID for the current user. This is stored as a cookie. If the current user changes, to reset it and assign a new ID you can call:
Raygun.resetAnonymousUser();Raygun.init('apikey', { disableAnonymousUserTracking: true });You can provide additional information about the currently logged in user to Raygun by calling:
Raygun.setUser(
'[email protected]', // identifier
false, // isAnonymous
'[email protected]', // email
'Foo Bar', // fullName
'Foo', // firstName
'BAE62917-ACE8-ab3D-9287-B6A33B8E8C55' //uuid
);Only identifier or the first parameter is required. This method takes additional parameters that are used when reporting over the affected users. the full method signature is:
setUser: function (user, isAnonymous, email, fullName, firstName, uuid)user is the user identifier. This will be used to uniquely identify the user within Raygun. This is the only required parameter, but is only required if you are using user tracking.
isAnonymous is a bool indicating whether the user is anonymous or actually has a user account. Even if this is set to true, you should still give the user a unique identifier of some kind.
email is the user's email address.
fullName is the user's full name.
firstName is the user's first or preferred name.
uuid is the identifier of the device the app is running on. This could be used to correlate user accounts over multiple machines.
This will be transmitted with each message. A count of unique users will appear on the dashboard in the individual error view. If you provide an email address, the user's Gravatar will be displayed (if they have one). This method is optional; if it is not called no user tracking will be performed. Note that if the user context changes (such as in an SPA), you should call this method again to update it.
Resetting the user
You can now pass in empty strings (or false to isAnonymous) to reset the current user for login/logout scenarios.
You can set a version for your app by calling:
Raygun.setVersion('1.0.0.0');This will allow you to filter the errors in the dashboard by that version. You can also select only the latest version, to ignore errors that were triggered by ancient versions of your code. The parameter should be a string in the format x.x.x if you want to get the version sorting in Raygun to work nicely, where x is a non-negative integer.
You can blacklist keys to prevent their values from being sent it the payload by providing an array of key names:
Raygun.filterSensitiveData(['password', 'credit_card']);If any key matches one in the input array, its value will be replaced with [removed by filter].
You can also pass RegExp objects in the array to filterSensitiveData, for controllable matching of keys:
var creditCardDataRegex = /credit\D*/; // Remove any keys that begin with 'credit'
Raygun.filterSensitiveData([creditCardDataRegex]);By default this is applied to the UserCustomData object only (legacy behavior). To apply this to any key-value pair, you can change the filtering scope:
Raygun.setFilterScope('all'); // Filter any key in the payload
Raygun.setFilterScope('customData'); // Just filter the custom data (default)Raygun4JS now features source maps support through the transmission of column numbers for errors, where available. This is confirmed to work in recent version of Chrome, Safari and Opera, and IE 10 and 11. See the Raygun souce maps documentation for more information.
The provider has a feature where if errors are caught when there is no network activity they can be saved (in Local Storage). When an error arrives and connectivity is regained, previously saved errors are then sent. This is useful in environments like WinJS, where a mobile device's internet connection is not constant.
Offline saving is disabled by default. To change it:
Raygun.saveIfOffline(true);If an error is caught and no network connectivity is available (the Raygun API cannot be reached), or if the request times out after 10s, the error will be saved to LocalStorage. This is confirmed to work on Chrome, Firefox, IE10/11, Opera and WinJS.
Limited support is available for IE 8 and 9 - errors will only be saved if the request times out.
Browsers have varying behavior for errors that occur in scripts located on domains that are not the origin. Many of these will be listed in Raygun as 'Script Error', or will contain junk stack traces. You can filter out these errors by settings this:
Raygun.init('apikey', { ignore3rdPartyErrors: true });There is also an option to whitelist domains which you do want to allow transmission of errors to Raygun, which accepts the domains as an array of strings:
Raygun.init('apikey', { ignore3rdPartyErrors: true }).whitelistCrossOriginDomains(['code.jquery.com']);This can be used to allow errors from remote sites and CDNs.
The provider will default to attempt to send errors from subdomains - for instance if the page is loaded from foo.com, and a script is loaded from cdn.foo.com, that error will be transmitted on a best-effort basis.
To get full stack traces from cross-origin domains or subdomains, these requirements should be met:
-
The remote domain should have
Access-Control-Allow-Originset (to include the domain where raygun4js is loaded from). -
For Chrome the
scripttag must also havecrossOrigin="Anonymous"set. -
Recent versions of Firefox (>= 31) will transmit errors from remote domains will full stack traces if the header is set (
crossOriginon script tag not needed).
In Chrome, if the origin script tag and remote domain do not meet these requirements the cross-origin error will not be sent.
Other browsers may send on a best-effort basis (version dependent) if some data is available but potentially without a useful stacktrace. The provider will cancel the send if no data is available.
Depending on what browser your users are running, the above properties may or may not have an effect. This sums up the situation as of writing:
- Chrome 30+
- Firefox 13+
- Opera 12.50+
- Safari (at least 6+)
In these browsers, if the script attribute is present, the HTTP header will need to be also present, otherwise the script will be blocked.
Firefox has additional behavior for RuntimeErrors. These will be provided to window.onerror regardless of the two properties, as these aren’t considered a security risk. SyntaxErrors, however, will be blocked in both Gecko and WebKit browsers, if crossorigin is present but the associated cross-origin domain lacks the header.
- Internet Explorer <= 10
Errors will be reported with all available data in IE 10 and below.
- Internet Explorer 11+
Due to browser API and security limitations, in cases where the message is 'Script error', only one stack trace frame may be present. In this scenario, the line number may not reflect the actual position where the original error was thrown.
For more information, check out this blog post on CORS requirements for Script Errors.
You can hook failed Ajax requests with $http in AngularJS by providing an Interceptor that sends to Raygun on error. One possible simple implementation:
$httpProvider.interceptors.push(function($q, dependency1, dependency2) {
return {
'requestError': function(rejection) {
Raygun.send(new Error('Failed $http request'), { rejection : rejection });
},
'responseError': function(rejection) {
Raygun.send(new Error('Failed $http response'), { rejection : rejection });
}
};
});For more information, see the official docs under Interceptors.