feat(nextjs): Add excludeServerRoutes config option
#6207
Conversation
size-limit report 📦
|
lobsterkatie
force-pushed
the
kmclb-nextjs-invert-serverside-injection-criteria
branch
from
78dc8b8 to
c98a180
Compare
lobsterkatie
force-pushed
the
kmclb-nextjs-add-excludeServerPages-option
branch
from
4d699da to
172f933
Compare
| // Exclude certain serverside API routes or pages from being instrumented with Sentry. This option takes an array of | ||
| // strings or regular expressions. | ||
| // | ||
| // NOTE: Pages should be specified as routes (`/animals` or `/api/animals/[animalType]/habitat`), not filepaths | ||
| // (`pages/animals/index.js` or `.\src\pages\api\animals\[animalType]\habitat.tsx`), and strings must be be a full, | ||
| // exact match. |
There was a problem hiding this comment.
m: Just something we should maybe think about: I am wondering if we should have users include "pages/" in the strings/regexes they provide here just to future-proof us against Next.js 13's app/ folder. However, the more I think about it it shouldn't matter, as the routes in the app/ folder will also just be routes like we have in the pages folder and I believe they can't collide - so we're probably good here.
There was a problem hiding this comment.
It's a good question, but I think you're right, a route is a route and you can't have two with the same route path. I also think that it's better that we abstract away the underlying file structure. That way, as users do move their routes from pages/ to app/, they won't have to come and update this setting.
lobsterkatie
force-pushed
the
kmclb-nextjs-invert-serverside-injection-criteria
branch
from
c98a180 to
d04f3bc
Compare
lobsterkatie
force-pushed
the
kmclb-nextjs-add-excludeServerPages-option
branch
from
172f933 to
7ec84be
Compare
lobsterkatie
force-pushed
the
kmclb-nextjs-invert-serverside-injection-criteria
branch
from
d04f3bc to
054796b
Compare
lobsterkatie
force-pushed
the
kmclb-nextjs-add-excludeServerPages-option
branch
from
7ec84be to
0e98d62
Compare
lobsterkatie
force-pushed
the
kmclb-nextjs-invert-serverside-injection-criteria
branch
from
054796b to
3eeff43
Compare
lobsterkatie
force-pushed
the
kmclb-nextjs-add-excludeServerPages-option
branch
from
0e98d62 to
a92e32f
Compare
…5789) This adds the new `excludeServerRoutes` option in the nextjs SDK (added in getsentry/sentry-javascript#6207) to the docs. It also pulls all of the auto-instrumentation config into its own section in the manual setup page. (Note: The only part of this which is actually new content is the `Opt Out of Auto-instrumentation on Specific Routes` section. Everything else is just stuff moving around.)
|
@lobsterkatie this doesn't seem to be working on the latest release. My api route is using the Vercel OG package with the experimental-edge runtime.
|
|
@zlwaterfield - you've got the new option in your webpack plugin options, where as it needs to be in the https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#extend-nextjs-configuration |
|
Wow I can't believe I missed that. Thank you for pointing that out. This PR is a life saver. |
…5789) This adds the new `excludeServerRoutes` option in the nextjs SDK (added in getsentry/sentry-javascript#6207) to the docs. It also pulls all of the auto-instrumentation config into its own section in the manual setup page. (Note: The only part of this which is actually new content is the `Opt Out of Auto-instrumentation on Specific Routes` section. Everything else is just stuff moving around.)
Currently, in the nextjs SDK, we inject the user's
Sentry.init()code (by way of theirsentry.server.config.jsfile) into all serverside routes. This adds a new option to thesentryobject innext.config.jswhich allows users to prevent specific routes from being instrumented in this way. In this option, excluded routes can be specified using either strings (which need to exactly match the route) or regexes.Note: Heavily inspired by #6125. h/t to @lforst for his work there. Compared to that PR, this one allows non-API routes to be excluded and allows excluded pages to be specified as routes rather than filepaths. (Using routes a) obviates the need for users to add
pages/to the beginning of every entry, b) abstracts away the differences between windows and POSIX paths, and c) futureproofs users' config values against underlying changes to project file organization.)Docs for this feature are being added in getsentry/sentry-docs#5789.
Fixes #6119.
Fixes #5964.
Fixes #5667.