React
Sentry's React SDK enables automatic reporting of errors and exceptions. The SDK is a wrapper around @sentry/browser, with added functionality related to React. All methods available in @sentry/browser can be imported from @sentry/react.
On this page, we get you up and running with Sentry's SDK.
Don't already have an account and Sentry
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.
import { createRoot } from "react-dom/client";
import { createBrowserRouter } from "react-router-dom";
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({
// See docs for support of different versions of variation of react router
// https://docs.sentry.io/platforms/javascript/guides/react/configuration/integrations/react-router/
routingInstrumentation: Sentry.reactRouterV6Instrumentation(
React.useEffect,
useLocation,
useNavigationType,
createRoutesFromChildren,
matchRoutes
),
}),
new Sentry.Replay()
],
// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for performance monitoring.
tracesSampleRate: 1.0,
// Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
tracePropagationTargets: ["localhost", /^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,
});
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
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 JavaScript
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 projectRepresents your service in Sentry and allows you to scope events to a distinct application.
- 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.
return <button onClick={() => methodDoesNotExist()}>Break the world</button>;
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and open your
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").
- Package:
- npm:@sentry/react
- Version:
- 7.72.0
- Repository:
- https://github.com/getsentry/sentry-javascript