@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.0.0-beta.2
propagationContext on spanEnd to keep trace consistentTo ensure consistency throughout a route's duration, we update the scope's propagation context when the initial page load or navigation span ends. This keeps span-specific attributes like the sampled decision and dynamic sampling context on the scope, even after the transaction has ended.
We won't assume window.dodument is available in the browser SDKs anymore. This should prevent errors in environments
where window.document is not available (such as web workers).
server.address to browser http.client spans (#11634)NodeClient without calling init (#11585)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
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.