feat(nextjs): Add information about enable next instrumentation #11140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
3 tasks
Bundle ReportChanges will decrease total bundle size by 15 bytes ⬇️
|
lforst
approved these changes
Aug 26, 2024
vivianyentran
approved these changes
Aug 26, 2024
Comment on lines
+147
to
+148
| To set up this file, enable the Next.js instrumentation hook by setting the [`experimental.instrumentationHook`](https://nextjs.org/docs/app/api-reference/next-config-js/instrumentationHook) to `true` in your `next.config.js`. | ||
| Then add a `instrumentation.ts` file to the root directory of your Next.js application (or inside the `src` folder if you're using one) and add the following content: |
There was a problem hiding this comment.
Suggested change
| To set up this file, enable the Next.js instrumentation hook by setting the [`experimental.instrumentationHook`](https://nextjs.org/docs/app/api-reference/next-config-js/instrumentationHook) to `true` in your `next.config.js`. | |
| Then add a `instrumentation.ts` file to the root directory of your Next.js application (or inside the `src` folder if you're using one) and add the following content: | |
| To use this instrumentation, you need to explicitly enable the Next.js instrumentation hook in your `next.config.js` file by setting [`experimental.instrumentationHook`](https://nextjs.org/docs/app/api-reference/next-config-js/instrumentationHook) to `true`. | |
| Then, create an `instrumentation.ts` file in the root directory of your Next.js application (or inside the `src` folder, if you're using one) and add the following content: |
| @@ -144,7 +144,8 @@ We recommend you include your DSN directly in these three files. Alternatively y | |||
|
|
|||
| While the client initialization code will be injected into your application's client bundle by `withSentryConfig` which we set up earlier, | |||
| the configuration for the server and edge runtime needs to be imported from a [Next.js Instrumentation file](https://nextjs.org/docs/app/building-your-application/optimizing/instrumentation). | |||
| To set up this file, add a `instrumentation.ts` file to the root directory of your Next.js application (or inside the `src` folder if you're using one) and add the following content: | |||
| To set up this file, enable the Next.js instrumentation hook by setting the [`experimental.instrumentationHook`](https://nextjs.org/docs/app/api-reference/next-config-js/instrumentationHook) to `true` in your `next.config.js`. | |||
There was a problem hiding this comment.
Since this is required, can you also update the code snippet for next.config.js to include this? Otherwise I feel like it's still easy to miss for a user just skimming & copy-pasting the code samples
There was a problem hiding this comment.
It is technically not required, which is why I am also a bit on the fence about this change. Something is fishy with the user report.
There was a problem hiding this comment.
Should we add this then? I think it is a little bit more transparent if the users set this option themselves. But if the SDK enables instrumentationHook we could also document that this is enabled for them? Just for some context on what's going on in the background.
There was a problem hiding this comment.
I say we just merge this as is and all is fine.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Adding more information about enabling
instrumentationHookfirst. Based on this comment: getsentry/sentry-javascript#12044 (comment)IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: