Quick Start: Manual Setup

Prerequisites

• A Sentry account and project
• Be logged in to your Sentry account to have your project's data pre-filled (recommended)
• Your application up and running

Step 1: Install

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

npm install @sentry/nextjs --save

Choose Your Sentry Features

Select the features you want to set up in your application, in addition to error monitoring, using the checkboxes below. This guide will then adjust its content to provide you with the necessary information.

You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later.

Step 2: Configure

Apply Instrumentation to Your App

To apply instrumentation to your application, use withSentryConfig to extend your app's default Next.js options.

Update your next.config.js or next.config.mjs file with the following:

const { withSentryConfig } = require("@sentry/nextjs");

const nextConfig = {
  // Your existing Next.js configuration
};

// Make sure adding Sentry options is the last code to run before exporting
module.exports = withSentryConfig(nextConfig, {
  org: "example-org",
  project: "example-project",

  // Only print logs for uploading source maps in CI
  // Set to `false` to surpress logs
  silent: !process.env.CI,

  // Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
  // This can increase your server load as well as your hosting bill.
  // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-side errors will fail.
  tunnelRoute: "/monitoring",

  // Automatically tree-shake Sentry logger statements to reduce bundle size
  disableLogger: true,
});

Initialize Sentry Client-Side and Server-Side SDKs

Create three files in the root directory of your Next.js application: sentry.client.config.js, sentry.server.config.js and sentry.edge.config.js. In these files, add your initialization code for the client-side SDK and server-side SDK, respectively. We've included some examples below.

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

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  // Replay may only be enabled for the client-side
  integrations: [Sentry.replayIntegration()],

  // 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,

  // 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,

  // ...

  // Note: if you want to override the automatic release value, do not set a
  // `release` value here - use the environment variable `SENTRY_RELEASE`, so
  // that it will also get attached to your source maps
});

Register Sentry Server-Side SDK Initialization

While the client initialization code will be injected into your application's client bundle by withSentryConfig which we set up earlier, the configuration for the server and edge runtime needs to be imported from a Next.js Instrumentation file.

Add a instrumentation.ts file to the root directory of your Next.js application (or inside the src folder if you're using one) and add the following content:

export async function register() {
  if (process.env.NEXT_RUNTIME === "nodejs") {
    await import("./sentry.server.config");
  }

  if (process.env.NEXT_RUNTIME === "edge") {
    await import("./sentry.edge.config");
  }
}

Make sure that the import statements point to your newly created sentry.server.config.(js|ts) and sentry.edge.config.(js|ts) files.

Step 3: Capture React Render Errors

To capture React render errors you need to add Error components for the App Router.

React Render Errors in App Router

Create a Custom Next.js Global Error component for the App router:

"use client";

import * as Sentry from "@sentry/nextjs";
import NextError from "next/error";
import { useEffect } from "react";

export default function GlobalError({
  error,
}: {
  error: Error & { digest?: string };
}) {
  useEffect(() => {
    Sentry.captureException(error);
  }, [error]);

  return (
    <html>
      <body>
        {/* `NextError` is the default Next.js error page component. Its type
        definition requires a `statusCode` prop. However, since the App Router
        does not expose status codes for errors, we simply pass 0 to render a
        generic error message. */}
        <NextError statusCode={0} />
      </body>
    </html>
  );
}

Errors from Nested React Server Components

Requires @sentry/nextjs version 8.28.0 or higher and Next.js 15.

To capture errors from nested React Server Components, use the onRequestError hook in instrumentation.(js|ts). The onRequestError hook is a feature provided by Next.js, which allows reporting errors to Sentry.

To report errors using the onRequestError hook, pass all arguments to the captureRequestError function:

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

export const onRequestError = Sentry.captureRequestError;

Step 4: Add readable Stack Traces With Source Maps (optional)

By default, withSentryConfig will generate and upload source maps to Sentry automatically, so that errors have readable stack traces. However, this only works if you provide an auth token in withSentryConfig.

Update withSentryConfig in your next.config.js or next.config.mjs file with the following additions:

export default withSentryConfig(nextConfig, {
  // Pass the auth token
  authToken: process.env.SENTRY_AUTH_TOKEN,
  // Hides source maps from generated client bundles
  hideSourceMaps: true,
  // Upload a larger set of source maps for prettier stack traces (increases build time)
  widenClientFileUpload: true,
});

Alternatively, you can set the SENTRY_AUTH_TOKEN environment variable in your .env file:

SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE

Step 5: Instrumentation of Vercel Cron Jobs (optional)

If you have configured Vercel Cron Jobs you can set the automaticVercelMonitors option to automatically create Cron Monitors in Sentry.

export default withSentryConfig(nextConfig, {
  automaticVercelMonitors: true,
});

Step 6: Capture React Component Names (optional)

You can capture the names of React components in your application, so that you can, for example, see the name of a component that a user clicked on in different Sentry features, like Session Replay and Performance page.

Update withSentryConfig in your next.config.js or next.config.mjs with the following addition to capture component names:

export default withSentryConfig(nextConfig, {
  reactComponentAnnotation: {
    enabled: true,
  },
});

Step 7: Verify

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

Issues

To test if Sentry captures errors and creates issues for them in your Sentry project, add a test button to one of your existing pages or create a new one:

<button
  type="button"
  onClick={() => {
    throw new Error("Sentry Test Error");
  }}
>
  Break the world
</button>;

import { NextResponse } from "next/server";
export const dynamic = "force-dynamic";

// A faulty API route to test Sentry's error monitoring
export function GET() {
  throw new Error("Sentry Example API Route Error");
  return NextResponse.json({ data: "Testing Sentry Error..." });
}

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

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 Next.js 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:

• Instrument Next.js server actions
• Add error components for the Pages Router
• Learn how to manually capture errors
• Continue to customize your configuration
• Learn more about our Vercel integration