KEMBAR78
# Next.js | Sentry for Next.js ## [Prerequisites](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#prerequisites) You need: * A Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects.md) * Your application up and running ## [Features](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#features) In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](https://docs.sentry.io/concepts/key-terms/tracing.md). You can also get to the root of an error or performance issue faster, by watching a video-like reproduction of a user session with [session replay](https://docs.sentry.io/product/explore/session-replay/web/getting-started.md). Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below. Error Monitoring\[ ]Logs\[ ]Session Replay\[ ]Tracing\[ ]User Feedback ## [Step 1: Install](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#step-1-install) To install Sentry using the installation wizard, run the following command within your project: ```bash npx @sentry/wizard@latest -i nextjs ``` The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring. Want to learn more about these features? * [**Issues**](https://docs.sentry.io/product/issues.md) (always enabled): Sentry's core error monitoring product that automatically reports errors, uncaught exceptions, and unhandled rejections. If you have something that looks like an exception, Sentry can capture it. * [**Tracing**](https://docs.sentry.io/product/tracing.md): Track software performance while seeing the impact of errors across multiple systems. For example, distributed tracing allows you to follow a request from the frontend to the backend and back. * [**Session Replay**](https://docs.sentry.io/product/explore/session-replay/web.md): Get to the root cause of an issue faster by viewing a video-like reproduction of what was happening in the user's browser before, during, and after the problem. * [**Logs**](https://docs.sentry.io/product/explore/logs.md): Centralize and analyze your application logs to correlate them with errors and performance issues. Search, filter, and visualize log data to understand what's happening in your applications. This guide assumes that you enable all features and allow the wizard to create an example page and route. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later. What does the installation wizard change inside your application? * Creates config files with the default `Sentry.init()` calls for all runtimes (Node.js, Browser, and Edge) * Adds a Next.js instrumentation hook to your project (`instrumentation.ts`) * Creates or updates your Next.js config with the default Sentry settings * Creates error handling components (`global-error.(jsx|tsx)` and `_error.jsx` for the Pages Router) if they don't already exist * Creates `.sentryclirc` with an auth token to upload source maps (this file is automatically added to `.gitignore`) * Adds an example page and route to your application to help verify your Sentry setup ## [Step 2: Configure](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#step-2-configure) If you prefer to configure Sentry manually, here are the configuration files the wizard would create: ### [Client-Side Configuration](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#client-side-configuration) `instrumentation-client.(js|ts)` ```javascript import * as Sentry from "@sentry/nextjs"; Sentry.init({ dsn: "https://examplePublicKey@o0.ingest.sentry.io/0", // Adds request headers and IP for users, for more info visit: // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#sendDefaultPii sendDefaultPii: true, integrations: [ // session-replay // Replay may only be enabled for the client-side Sentry.replayIntegration(), // session-replay // user-feedback Sentry.feedbackIntegration({ // Additional SDK configuration goes in here, for example: colorScheme: "system", }), // user-feedback ], // logs // Enable logs to be sent to Sentry enableLogs: true, // logs // 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, // performance // session-replay // Capture Replay for 10% of all // 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, // session-replay }); // performance export const onRouterTransitionStart = Sentry.captureRouterTransitionStart; // performance ``` ### [Server-Side Configuration](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#server-side-configuration) `sentry.server.config.(js|ts)` ```javascript import * as Sentry from "@sentry/nextjs"; Sentry.init({ dsn: "https://examplePublicKey@o0.ingest.sentry.io/0", // Adds request headers and IP for users, for more info visit: // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#sendDefaultPii sendDefaultPii: true, // logs // Enable logs to be sent to Sentry enableLogs: true, // logs // 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, // performance }); ``` For detailed manual setup instructions, see our [manual setup guide](https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup.md). ## [Step 3: Verify Your Setup](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#step-3-verify-your-setup) Are you using Turbopack? The Sentry SDK fully supports Turbopack production builds (`next build --turbopack`) starting with `@sentry/nextjs@10.13.0`. The minimum required Next.js version is `next@15.4.1`. If you haven't tested your Sentry configuration yet, let's do it now. You can confirm that Sentry is working properly and sending data to your Sentry project by using the example page and route created by the installation wizard: 1. Open the example page `/sentry-example-page` in your browser. For most Next.js applications, this will be at localhost. 2. Click the "Throw error" button. This triggers two errors: * a frontend error * an error within the API route Sentry captures both of these errors for you. Additionally, the button click starts a performance trace to measure the time it takes for the API request to complete. ##### Tip Don't forget to explore the example files' code in your project to understand what's happening after your button click. ### [View Captured Data in Sentry](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#view-captured-data-in-sentry) Now, head over to your project on [Sentry.io](https://sentry.io) to view the collected data (it takes a couple of moments for the data to appear). ##### Important Errors triggered from within your browser's developer tools (like the browser console) are sandboxed, so they will not trigger Sentry's error monitoring. Need help locating the captured errors in your Sentry project? 1. Open the [**Issues**](https://sentry.io/issues) page and select an error from the issues list to view the full details and context of this error. For more details, see this [interactive walkthrough](https://docs.sentry.io/product/sentry-basics/integrate-frontend/generate-first-error.md#ui-walkthrough). 2. Open the [**Traces**](https://sentry.io/explore/traces) page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/sentry-basics/distributed-tracing/generate-first-error.md#ui-walkthrough). 3. Open the [**Replays**](https://sentry.io/explore/replays) page and select an entry from the list to get a detailed view where you can replay the interaction and get more information to help you troubleshoot. 4. Open the [**Logs**](https://sentry.io/explore/logs) page and filter by service, environment, or search keywords to view log entries from your application. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/explore/logs.md#overview). ## [Next Steps](https://docs.sentry.io/platforms/javascript/guides/nextjs.md#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: * Learn about [instrumenting Next.js server actions](https://docs.sentry.io/platforms/javascript/guides/nextjs/apis.md#server-actions) * Learn how to [manually capture errors](https://docs.sentry.io/platforms/javascript/guides/nextjs/usage.md) * Continue to [customize your configuration](https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration.md) * Get familiar with [Sentry's product features](https://docs.sentry.io/product.md) like tracing, insights, and alerts * Learn more about our [Vercel integration](https://docs.sentry.io/organization/integrations/deployment/vercel.md) Are you having problems setting up the SDK? * If you encountered issues with our installation wizard, try [setting up Sentry manually](https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup.md) * [Get support](https://sentry.zendesk.com/hc/en-us/)