Skip to content

javascript.remix.mdx

Latest commit

 

History

History
492 lines (364 loc) · 14.7 KB

javascript.remix.mdx

File metadata and controls

492 lines (364 loc) · 14.7 KB

Step 1: Install

Choose the features you want to configure, and this guide will show you how:

<OnboardingOptionButtons options={[ "error-monitoring", "performance", "profiling", "session-replay", "user-feedback", "logs", ]} />

Install the Sentry SDK

Run the command for your preferred package manager to add the Sentry SDK to your application:

npm install @sentry/remix --save
yarn add @sentry/remix
pnpm add @sentry/remix
```bash {tabTitle:npm} npm install @sentry/remix @sentry/profiling-node --save ``` 
yarn add @sentry/remix @sentry/profiling-node
pnpm add @sentry/remix @sentry/profiling-node

Step 2: Configure

Configure Client-Side Sentry

Create a client file entry.client.tsx in the app folder of your project if you don't have one already. In this file, import and initialize the Sentry SDK:

import { useLocation, useMatches } from "@remix-run/react";
import * as Sentry from "@sentry/remix";
import { useEffect } from "react";

Sentry.init({
  dsn: "___PUBLIC_DSN___",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/remix/configuration/options/#sendDefaultPii
  sendDefaultPii: true,

  integrations: [
    // ___PRODUCT_OPTION_START___ performance
    Sentry.browserTracingIntegration({
      useEffect,
      useLocation,
      useMatches,
    }),
    // ___PRODUCT_OPTION_END___ performance
    // ___PRODUCT_OPTION_START___ session-replay
    // Replay is only available in the client
    Sentry.replayIntegration(),
    // ___PRODUCT_OPTION_END___ session-replay
    // ___PRODUCT_OPTION_START___ user-feedback
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      colorScheme: "system",
    }),
    // ___PRODUCT_OPTION_END___ user-feedback
  ],
  // ___PRODUCT_OPTION_START___ performance

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for tracing.
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,

  // Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
  tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ session-replay

  // Capture Replay for 10% of all sessions,
  // plus for 100% of sessions with an error
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/session-replay/configuration/#general-integration-configuration
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ session-replay
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});

Remix ErrorBoundary

To capture errors from your ErrorBoundary, define it in root.tsx to act as a fallback for all routes or create route-specific error boundaries in your route components.

In your ErrorBoundary component, use Sentry.captureRemixErrorBoundaryError to send the captured error to Sentry:

import { captureRemixErrorBoundaryError } from "@sentry/remix";

export const ErrorBoundary = () => {
  const error = useRouteError();

  captureRemixErrorBoundaryError(error);

  return <div> ... </div>;
};

Performance Monitoring

Wrap your Remix root component with withSentry to capture performance data:

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);

Configure Server-Side Sentry

<PlatformSection notSupported={["javascript.cloudflare"]}>

Create an instrumentation file instrument.server.mjs in your project's root folder and initialize the Sentry SDK within it:

import * as Sentry from "@sentry/remix";
// ___PRODUCT_OPTION_START___ profiling
import { nodeProfilingIntegration } from "@sentry/profiling-node";
// ___PRODUCT_OPTION_END___ profiling

Sentry.init({
  dsn: "___PUBLIC_DSN___",

  // Adds request headers and IP for users, for more info visit: and captures action formData attributes
  // https://docs.sentry.io/platforms/javascript/guides/remix/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  // ___PRODUCT_OPTION_START___ profiling

  // Add our Profiling integration
  integrations: [nodeProfilingIntegration()],
  // ___PRODUCT_OPTION_END___ profiling
  // ___PRODUCT_OPTION_START___ performance

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for tracing.
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ profiling

  // Enable profiling for a percentage of sessions
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#profileSessionSampleRate
  profileSessionSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ profiling
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs

  // Optionally capture action formData attributes with errors.
  // This requires `sendDefaultPii` set to true as well.
  captureActionFormDataKeys: {
    key_x: true,
    key_y: true,
  },
});

Then run your Remix server using the --import command line option and point it to this file to make sure the Sentry module loads before any other application code runs:

NODE_OPTIONS='--import=./instrument.server.mjs' remix-serve build
# or
NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build
If you use the Express server instead of the built-in Remix server, you can import your instrumentation file directly at the top of your server implementation. 
// import the Sentry instrumentation file before anything else.
import "./instrument.server.mjs";
// alternatively `require('./instrument.server.cjs')`

// ...

const app = express();

// ...

</ PlatformSection>

<PlatformSection supported={["javascript.cloudflare"]}>

import * as Sentry from "@sentry/cloudflare";

