How to use @sentry/react with Next.js?

[gajus]

The problem with @sentry/nextjs is that it bundles the webpack plugin, which bundles the @sentry/cli. The latter breaks our build cache and we don't want to use it.

Is there a simple way to just use @sentry/react?

[AbhiPrasad]

We require @sentry/cli for sourcemaps uploading. How is the cli package breaking your build cache? Are you using Vercel?

[gajus]

We are using @sentry/cli to upload sourcemaps as a step when deploying the application, after the image is built.

We don't upload sourcemaps when building a Docker image because we consider builds to be separate from deployments, i.e. the same build typically ends up being deployed to multiple locations.

[lforst]

If you can't or do not want to use the Next.js SDK, I recommend calling Sentry.init() from @sentry/node, @sentry/vercel-edge and @sentry/react for the respective runtime in instrument.ts.

To enable the instrument.ts file you need to flip an experimental flag in Next.js: https://nextjs.org/docs/app/building-your-application/optimizing/instrumentation

Please note that going this route will drastically degrade your Sentry experience for various reasons (unparameterized transaction names, and unproper routing instrumentation come to mind).

Instead, you might want to just disable the webpack plugin and the implicit CLI call for @sentry/nextjs with the following options: https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#disable-sentrywebpackplugin

[gajus]

Feels like @sentry/cli should be a peer dependency, not a hard dependency of @sentry/nextjs, and a release should be attempted only if @sentry/cli is installed.

[lforst]

In terms of ease of use, this would be a definite downgrade.

[gajus]

Well it is a tradeoff. You are going to have broader coverage, but customers with more advance setup will be left out. Could also distribute a separate package @sentry/nextjs-instrument or something.

[lforst]

I don't fully understand yet how having @sentry/cli as a dependency is blocking or problematic for anybody. Would you mind explaining? Genuinely curious.

[mzavattaro]

@sentry/cli doesn't work in Docker containers using Alpine Linux. Do you know of a workaround @lforst?