@sentry/remix
Advanced tools
This package is a wrapper around @sentry/node for the server and @sentry/react for the client, with added
functionality related to Remix.
To use this SDK, initialize Sentry in your Remix entry points for both the client and server.
// entry.client.tsx
import { useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { useEffect } from 'react';
Sentry.init({
dsn: '__DSN__',
tracesSampleRate: 1,
integrations: [
Sentry.browserTracingIntegration({
useEffect,
useLocation,
useMatches,
}),
],
// ...
});
// entry.server.tsx
import { prisma } from '~/db.server';
import * as Sentry from '@sentry/remix';
Sentry.init({
dsn: '__DSN__',
tracesSampleRate: 1,
integrations: [new Sentry.Integrations.Prisma({ client: prisma })],
// ...
});
Also, wrap your Remix root with withSentry to catch React component errors and to get parameterized router
transactions.
// root.tsx
import {
Links,
LiveReload,
Meta,
Outlet,
Scripts,
ScrollRestoration,
} from "@remix-run/react";
import { withSentry } from "@sentry/remix";
function App() {
return (
<html>
<head>
<Meta />
<Links />
</head>
<body>
<Outlet />
<ScrollRestoration />
<Scripts />
<LiveReload />
</body>
</html>
);
}
export default withSentry(App);
You can disable or configure ErrorBoundary using a second parameter to withSentry.
withSentry(App, {
wrapWithErrorBoundary: false
});
// or
withSentry(App, {
errorBoundaryOptions: {
fallback: <p>An error has occurred</p>
}
});
To set context information or send manual events, use the exported functions of @sentry/remix.
import * as Sentry from '@sentry/remix';
// Set user information, as well as tags and further extras
Sentry.setExtra('battery', 0.7);
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: 'My Breadcrumb',
// ...
});
// Capture exceptions, messages or manual events
Sentry.captureMessage('Hello, world!');
Sentry.captureException(new Error('Good bye'));
Sentry.captureEvent({
message: 'Manual',
stacktrace: [
// ...
],
});
The Remix SDK provides a script that automatically creates a release and uploads sourcemaps. To generate sourcemaps with
Remix, you need to call remix build with the --sourcemap option.
On release, call sentry-upload-sourcemaps to upload source maps and create a release. To see more details on how to
use the command, call sentry-upload-sourcemaps --help.
For more advanced configuration,
directly use sentry-cli to upload source maps..
8.40.0
feat(angular): Support Angular 19 (#14398)
The @sentry/angular SDK can now be used with Angular 19. If you're upgrading to the new Angular version, you might want to migrate from the now deprecated APP_INITIALIZER token to provideAppInitializer.
In this case, change the Sentry TraceService initialization in app.config.ts:
// Angular 18
export const appConfig: ApplicationConfig = {
providers: [
// other providers
{
provide: TraceService,
deps: [Router],
},
{
provide: APP_INITIALIZER,
useFactory: () => () => {},
deps: [TraceService],
multi: true,
},
],
};
// Angular 19
export const appConfig: ApplicationConfig = {
providers: [
// other providers
{
provide: TraceService,
deps: [Router],
},
provideAppInitializer(() => {
inject(TraceService);
}),
],
};
feat(core): Deprecate debugIntegration and sessionTimingIntegration (#14363)
The debugIntegration was deprecated and will be removed in the next major version of the SDK.
To log outgoing events, use Hook Options (beforeSend, beforeSendTransaction, ...).
The sessionTimingIntegration was deprecated and will be removed in the next major version of the SDK.
To capture session durations alongside events, use Context (Sentry.setContext()).
feat(nestjs): Deprecate @WithSentry in favor of @SentryExceptionCaptured (#14323)
The @WithSentry decorator was deprecated. Use @SentryExceptionCaptured instead. This is a simple renaming and functionality stays identical.
feat(nestjs): Deprecate SentryTracingInterceptor, SentryService, SentryGlobalGenericFilter, SentryGlobalGraphQLFilter (#14371)
The SentryTracingInterceptor was deprecated. If you are using @sentry/nestjs you can safely remove any references to the SentryTracingInterceptor. If you are using another package migrate to @sentry/nestjs and remove the SentryTracingInterceptor afterwards.
The SentryService was deprecated and its functionality was added to Sentry.init. If you are using @sentry/nestjs you can safely remove any references to the SentryService. If you are using another package migrate to @sentry/nestjs and remove the SentryService afterwards.
The SentryGlobalGenericFilter was deprecated. Use the SentryGlobalFilter instead which is a drop-in replacement.
The SentryGlobalGraphQLFilter was deprecated. Use the SentryGlobalFilter instead which is a drop-in replacement.
feat(node): Deprecate nestIntegration and setupNestErrorHandler in favor of using @sentry/nestjs (#14374)
The nestIntegration and setupNestErrorHandler functions from @sentry/node were deprecated and will be removed in the next major version of the SDK. If you're using @sentry/node in a NestJS application, we recommend switching to our new dedicated @sentry/nestjs package.
normalizedRequest on sdkProcessingMetadata is merged (#14315)@sentry/utils into @sentry/core (#14382)__self and __source attributes on feedback nodes (#14356)FAQs
Official Sentry SDK for Remix
The npm package @sentry/remix receives a total of 118,063 weekly downloads. As such, @sentry/remix popularity was classified as popular.
We found that @sentry/remix demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 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
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.