feat(nextjs): Use Next.js generated serverside spans for app router rendering #12729
+370
−330
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
|
This is ready for review, just need to figure out why 1 e2e test is failing. |
chargome
reviewed
Jul 4, 2024
mydea
reviewed
Jul 4, 2024
chargome
approved these changes
Jul 4, 2024
size-limit report 📦
|
lforst
force-pushed
the
lforst-otel-for-nextjs
branch
from
8c2fe86
to
84d9bd7
Compare
mydea
reviewed
Jul 5, 2024
| }, | ||
| { | ||
| // This comes with the risk of tests leaking into each other but the tests run quite slow so we should parallelize | ||
| workers: '100%', |
There was a problem hiding this comment.
my thought was: If the tests leak, the tests are bad anyways.
mydea
reviewed
Jul 5, 2024
packages/nextjs/src/server/index.ts
Outdated
| } | ||
| }); | ||
|
|
||
| client?.on('spanEnd'); |
There was a problem hiding this comment.
Suggested change
| client?.on('spanEnd'); |
I guess this is a leftover? 😅
mydea
reviewed
Jul 5, 2024
| client?.on('beforeSampling', ({ spanAttributes, spanName, parentSampled, parentContext }, samplingDecision) => { | ||
| // We "whitelist" the "BaseServer.handleRequest" span, since that one is responsible for App Router requests, which are actually useful for us. |
There was a problem hiding this comment.
Suggested change
| // We "whitelist" the "BaseServer.handleRequest" span, since that one is responsible for App Router requests, which are actually useful for us. | |
| // We allowlist the "BaseServer.handleRequest" span, since that one is responsible for App Router requests, which are actually useful for us. |
chargome
reviewed
Jul 5, 2024
| const spanAttributes = spanToJSON(span).data; | ||
|
|
||
| // What we do in this glorious piece of code, is hoist any information about parameterized routes from spans emitted | ||
| // by Next.js via the `next.route` attribure, up to the transaction by setting the http.route attribute. |
There was a problem hiding this comment.
Suggested change
| // by Next.js via the `next.route` attribure, up to the transaction by setting the http.route attribute. | |
| // by Next.js via the `next.route` attribute, up to the transaction by setting the http.route attribute. |
chargome
approved these changes
Jul 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously when we attempted to use the OTEL tracing provided by Next.js we faced data quality issues. The problem was that we used to look at the data holistically and not in isolation. We discovered that certain data provided by Next.js is actually more accurate than the data we collect, in particular the data we collect for app router SSR requests.
With this PR we start using OTEL data for app router SSR requests. We do this by allow-listing spans created for these requests by Next.js so that we are only capturing these spans/traces.
With this PR, we're starting to use our/otel's HTTP instrumentation (only for app router SSR requests!) so we can capture the most accurate data.
There are a few gotchas:
Traces look like this now: