React

Crash Reporting for React applications with Raygun is available using the Raygun4JS provider.

Raygun4JS is a library you can easily add to your website and web applications which allows you to then monitor JavaScript errors.

Once Raygun is installed, it will automatically start monitoring your application for errors with Crash Reporting.


There are two installation methods for Raygun4JS. Through a package manager like NPM and Yarn, or through our CDN.

Install Raygun via NPM.

NPM

npm install raygun4js

Yarn

yarn add raygun4js

Bun

bun add raygun4js

Add the following snippet to the beginning of the <head> tag within your markup. Please include this snippet before any other <script> tag references are made to ensure that Raygun has the best chance to capture all error events on the page.

<script type="text/javascript">
  !function(a,b,c,d,e,f,g,h){a.RaygunObject=e,a[e]=a[e]||function(){
  (a[e].o=a[e].o||[]).push(arguments)},f=b.createElement(c),g=b.getElementsByTagName(c)[0],
  f.async=1,f.src=d,g.parentNode.insertBefore(f,g),h=a.onerror,a.onerror=function(b,c,d,f,g){
  h&&h(b,c,d,f,g),g||(g=new Error(b)),a[e].q=a[e].q||[],a[e].q.push({
  e:g})}}(window,document,"script","//cdn.raygun.io/raygun4js/raygun.min.js","rg4js");
</script>

The above snippet will fetch the Raygun4JS script from our CDN asynchronously so it doesn't block the page load. It will also catch errors that are thrown while the page is loading, and send them when the script is ready.

Alternatively, you can download the production script (minified) or the development script (full source). Note: If you encounter a situation where no events are appearing within Raygun, you may need to hard code the protocol so that the CDN matches your hosting environment. This could look like one of the following -

  • https://cdn.raygun.io/raygun4js/raygun.min.js
  • http://cdn.raygun.io/raygun4js/raygun.min.js

This will be in replacement of //cdn.raygun.io/raygun4js/raygun.min.js.


Depending on how you have added Raygun4js in your application, setting up crash reporting will be different. Below are examples for the two most common use cases. These snippets will set up Raygun4js to automatically send all unhandled JavaScript errors to Raygun.

Add the following lines underneath the previous code in Step 1.

<script type="text/javascript">
  rg4js('apiKey', 'paste_your_api_key_here');
  rg4js('enableCrashReporting', true);
</script>

Import the Raygun4JS provider into your application inside of App.js (or equivalent for your framework) and enable Crash Reporting.

import rg4js from 'raygun4js';

rg4js('apiKey', 'paste_your_api_key_here');
rg4js('enableCrashReporting', true);

Raygun should now be setup! Send a test exception using the snippet below to test your installation. Once we detect your first error event, your Raygun app will automatically update.

throw new Error("This is a test exception");

For advanced setup instructions please refer to the Advanced Features documentation page.


For troubleshooting tips please refer to the Troubleshooting documentation page.


The provider is open source and available at the Raygun4js repository.