export const onRequest = [
  // Make sure Sentry is the first middleware
  Sentry.sentryPagesPlugin((context) => ({
    dsn: "___PUBLIC_DSN___",

    // Adds request headers and IP for users, for more info visit: and captures action formData attributes
    // https://docs.sentry.io/platforms/javascript/guides/remix/configuration/options/#sendDefaultPii
    sendDefaultPii: true,
    // ___PRODUCT_OPTION_START___ performance

    // Set tracesSampleRate to 1.0 to capture 100%
    // of transactions for tracing.
    // We recommend adjusting this value in production
    // Learn more at
    // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
    tracesSampleRate: 1.0,
    // ___PRODUCT_OPTION_END___ performance
    // ___PRODUCT_OPTION_START___ logs

    // Enable logs to be sent to Sentry
    enableLogs: true,
    // ___PRODUCT_OPTION_END___ logs

    // Optionally capture action formData attributes with errors.
    // This requires `sendDefaultPii` set to true as well.
    captureActionFormDataKeys: {
      key_x: true,
      key_y: true,
    },
  })),
  // Add more middlewares here
];

</ PlatformSection>

Capture Server-Side Errors

To automatically capture server-side errors, instrument the handleError function in your server entry point (entry.server.tsx). You can wrap your custom error handler with wrapHandleErrorWithSentry or directly use sentryHandleError:

import * as Sentry from "@sentry/remix";

export const handleError = Sentry.wrapHandleErrorWithSentry(
  (error, { request }) => {
    // Custom handleError implementation
  }
);

// Alternative: Use the Sentry utility function if you don't need to wrap a custom function
export const handleError = Sentry.sentryHandleError;

Sentry's Remix SDK automatically records your action and loader transactions for performance monitoring. You can also initialize Sentry's database integrations, such as Prisma, to get spans for your database calls.

<PlatformSection supported={["javascript.cloudflare"]}>

Configure Cloudflare for Sentry

</ PlatformSection>

Step 3: Add Readable Stack Traces With Source Maps (Optional)

To upload source maps for clear error stack traces, add your Sentry auth token, organization, and project slug in your vite.config.ts file:

Check our Source Maps documentation for alternative setup options.

import { defineConfig } from "vite";
import { vitePlugin as remix } from "@remix-run/dev";
import { sentryVitePlugin } from "@sentry/vite-plugin";

export default defineConfig({
  plugins: [
    remix({
      // ... your Remix plugin options
    }),
    sentryVitePlugin({
      // If you use .sentryclirc or environment variables,
      // you don't need to specify these options
      org: "___ORG_SLUG___",
      project: "___PROJECT_SLUG___",
      // store your auth token in an environment variable
      authToken: process.env.SENTRY_AUTH_TOKEN,
    }),
  ],

  build: {
    sourcemap: "hidden",
    // ... rest of your Vite build options
  },
});

To keep your auth token secure, always store it in an environment variable instead of directly in your files:

SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___

<PlatformSection notSupported={["javascript.cloudflare"]}>

Step 4: Avoid Ad Blockers With Tunneling (Optional)

Step 5: Verify Your Setup

<PlatformSection supported={["javascript.cloudflare"]}>

Step 4: Verify Your Setup

Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.

Issues

To verify that Sentry captures errors and creates issues in your Sentry project, add a test button to one of your pages:

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

Open the page in a browser and click the button to trigger a frontend error.

Tracing

To test your tracing configuration, update the previous code snippet by calling a non-existing route and starting a trace to measure the time it takes for the execution of your code:

<button
  type="button"
  onClick={async () => {
    await Sentry.startSpan(
      {
        name: "Example Frontend Span",
        op: "test",
      },
      async () => {
        const res = await fetch("/api/sentry-example-api");
        if (!res.ok) {
          throw new Error("Sentry Example Frontend Error");
        }
      }
    );
  }}
>
  <span>Throw Sample Error</span>
</button>

Open the page in a browser (for most Remix applications, this will be at localhost:3000) and click the button to trigger the frontend error and a trace.

View Captured Data in Sentry

Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).

Next Steps

At this point, you should have integrated Sentry into your Remix application and should already be sending error and performance data to your Sentry project.

Now's a good time to customize your setup and look into more advanced topics. Our next recommended steps for you are:

  • Explore practical guides on what to monitor, log, track, and investigate after setup
  • Learn how to manually capture errors
  • Continue to customize your configuration
  • Get familiar with Sentry's product features like tracing, insights, and alerts

<PlatformSection notSupported={["javascript.cloudflare"]}>

  • If you encountered issues with the manual setup, try our installation wizard
  • Find various topics in Troubleshooting
  • Get support

<PlatformSection supported={["javascript.cloudflare"]}>

  • If you encountered issues with the manual setup, try our installation wizard
  • Find various support topics in Cloudflare troubleshooting and Remix troubleshooting
  • Get support