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.

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 route should be a path, like /error-monitoring, as it adds an API endpoint within your application.

Learn more about tunneling in the troubleshooting section.

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

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.