React

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

If you prefer to follow video instructions, see How to Install the Sentry React SDK in 60 Seconds.

Install

Sentry captures data by using an SDK within your application’s runtime.

npm install --save @sentry/react

Configure

Configuration should happen as early as possible in your application's lifecycle.

Sentry supports multiple versions of React Router. See the React Router Integration docs for information on how to configure Sentry with React Router.

It is important to initialize Sentry as early as possible in your application. We recommend putting the Sentry initialization code into its own file and including that file as the first import in your application entry point:

import { useEffect } from "react";
import * as Sentry from "@sentry/react";
import {
  createRoutesFromChildren,
  matchRoutes,
  useLocation,
  useNavigationType,
} from "react-router-dom";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  integrations: [
    // See docs for support of different versions of variation of react router
    // https://docs.sentry.io/platforms/javascript/guides/react/configuration/integrations/react-router/
    Sentry.reactRouterV6BrowserTracingIntegration({
      useEffect,
      useLocation,
      useNavigationType,
      createRoutesFromChildren,
      matchRoutes,
    }),
    Sentry.replayIntegration(),
  ],

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for tracing.
  tracesSampleRate: 1.0,

  // Set `tracePropagationTargets` to control for which URLs trace propagation should be enabled
  tracePropagationTargets: [/^\//, /^https:\/\/yourserver\.io\/api/],

  // Capture Replay for 10% of all sessions,
  // plus for 100% of sessions with an error
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 1.0,
});

Include the Sentry initialization file as first import statement:

// Sentry initialization should be imported first!
import "./instrument";
import App from "./App";
import { createRoot } from "react-dom/client";

const container = document.getElementById(“app”);
const root = createRoot(container);
root.render(<App />);

Once this is done, all unhandled exceptions are automatically captured by Sentry.

React 19 Error Reporting

Starting with React 19, the createRoot and hydrateRoot methods from react-dom expose error hooks that are used to capture errors automatically. If you want to customize how errors are handled in specific error hooks, you can use the Sentry.reactErrorHandler function.

import { createRoot } from "react-dom/client";

const container = document.getElementById(“app”);
const root = createRoot(container, {
  // Callback called when an error is thrown and not caught by an ErrorBoundary.
  onUncaughtError: Sentry.reactErrorHandler((error, errorInfo) => {
    console.warn('Uncaught error', error, errorInfo.componentStack);
  }),
  // Callback called when React catches an error in an ErrorBoundary.
  onCaughtError: Sentry.reactErrorHandler(),
  // Callback called when React automatically recovers from errors.
  onRecoverableError: Sentry.reactErrorHandler(),
});
root.render();

These hooks apply to all React components mounted to the container passed onto createRoot/hydrateRoot. If you want more finely grained control over error handling, we recommend adding an ErrorBoundary component to your application.

Add Error Boundary

If you're using React 16 or above, you can use the Error Boundary component to automatically send Javascript errors from inside a component tree to Sentry, and set a fallback UI.

Set Up React Router

The React Router integration is designed to work with our tracing package. Learn more about set up for our React Router Integration.

Apply Redux

To apply Sentry to Redux, learn more about the Redux Integration and its options.

Add Readable Stack Traces to Errors

Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.

To fix this, upload your source maps to Sentry. The easiest way to do this is to use the Sentry Wizard:

npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

• Logging into Sentry and selecting a project
• Installing the necessary Sentry packages
• Configuring your build tool to generate and upload source maps
• Configuring your CI to upload source maps

For more information on source maps or for more options to upload them, head over to our Source Maps documentation.

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

<button
  type="button"
  onClick={() => {
    throw new Error("Sentry Test Error");
  }}
>
  Break the world
</button>;

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.