Remix

Sentry's Remix SDK relies on our React SDK for the frontend and Node SDK for the backend. That means all features available in those SDKs are also available in this SDK.

On this page, we get you up and running with Sentry's SDK.

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.

We recommend installing the SDK through our installation wizard:

npx @sentry/wizard@latest -i remix

The wizard will prompt you to log in to Sentry. It will then automatically do the following steps for you:

• create two files in the root directory of your project, entry.client.tsx and entry.server.tsx (if they don't already exist).
• add the default Sentry.init() for the client in entry.client.tsx and the server in entry.server.tsx.
• create .sentryclirc with an auth token to upload source maps (this file is automatically added to .gitignore).
• adjust your build script in package.json to automatically upload source maps to Sentry when you build your application.

If you use Remix future flags, the wizard will instrument your application accordingly to support Remix v2 features.

After the wizard setup is completed, the SDK will automatically capture unhandled errors, and monitor performance. You can also manually capture errors.

Configure

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

To complete your configuration, add options to your Sentry.init() calls. Here, you'll also be able to set context data, which includes data about the user, tags, or even arbitrary data, all of which will be added to every event sent to Sentry.

Add Readable Stack Traces to Errors

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, you can use sentry-cli directly to upload sourcemaps.

Verify

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

<button
  type="button"
  onClick={() => {
    throw new Error("Sentry Frontend Error");
  }}
>
  Throw error
</button>

This snippet adds a button that throws an error in a component or page.

Then, throw an error in a loader or action.

export const action: ActionFunction = async ({ request }) => {
  throw new Error("Sentry Error");
};

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.