Build Options

The slug of the Sentry organization associated with the app.

The slug of the Sentry project associated with the app.

The authentication token to use for all communication with Sentry. Can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/.

The base URL of your Sentry instance. Use this if you are using a self-hosted or Sentry instance other than sentry.io.

Headers added to every outgoing network request.

If set to true, internal plugin errors and performance data will be sent to Sentry.

At Sentry we like to use Sentry ourselves to deliver faster and more stable products. We're very careful of what we're sending. We won't collect anything other than error and high-level performance data. We will never collect your code or any details of the projects in which you're using this plugin.

Suppresses all Sentry SDK build logs.

Prints additional debug information about the SDK and uploading source maps when building the application.

A callback function that will be invoked when errors occur during the Sentry build process. This is particularly useful for gracefully handling CI/CD pipeline failures when there are connectivity issues. You can optionally re-throw the error to fail the build process.

withSentryConfig(nextConfig, {
  // ... other options
  errorHandler: (error) => {
    console.warn("Sentry build error occurred:", error);
    // Optionally, you can still fail the build by re-throwing the error
    // throw error;
  },
});

Disable any functionality related to source maps.

A glob or an array of globs that specifies the build artifacts that should be uploaded to Sentry. If not specified, the plugin will try to upload all JavaScript files and source map files created during build.

The globbing patterns follow the implementation of the glob package.

A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.

Toggle whether generated source maps within your Next.js build folder should be automatically deleted after being uploaded to Sentry.

Unique identifier for the release you want to create. Defaults to automatically detecting a value for your environment.

Whether the plugin should create a release on Sentry during the build.

Whether the Sentry release should be automatically finalized after the build ends.

Unique identifier for the distribution, used to further segment your release. Usually your build number.

If set to true, the Sentry SDK will attempt to tree-shake any debugging code within itself during the build.

If set to true, the Sentry SDK will attempt to tree-shake code related to tracing and performance monitoring.

Notice: Do not enable this when using any performance monitoring-related SDK features.

Include Next.js-internal code and code from dependencies when uploading source maps.

Note: Enabling this option can lead to longer build times.

Automatically instrument Next.js data fetching methods and Next.js API routes with error and performance monitoring.

Automatically instrument Next.js middleware with error and performance monitoring.

Automatically instrument components in the app directory with error monitoring.

Exclude specific server-side API routes or pages from automatic Sentry instrumentation during build time. This option takes an array of strings or regular expressions and affects pages in the pages and app directories.

When defining routes, note the following:

• Specify pages as routes and not as file system paths. For example, write /animals instead of pages/animals/index.js.
• Make sure that any provided string matches the route exactly, has a leading slash, and doesn't have a trailing slash.

excludeServerRoutes: [
  "/some/excluded/route",
  "/excluded/route/with/[parameter]",
  /^\/route\/beginning\/with\/some\/prefix/,
  /\/routeContainingASpecificPathSegment\/?/,
];

Tunnel Sentry requests through this route on your Next.js server to prevent ad-blockers from blocking Sentry events from being sent.

This option can be set to:

• true for auto-generated routes, which are unpredictable and change with each deployment.
• A custom static string path like /error-monitoring.

Learn more about tunneling in the troubleshooting section.

Automatically create cron monitors in Sentry for your Vercel Cron Jobs if configured via vercel.json.

Disables automatic injection of the route manifest into the client bundle.

The route manifest is a build-time generated mapping of your Next.js App Router routes that enables Sentry to group transactions by parameterized route names (e.g., /users/:id instead of /users/123, /users/456, etc.).

Disable this option if:

• You want to minimize client bundle size
• You're experiencing build issues related to route scanning
• You prefer raw URLs in transaction names
• You're only using the Pages Router (this feature is only supported in the App Router)

Enables React component name tracking. When enabled, it annotates React components with data attributes that allow Sentry to track which components users interacted with in features like Session Replay and breadcrumbs.

A list of React component names to exclude from component annotation.

Enables the use of the runAfterProductionCompile hook from Next.js to upload sourcemaps after the build is completed.

• This option is set to true by default for Turbopack as there are no alternative ways to upload sourcemaps here.
• This option is set to false for Webpack as the default behavior is to upload sourcemaps during the build process using the Sentry Webpack Plugin.

Important: Enabling this option will mutate your Next.js build output by injecting Debug IDs via the Sentry CLI. If you are relying on any sort of integrity hashes for your build artifacts, you will need to disable this option.

Pass configuration options directly to the Sentry Webpack Plugin that ships with the Sentry Next.js SDK. If withSentryConfig doesn't provide the option you need to modify, you may override the sentryWebpackPluginOptions using this option.