[nextjs] Document behavior on Vercel

[lobsterkatie]

Core or SDK?

Platform/SDK

Which part? Which one?

@sentry/nextjs

Description

It's very common to deploy nextjs apps on Vercel, and the SDK has certain Vercel-specific requirements and behaviors, which we should document in a central location.

• Before auto-wrapping was turned on in 7.15, non-API pages weren't traced when deployed on Vercel.
• The webpack plugin is disabled in dev and preview environments on Vercel. (Can override with disableClientWebpackPlugin: false and/or disableServerWebpackPlugin: false. If so, have to make env vars work in those environments, too. That said, we should also discourage people from doing this. See fix(nextjs): Don't run webpack plugin on non-prod Vercel deployments sentry-javascript#5603, fix(vercel): add sentry env vars to all default environments in Vercel sentry#37649, and [nextjs] Improve webpack plugin enablement and warnings sentry-javascript#5619.)
• We should link to the Vercel integration docs (https://docs.sentry.io/product/integrations/deployment/vercel/).

Suggested Solution

See above.

[getsentry-release]

Routing to @getsentry/team-web-sdk-frontend for triage. ⏲️

[NathanielHill]

I just want to leave a comment to indicate why I think there is an important use case for this... staging

Our staging branch is considered a "Preview" environment in Vercel, however we do want to track staging releases and sourcemaps in Vercel to make sure and catch regressions and easily debugging things before they hit production.

[lforst]

I just want to leave a comment to indicate why I think there is an important use case for this... staging

Our staging branch is considered a "Preview" environment in Vercel, however we do want to track staging releases and sourcemaps in Vercel to make sure and catch regressions and easily debugging things before they hit production.

Yeah I agree, I generally would expect it to run on dev and preview environments too. I think we should change it back and just print better error messages when parameters like org or auth token are missing.

[NathanielHill]

I have a similar issue with Sentry<->GitHub integration as well.

It adds commit information and trace links to my releases... but only to production and I cannot find any configuration to also get this on staging.

@lforst

[lforst]

@NathanielHill Do you mind opening an issue for this over at https://github.com/getsentry/sentry describing the problem in detail? It will be routed to the correct team.