React

On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.

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

Install

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

Copied
npm install --save @sentry/react

Configure

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

Copied
import { createRoot } from "react-dom/client";
import React from "react";
import * as Sentry from "@sentry/react";
import App from "./App";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  integrations: [new Sentry.BrowserTracing(), new Sentry.Replay()],

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for performance monitoring.
  // We recommend adjusting this value in production
  tracesSampleRate: 1.0,

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

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

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

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

tracingThe process of logging the events that took place during a request, often across multiple services.
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.

Verify

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

Copied
return <button onClick={() => methodDoesNotExist()}>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.

Add Readable Stack Traces to Errors

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

To fix this, head over to our source maps documentation where you'll learn how to upload source maps, so you can make sense of your stack traces.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").