@sentry/react
Advanced tools
The @sentry/react package is designed for error monitoring and performance tracking in React applications. It provides a comprehensive set of tools to capture exceptions, track performance issues, and improve the overall reliability of React applications. By integrating Sentry into a React project, developers can gain insights into errors and performance bottlenecks, allowing for quicker debugging and optimization.
Error Boundary
This feature automatically catches JavaScript errors anywhere in the child component tree of the Error Boundary and logs them to Sentry. It also displays a fallback UI instead of the component tree that crashed.
import React from 'react';
import * as Sentry from '@sentry/react';
const MyApp = () => (
<Sentry.ErrorBoundary fallback={'An error has occurred'}>
<YourApp />
</Sentry.ErrorBoundary>
);Performance Monitoring
Enables performance monitoring in your React application. By setting the `tracesSampleRate` to a value between 0 and 1, you can control the percentage of transactions sent to Sentry for performance analysis.
import * as Sentry from '@sentry/react';
Sentry.init({
dsn: 'YOUR_DSN',
tracesSampleRate: 1.0,
});Custom Error Tracking
Allows for manual reporting of errors or exceptions to Sentry, giving developers the flexibility to capture specific issues that may not be automatically detected.
import * as Sentry from '@sentry/react';
Sentry.captureException(new Error('This is my custom error.'));LogRocket is a frontend application monitoring solution that provides session replay, performance monitoring, and error tracking. While it offers similar error tracking capabilities to @sentry/react, LogRocket distinguishes itself with its session replay feature, allowing developers to see exactly what users saw when an error occurred.
Bugsnag offers error monitoring and application stability management for various programming languages and frameworks, including React. Compared to @sentry/react, Bugsnag emphasizes application stability metrics and provides detailed error grouping and analysis, making it easier to prioritize and fix critical errors.
This package is a wrapper around @sentry/browser, with added functionality related to React. All methods available in
@sentry/browser can be imported from @sentry/react.
To use this SDK, call Sentry.init(options) before you mount your React component.
import React from 'react';
import { createRoot } from 'react-dom/client';
import * as Sentry from '@sentry/react';
Sentry.init({
dsn: '__DSN__',
// ...
});
// ...
const container = document.getElementById(“app”);
const root = createRoot(container);
root.render(<App />);
// also works with hydrateRoot
// const domNode = document.getElementById('root');
// const root = hydrateRoot(domNode, reactNode);
// root.render(<App />);
Starting with React 19, the createRoot and hydrateRoot methods expose error hooks that can be used to capture errors
automatically. Use the Sentry.reactErrorHandler function to capture errors in the error hooks you are interested in.
const container = document.getElementById(“app”);
const root = createRoot(container, {
// Callback called when an error is thrown and not caught by an Error Boundary.
onUncaughtError: Sentry.reactErrorHandler((error, errorInfo) => {
console.warn('Uncaught error', error, errorInfo.componentStack);
}),
// Callback called when React catches an error in an Error Boundary.
onCaughtError: Sentry.reactErrorHandler(),
// Callback called when React automatically recovers from errors.
onRecoverableError: Sentry.reactErrorHandler(),
});
root.render(<App />);
If you want more finely grained control over error handling, we recommend only adding the onUncaughtError and
onRecoverableError hooks and using an ErrorBoundary component instead of the onCaughtError hook.
@sentry/react exports an ErrorBoundary component that will automatically send Javascript errors from inside a
component tree to Sentry, and set a fallback UI.
app.js
import React from 'react';
import * as Sentry from '@sentry/react';
function FallbackComponent() {
return <div>An error has occurred</div>;
}
class App extends React.Component {
render() {
return (
<Sentry.ErrorBoundary fallback={FallbackComponent} showDialog>
<OtherComponents />
</Sentry.ErrorBoundary>
);
}
}
export default App;
@sentry/react exports a Profiler component that leverages the tracing features to add React-related spans to
transactions. If tracing is not enabled, the Profiler component will not work. The Profiler tracks component mount,
render duration and updates.
app.js
import React from 'react';
import * as Sentry from '@sentry/react';
class App extends React.Component {
render() {
return (
<FancyComponent>
<InsideComponent someProp={2} />
<AnotherComponent />
</FancyComponent>
);
}
}
export default Sentry.withProfiler(App);
9.0.0
Version 9.0.0 marks a release of the Sentry JavaScript SDKs that contains breaking changes.
The goal of this release is to trim down on unused and potentially confusing APIs, prepare the SDKs for future framework versions to build deeper instrumentation, and remove old polyfills to reduce the packages' size.
Please carefully read through the migration guide in the Sentry docs on how to upgrade from version 8 to version 9. Make sure to select your specific platform/framework in the top left corner: https://docs.sentry.io/platforms/javascript/migration/v8-to-v9/
A comprehensive migration guide outlining all changes for all the frameworks can be found within the Sentry JavaScript SDK Repository: https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md
~5.0.0 (#14758)nitro-utils package (#14998)sendDefaultPii: true (#15084)autoSessionTracking option (#14802)enableTracing (#15078)getCurrentHub(), Hub, and getCurrentHubShim() (#15122)spanId from propagation context (#14733)>=18 as minimum supported version (#14749)captureUserFeedback method (#14820)normalizedRequest to samplingContext (#14902)beforeSendSpan and disallow returning null (#14831)BAGGAGE_HEADER_NAME export (#14785)TransactionNamingScheme type (#14865)addOpenTelemetryInstrumentation method (#14792)arrayify method (#14782)debugIntegration and sessionTimingIntegration (#14747)flatten method (#14784)getDomElement method (#14797)makeFifoCache method (#14786)memoBuilder export & WeakSet fallback (#14859)transactionContext from samplingContext (#14904)urlEncode method (#14783)Request type (#14858)Client interface & deprecate BaseClient (#14800)event as argument for recordDroppedEvent (#14999)requestDataIntegration (#14898)hasTracingEnabled to consider empty trace config (#14857)requestDataIntegration handling (#14806)<=3.x (#15032)nestIntegration into nest sdk and remove setupNestErrorHandler (#14751)@WithSentry decorator (#14762)SentryService (#14759)experimental_captureRequestError (#14607)processThreadBreadcrumbIntegration (#14666)registerEsmLoaderHooks (#15002)1.63.0 (#15030)getNumberOfUrlSegments method (#14744)ErrorBoundary componentStack type (#14742)autoInstrumentRemix option (#15074)--import setup and add autoInjectServerSentry (#14862)sentrySolidStartVite (#15143)fetchProxyScriptNonce option (#15123)@sentry/utils package (#14830)vueIntegration's tracingOptions option (#14856)"update" spans for component tracking by default (#14602)vercelAIIntegration to VercelAI (#15298)logError from vueIntegration (#14958)ReportDialogOptions (#14861)captureConsoleIntegration as handled: true by default (#14734)shutdownTimeout option type from core to node (#15217)Scope type interface in favor of using Scope class (#14721)import-in-the-middle to 1.12.0 (#14796)SentryNodeServerlessSDKv9 (#14927)user.ip_address explicitly to {{auto}} (#15008)inheritOrSampleWith helper to traceSampler (#15277)hasTracingEnabled to hasSpansEnabled (#15309)SpanJSON type (#14693)@sentry/deno (#15014)deno.land (#15016)SentryTracingInterceptor, SentryGlobalGraphQLFilter, SentryGlobalGenericFilter (#14761)sourcemaps.disable to webpack plugin (#15109)processSessionIntegration (#15081)vercelAIIntegration export (#15318)worker_threads (#15105)silent, errorHandler, release to SourceMapsOptions (#15246)@sentry-internal/node-cpu-profiler (#15208)autoInjectServerSentry: 'experimental_dynamic-import (#14863)__esModule properties in CJS modules when there is a default export (#15018)parentSampleRate to tracesSampler (#15024)browserPerformanceTimeOrigin side-effects (#14025)startSpanManual (#14901)startSpan (#14900)sendDefaultPii for IP collection in requestDataIntegration (#15125)waitUntil in captureRequestError (#15146)__span property into breadcrumbs (#14798)release from ANR sessions (#15138)browserTracingIntegration (#14959)supportsHistory check & history usage (#14696)Work in this release was contributed by @aloisklink, @arturovt, @aryanvdesh, @benjick, @chris-basebone, @davidturissini, @GrizliK1988, @jahands, @jrandolf, @kunal-511, @maximepvrt, @maxmaxme, @mstrokin, @nathankleyn, @nwalters512, @tannerlinsley, @tjhiggins, and @Zen-cronic. Thank you for your contributions!
FAQs
Official Sentry SDK for React.js
The npm package @sentry/react receives a total of 4,407,933 weekly downloads. As such, @sentry/react popularity was classified as popular.
We found that @sentry/react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.