Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
f1a69d7d
Unverified
Commit
f1a69d7d
authored
Oct 16, 2026
by
Tobias Koppers
Committed by
GitHub
Oct 16, 2026
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Revert "Keep requests through middleware in a single OpenTelemetry trace" (#100302)
Revert #100136
parent
15e8f35f
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
22 changed files
with
115 additions
and
992 deletions
+115
-992
base-server.ts
packages/next/src/server/base-server.ts
+2
-21
tracer.ts
packages/next/src/server/lib/trace/tracer.ts
+13
-32
next-server.ts
packages/next/src/server/next-server.ts
+18
-15
adapter.ts
packages/next/src/server/web/adapter.ts
+1
-29
forward-trace-context.test.ts
packages/next/src/server/web/forward-trace-context.test.ts
+0
-163
forward-trace-context.ts
packages/next/src/server/web/forward-trace-context.ts
+0
-90
page.tsx
...ir/otel-middleware-single-trace/app/headers-echo/page.tsx
+0
-22
layout.tsx
test/e2e/app-dir/otel-middleware-single-trace/app/layout.tsx
+0
-9
page.tsx
test/e2e/app-dir/otel-middleware-single-trace/app/page.tsx
+0
-3
page.tsx
...2e/app-dir/otel-middleware-single-trace/app/page/page.tsx
+0
-25
route.ts
...r/otel-middleware-single-trace/app/route-handler/route.ts
+0
-11
page.tsx
...p-dir/otel-middleware-single-trace/app/unmatched/page.tsx
+0
-19
instrumentation.ts
...e/app-dir/otel-middleware-single-trace/instrumentation.ts
+0
-7
middleware-impl.ts
...e/app-dir/otel-middleware-single-trace/middleware-impl.ts
+0
-41
next.config.ts
test/e2e/app-dir/otel-middleware-single-trace/next.config.ts
+0
-5
otel-middleware-single-trace.test.ts
...dleware-single-trace/otel-middleware-single-trace.test.ts
+0
-198
route.ts
...trumentation/app/behind-middleware/route-handler/route.ts
+0
-5
collector.ts
test/e2e/opentelemetry/instrumentation/collector.ts
+0
-12
custom-entrypoint-server.ts
...opentelemetry/instrumentation/custom-entrypoint-server.ts
+0
-4
middleware-node.ts
test/e2e/opentelemetry/instrumentation/middleware-node.ts
+0
-10
middleware.ts
test/e2e/opentelemetry/instrumentation/middleware.ts
+0
-10
opentelemetry.test.ts
test/e2e/opentelemetry/instrumentation/opentelemetry.test.ts
+81
-261
No files found.
packages/next/src/server/base-server.ts
View file @
f1a69d7d
...
...
@@ -908,26 +908,8 @@ export default abstract class Server<
'http.target'
:
req
.
url
,
},
},
async
(
span
)
=>
{
if
(
getRequestMeta
(
req
,
'middlewareInvoke'
))
{
// When middleware lets the request continue, the router server
// calls `handleRequest` twice: once to run middleware (this pass)
// and once to render. Publish this span's W3C trace context on
// the request, so the middleware span (including the Edge
// sandbox, which extracts it from the request headers) is a
// child of this span instead of starting a new trace. The
// middleware forwards its own span's context to the render pass
// via request-header overrides, which replace this value; it
// only stays when there is no middleware span to forward (e.g.
// OpenTelemetry isn't registered in the Edge runtime), keeping
// the render in this trace.
const
traceContext
=
tracer
.
getTraceContextHeaders
()
if
(
traceContext
)
{
Object
.
assign
(
req
.
headers
,
traceContext
)
}
}
return
this
.
handleRequestImpl
(
req
,
res
,
parsedUrl
).
finally
(()
=>
{
async
(
span
)
=>
this
.
handleRequestImpl
(
req
,
res
,
parsedUrl
).
finally
(()
=>
{
if
(
!
span
)
return
const
isRSCRequest
=
getRequestMeta
(
req
,
'isRSCRequest'
)
??
false
...
...
@@ -986,7 +968,6 @@ export default abstract class Server<
span
.
updateName
(
isRSCRequest
?
`RSC
${
method
}
`
:
`
${
method
}
`
)
}
})
}
)
})
...
...
packages/next/src/server/lib/trace/tracer.ts
View file @
f1a69d7d
...
...
@@ -178,14 +178,6 @@ interface NextTracer {
*/
getTracePropagationData
():
ClientTraceDataEntry
[]
/**
* Returns the W3C trace context (`traceparent` / `tracestate`) of the
* currently active context, as produced by the configured propagator.
* Returns `undefined` when OpenTelemetry is not enabled, no span context is
* active, or the propagator doesn't produce a `traceparent`.
*/
getTraceContextHeaders
():
TraceContextHeaders
|
undefined
/**
* Executes a function with the given span set as the active span in the context.
* This allows child spans created within the function to automatically parent to this span.
...
...
@@ -219,11 +211,6 @@ export interface ClientTraceDataEntry {
value
:
string
}
export
interface
TraceContextHeaders
{
traceparent
:
string
tracestate
?:
string
}
const
clientTraceDataSetter
:
TextMapSetter
<
ClientTraceDataEntry
[]
>
=
{
set
(
carrier
,
key
,
value
)
{
carrier
.
push
({
...
...
@@ -273,25 +260,6 @@ class NextTracerImpl implements NextTracer {
return
entries
}
public
getTraceContextHeaders
():
TraceContextHeaders
|
undefined
{
const
activeContext
=
context
.
active
()
if
(
!
trace
.
getSpanContext
(
activeContext
)
||
!
this
.
isOpenTelemetryEnabled
()
)
{
return
undefined
}
const
carrier
:
Record
<
string
,
string
>
=
{}
propagation
.
inject
(
activeContext
,
carrier
)
const
{
traceparent
,
tracestate
}
=
carrier
if
(
!
traceparent
)
{
return
undefined
}
return
tracestate
?
{
traceparent
,
tracestate
}
:
{
traceparent
}
}
public
getActiveScopeSpan
():
Span
|
undefined
{
const
localSpanRecorder
=
getLocalSpanRecorder
()
const
activeLocalSpan
=
localSpanRecorder
?.
getActiveLocalSpan
()
...
...
@@ -309,6 +277,19 @@ class NextTracerImpl implements NextTracer {
return
activeLocalSpan
}
/**
* Run `fn` with the active span cleared, so spans created inside become new
* roots (or parent to incoming propagated context). Used for in-process
* Node.js middleware so its span is a sibling of the request span, matching
* edge middleware which runs in a detached sandbox.
*/
public
runWithDetachedContext
<
T
>
(
fn
:
()
=>
T
):
T
{
if
(
!
NEXT_OTEL_PERFORMANCE_PREFIX
&&
!
this
.
isOpenTelemetryEnabled
())
{
return
fn
()
}
return
context
.
with
(
ROOT_CONTEXT
,
fn
)
}
public
withPropagatedContext
<
T
,
C
>
(
carrier
:
C
,
fn
:
()
=>
T
,
...
...
packages/next/src/server/next-server.ts
View file @
f1a69d7d
...
...
@@ -1867,21 +1867,24 @@ export default class NextNodeServer extends BaseServer<
try
{
// Node.js middleware runs in-process, inside the active
// `handleRequest` span, so the middleware span (and the trace context
// it forwards to the render) stays in the request's trace.
result
=
await
adapterFn
({
handler
:
middlewareModule
.
proxy
||
middlewareModule
.
middleware
||
middlewareModule
,
request
:
{
...
requestData
,
body
:
hasRequestBody
?
requestData
.
body
.
cloneBodyStream
()
:
undefined
,
},
page
:
'middleware'
,
})
// `handleRequest` span. Detach that span so the middleware span
// becomes a sibling root (or parents to an incoming traceparent),
// matching edge middleware which runs in a detached sandbox.
result
=
await
getTracer
().
runWithDetachedContext
(()
=>
adapterFn
({
handler
:
middlewareModule
.
proxy
||
middlewareModule
.
middleware
||
middlewareModule
,
request
:
{
...
requestData
,
body
:
hasRequestBody
?
requestData
.
body
.
cloneBodyStream
()
:
undefined
,
},
page
:
'middleware'
,
})
)
}
finally
{
if
(
hasRequestBody
)
{
await
requestData
.
body
.
finalize
()
...
...
packages/next/src/server/web/adapter.ts
View file @
f1a69d7d
...
...
@@ -30,11 +30,10 @@ import { workAsyncStorage } from '../app-render/work-async-storage.external'
import
{
InvariantError
}
from
'../../shared/lib/invariant-error'
import
type
{
ResolvedCacheLifeProfiles
}
from
'../config-shared'
import
{
NEXT_ROUTER_PREFETCH_HEADER
}
from
'../../client/components/app-router-headers'
import
{
getTracer
,
type
TraceContextHeaders
}
from
'../lib/trace/tracer'
import
{
getTracer
}
from
'../lib/trace/tracer'
import
type
{
TextMapGetter
}
from
'next/dist/compiled/@opentelemetry/api'
import
{
MiddlewareSpan
}
from
'../lib/trace/constants'
import
{
CloseController
}
from
'./web-on-close'
import
{
forwardTraceContextToRequest
}
from
'./forward-trace-context'
import
{
getEdgePreviewProps
}
from
'./get-edge-preview-props'
import
{
getBuiltinRequestContext
}
from
'../after/builtin-request-context'
import
{
getImplicitTags
}
from
'../lib/implicit-tags'
...
...
@@ -267,11 +266,6 @@ export async function adapter(
})
let
response
let
cookiesFromResponse
// The middleware span's trace context to forward to the downstream request
// (see `forwardTraceContextToRequest`), and the request headers as the
// middleware received them.
let
forwardedTraceContext
:
TraceContextHeaders
|
undefined
let
forwardedRequestHeaders
:
Headers
|
undefined
response
=
await
propagator
(
request
,
()
=>
{
// we only care to make async storage available for middleware
...
...
@@ -299,16 +293,6 @@ export async function adapter(
},
},
async
()
=>
{
// Forward the middleware span's own context, so the render is always
// nested inside the middleware span, whatever the middleware span is
// parented to (an incoming `traceparent`, a host span, next-server's
// `handleRequest` span, or nothing).
forwardedTraceContext
=
getTracer
().
getTraceContextHeaders
()
if
(
forwardedTraceContext
)
{
// Snapshot before the handler can mutate `request.headers`.
forwardedRequestHeaders
=
new
Headers
(
request
.
headers
)
}
try
{
const
onUpdateCookies
=
(
cookies
:
Array
<
string
>
)
=>
{
cookiesFromResponse
=
cookies
...
...
@@ -536,18 +520,6 @@ export async function adapter(
const
finalResponse
=
response
?
response
:
NextResponse
.
next
()
if
(
forwardedRequestHeaders
)
{
// Nest the downstream request (render) inside the middleware span. Every
// host applies these request-header overrides to the render, including
// next-server's router server, so this works whether or not the host
// invokes the middleware separately from the render.
forwardTraceContextToRequest
(
finalResponse
.
headers
,
forwardedRequestHeaders
,
forwardedTraceContext
)
}
// Flight headers are not overridable / removable so they are applied at the end.
const
middlewareOverrideHeaders
=
finalResponse
.
headers
.
get
(
'x-middleware-override-headers'
...
...
packages/next/src/server/web/forward-trace-context.test.ts
deleted
100644 → 0
View file @
15e8f35f
import
{
forwardTraceContextToRequest
}
from
'./forward-trace-context'
import
{
NextResponse
}
from
'./spec-extension/response'
const
TRACEPARENT
=
'00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01'
const
TRACESTATE
=
'vendor=value'
function
requestOverrides
(
headers
:
Headers
)
{
const
list
=
headers
.
get
(
'x-middleware-override-headers'
)
if
(
list
===
null
)
return
undefined
return
Object
.
fromEntries
(
list
.
split
(
','
)
.
filter
(
Boolean
)
.
map
((
key
)
=>
[
key
,
headers
.
get
(
`x-middleware-request-
${
key
}
`
)])
)
}
describe
(
'forwardTraceContextToRequest'
,
()
=>
{
const
requestHeaders
=
()
=>
new
Headers
({
accept
:
'text/html'
,
cookie
:
'a=b'
,
'x-custom'
:
'custom'
})
it
(
'lists every request header plus the trace context without user overrides'
,
()
=>
{
const
response
=
NextResponse
.
next
()
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
{
traceparent
:
TRACEPARENT
,
tracestate
:
TRACESTATE
,
})
expect
(
requestOverrides
(
response
.
headers
)).
toEqual
({
accept
:
'text/html'
,
cookie
:
'a=b'
,
'x-custom'
:
'custom'
,
traceparent
:
TRACEPARENT
,
tracestate
:
TRACESTATE
,
})
})
it
(
'replaces a traceparent the middleware received when there are no user overrides'
,
()
=>
{
const
headers
=
requestHeaders
()
headers
.
set
(
'traceparent'
,
'00-11111111111111111111111111111111-2222222222222222-01'
)
const
response
=
NextResponse
.
next
()
forwardTraceContextToRequest
(
response
.
headers
,
headers
,
{
traceparent
:
TRACEPARENT
,
})
const
overrides
=
requestOverrides
(
response
.
headers
)
!
expect
(
overrides
.
traceparent
).
toBe
(
TRACEPARENT
)
expect
(
response
.
headers
.
get
(
'x-middleware-override-headers'
)
!
.
split
(
','
)
.
filter
((
key
)
=>
key
===
'traceparent'
)
).
toHaveLength
(
1
)
})
it
(
'works for rewrites'
,
()
=>
{
const
response
=
NextResponse
.
rewrite
(
new
URL
(
'https://example.com/other'
))
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
{
traceparent
:
TRACEPARENT
,
})
expect
(
requestOverrides
(
response
.
headers
)?.
traceparent
).
toBe
(
TRACEPARENT
)
})
it
(
'only appends the trace context to existing user overrides'
,
()
=>
{
const
userHeaders
=
new
Headers
({
'x-user'
:
'user'
})
const
response
=
NextResponse
.
next
({
request
:
{
headers
:
userHeaders
}
})
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
{
traceparent
:
TRACEPARENT
,
tracestate
:
TRACESTATE
,
})
expect
(
requestOverrides
(
response
.
headers
)).
toEqual
({
'x-user'
:
'user'
,
traceparent
:
TRACEPARENT
,
tracestate
:
TRACESTATE
,
})
})
it
(
'keeps a traceparent explicitly set by the user'
,
()
=>
{
const
userTraceparent
=
'00-33333333333333333333333333333333-4444444444444444-01'
const
response
=
NextResponse
.
next
({
request
:
{
headers
:
new
Headers
({
traceparent
:
userTraceparent
})
},
})
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
{
traceparent
:
TRACEPARENT
,
tracestate
:
TRACESTATE
,
})
expect
(
requestOverrides
(
response
.
headers
)).
toEqual
({
traceparent
:
userTraceparent
,
tracestate
:
TRACESTATE
,
})
})
it
(
'replaces trace context headers copied unchanged into user overrides'
,
()
=>
{
const
receivedTraceparent
=
'00-11111111111111111111111111111111-2222222222222222-01'
const
received
=
requestHeaders
()
received
.
set
(
'traceparent'
,
receivedTraceparent
)
received
.
set
(
'tracestate'
,
'received=1'
)
// The common `new Headers(request.headers)` pattern copies the received
// trace context into the overrides without choosing it.
const
userHeaders
=
new
Headers
(
received
)
userHeaders
.
set
(
'x-user'
,
'user'
)
const
response
=
NextResponse
.
next
({
request
:
{
headers
:
userHeaders
}
})
forwardTraceContextToRequest
(
response
.
headers
,
received
,
{
traceparent
:
TRACEPARENT
,
tracestate
:
TRACESTATE
,
})
const
overrides
=
requestOverrides
(
response
.
headers
)
!
expect
(
overrides
.
traceparent
).
toBe
(
TRACEPARENT
)
expect
(
overrides
.
tracestate
).
toBe
(
TRACESTATE
)
expect
(
overrides
[
'x-user'
]).
toBe
(
'user'
)
expect
(
response
.
headers
.
get
(
'x-middleware-override-headers'
)
!
.
split
(
','
)
.
filter
((
key
)
=>
key
===
'traceparent'
||
key
===
'tracestate'
)
).
toEqual
([
'traceparent'
,
'tracestate'
])
})
it
(
'treats an empty user override list like no overrides'
,
()
=>
{
const
response
=
NextResponse
.
next
({
request
:
{
headers
:
new
Headers
()
}
})
expect
(
response
.
headers
.
get
(
'x-middleware-override-headers'
)).
toBe
(
''
)
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
{
traceparent
:
TRACEPARENT
,
})
expect
(
requestOverrides
(
response
.
headers
)).
toEqual
({
accept
:
'text/html'
,
cookie
:
'a=b'
,
'x-custom'
:
'custom'
,
traceparent
:
TRACEPARENT
,
})
})
it
(
'does nothing without a trace context'
,
()
=>
{
const
response
=
NextResponse
.
next
()
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
undefined
)
expect
(
requestOverrides
(
response
.
headers
)).
toBeUndefined
()
expect
([...
response
.
headers
.
keys
()]).
toEqual
([
'x-middleware-next'
])
})
it
.
each
([
[
'a redirect'
,
()
=>
NextResponse
.
redirect
(
'https://example.com/'
)],
[
'a direct response'
,
()
=>
new
NextResponse
(
'hello'
)],
])(
'does nothing for %s'
,
(
_
,
createResponse
)
=>
{
const
response
=
createResponse
()
const
before
=
[...
response
.
headers
.
entries
()]
forwardTraceContextToRequest
(
response
.
headers
,
requestHeaders
(),
{
traceparent
:
TRACEPARENT
,
})
expect
([...
response
.
headers
.
entries
()]).
toEqual
(
before
)
})
})
packages/next/src/server/web/forward-trace-context.ts
deleted
100644 → 0
View file @
15e8f35f
import
type
{
TraceContextHeaders
}
from
'../lib/trace/tracer'
const
OVERRIDE_HEADERS
=
'x-middleware-override-headers'
const
REQUEST_HEADER_PREFIX
=
'x-middleware-request-'
/**
* Forwards the middleware's W3C trace context to the downstream request by
* adding `traceparent` / `tracestate` request-header overrides to a middleware
* response that continues the request (`NextResponse.next()` or a rewrite).
*
* Every host applies these overrides to the downstream request: hosts that
* invoke middleware separately from the render (deployments, adapters, direct
* entrypoints) as well as next-server's router server. Forwarding the
* middleware span's context therefore nests the render inside the middleware
* span instead of starting a new trace.
*
* Request-header overrides replace the whole downstream request header set,
* so:
* - Without user overrides (or with an empty list, which hosts ignore), every
* request header the middleware received is listed (unchanged) alongside
* the trace context.
* - With user overrides, they are kept and only the trace context headers are
* added. A trace context header the user explicitly set (to a value other
* than the one the middleware received) wins. One copied unchanged from the
* request (e.g. via `new Headers(request.headers)`) is replaced, as it is no
* explicit choice.
*/
export
function
forwardTraceContextToRequest
(
responseHeaders
:
Headers
,
requestHeaders
:
Headers
,
traceContext
:
TraceContextHeaders
|
undefined
):
void
{
if
(
!
traceContext
)
{
return
}
// Redirects and direct responses have no downstream request.
if
(
!
responseHeaders
.
has
(
'x-middleware-next'
)
&&
!
responseHeaders
.
has
(
'x-middleware-rewrite'
)
)
{
return
}
const
traceHeaders
:
Array
<
[
string
,
string
]
>
=
[
[
'traceparent'
,
traceContext
.
traceparent
],
]
if
(
traceContext
.
tracestate
)
{
traceHeaders
.
push
([
'tracestate'
,
traceContext
.
tracestate
])
}
const
userOverrides
=
responseHeaders
.
get
(
OVERRIDE_HEADERS
)
// An empty override list is ignored by hosts (no headers are replaced), so
// treat it like no overrides rather than turning it into "only the trace
// context headers".
if
(
!
userOverrides
)
{
const
keys
:
string
[]
=
[]
for
(
const
[
key
,
value
]
of
requestHeaders
)
{
responseHeaders
.
set
(
REQUEST_HEADER_PREFIX
+
key
,
value
)
keys
.
push
(
key
)
}
for
(
const
[
key
,
value
]
of
traceHeaders
)
{
responseHeaders
.
set
(
REQUEST_HEADER_PREFIX
+
key
,
value
)
if
(
!
keys
.
includes
(
key
))
{
keys
.
push
(
key
)
}
}
responseHeaders
.
set
(
OVERRIDE_HEADERS
,
keys
.
join
(
','
))
return
}
const
keys
=
userOverrides
.
split
(
','
)
.
map
((
key
)
=>
key
.
trim
())
.
filter
(
Boolean
)
for
(
const
[
key
,
value
]
of
traceHeaders
)
{
if
(
keys
.
includes
(
key
))
{
if
(
responseHeaders
.
get
(
REQUEST_HEADER_PREFIX
+
key
)
!==
requestHeaders
.
get
(
key
)
)
{
continue
}
}
else
{
keys
.
push
(
key
)
}
responseHeaders
.
set
(
REQUEST_HEADER_PREFIX
+
key
,
value
)
}
responseHeaders
.
set
(
OVERRIDE_HEADERS
,
keys
.
join
(
','
))
}
test/e2e/app-dir/otel-middleware-single-trace/app/headers-echo/page.tsx
deleted
100644 → 0
View file @
15e8f35f
import
{
trace
}
from
'@opentelemetry/api'
import
{
headers
}
from
'next/headers'
import
{
Suspense
}
from
'react'
async
function
RequestInfo
()
{
const
requestHeaders
=
Object
.
fromEntries
((
await
headers
()).
entries
())
const
traceId
=
trace
.
getActiveSpan
()?.
spanContext
().
traceId
??
'none'
return
(
<>
<
p
id=
"trace-id"
>
{
traceId
}
</
p
>
<
pre
id=
"headers"
>
{
JSON
.
stringify
(
requestHeaders
)
}
</
pre
>
</>
)
}
export
default
function
Page
()
{
return
(
<
Suspense
>
<
RequestInfo
/>
</
Suspense
>
)
}
test/e2e/app-dir/otel-middleware-single-trace/app/layout.tsx
deleted
100644 → 0
View file @
15e8f35f
import
type
{
ReactNode
}
from
'react'
export
default
function
Root
({
children
}:
{
children
:
ReactNode
})
{
return
(
<
html
>
<
body
>
{
children
}
</
body
>
</
html
>
)
}
test/e2e/app-dir/otel-middleware-single-trace/app/page.tsx
deleted
100644 → 0
View file @
15e8f35f
export
default
function
Home
()
{
return
<
p
>
otel-middleware-single-trace
</
p
>
}
test/e2e/app-dir/otel-middleware-single-trace/app/page/page.tsx
deleted
100644 → 0
View file @
15e8f35f
import
{
trace
}
from
'@opentelemetry/api'
import
{
headers
}
from
'next/headers'
import
{
Suspense
}
from
'react'
async
function
TraceInfo
()
{
// Reading request headers also makes this run at request time, so the
// reported trace belongs to the request.
const
traceparent
=
(
await
headers
()).
get
(
'traceparent'
)
??
'none'
const
traceId
=
trace
.
getActiveSpan
()?.
spanContext
().
traceId
??
'none'
return
(
<>
<
p
id=
"trace-id"
>
{
traceId
}
</
p
>
{
/* The trace context the render was started from (its parent span). */
}
<
p
id=
"traceparent"
>
{
traceparent
}
</
p
>
</>
)
}
export
default
function
Page
()
{
return
(
<
Suspense
>
<
TraceInfo
/>
</
Suspense
>
)
}
test/e2e/app-dir/otel-middleware-single-trace/app/route-handler/route.ts
deleted
100644 → 0
View file @
15e8f35f
import
{
trace
}
from
'@opentelemetry/api'
import
{
connection
}
from
'next/server'
export
async
function
GET
(
request
:
Request
)
{
// Run at request time so the reported trace belongs to the request.
await
connection
()
const
traceId
=
trace
.
getActiveSpan
()?.
spanContext
().
traceId
??
'none'
// The trace context the render was started from (its parent span).
const
traceparent
=
request
.
headers
.
get
(
'traceparent'
)
??
'none'
return
Response
.
json
({
traceId
,
traceparent
})
}
test/e2e/app-dir/otel-middleware-single-trace/app/unmatched/page.tsx
deleted
100644 → 0
View file @
15e8f35f
import
{
trace
}
from
'@opentelemetry/api'
import
{
connection
}
from
'next/server'
import
{
Suspense
}
from
'react'
async
function
TraceId
()
{
// Run at request time so the reported trace belongs to the request.
await
connection
()
const
traceId
=
trace
.
getActiveSpan
()?.
spanContext
().
traceId
??
'none'
return
<
p
id=
"trace-id"
>
{
traceId
}
</
p
>
}
// Not matched by the middleware: a baseline for requests without middleware.
export
default
function
Page
()
{
return
(
<
Suspense
>
<
TraceId
/>
</
Suspense
>
)
}
test/e2e/app-dir/otel-middleware-single-trace/instrumentation.ts
deleted
100644 → 0
View file @
15e8f35f
import
{
registerOTel
}
from
'@vercel/otel'
export
function
register
()
{
// No exporter is needed: the app itself reports the active trace IDs, so the
// suite also works when deployed (where no local collector is reachable).
registerOTel
({
serviceName
:
'otel-middleware-single-trace'
})
}
test/e2e/app-dir/otel-middleware-single-trace/middleware-impl.ts
deleted
100644 → 0
View file @
15e8f35f
import
{
trace
}
from
'@opentelemetry/api'
import
{
NextResponse
,
type
NextRequest
}
from
'next/server'
export
const
USER_TRACE_ID
=
'0af7651916cd43dd8448eb211c80319c'
export
const
USER_SPAN_ID
=
'b7ad6b7169203331'
// Shared by `proxy.ts` (Node.js runtime) and `middleware.ts` (Edge runtime).
export
function
handler
(
request
:
NextRequest
)
{
const
spanContext
=
trace
.
getActiveSpan
()?.
spanContext
()
const
traceId
=
spanContext
?.
traceId
??
'none'
const
spanId
=
spanContext
?.
spanId
??
'none'
const
{
pathname
}
=
request
.
nextUrl
let
response
:
NextResponse
if
(
pathname
===
'/rewrite'
)
{
response
=
NextResponse
.
rewrite
(
new
URL
(
'/page'
,
request
.
url
))
}
else
if
(
pathname
===
'/redirect'
)
{
response
=
NextResponse
.
redirect
(
new
URL
(
'/page'
,
request
.
url
))
}
else
if
(
pathname
===
'/direct'
)
{
response
=
new
NextResponse
(
'direct response from middleware'
)
}
else
if
(
pathname
===
'/user-overrides'
)
{
const
headers
=
new
Headers
(
request
.
headers
)
headers
.
set
(
'x-user-added'
,
'added-by-middleware'
)
headers
.
delete
(
'x-delete-me'
)
response
=
NextResponse
.
rewrite
(
new
URL
(
'/headers-echo'
,
request
.
url
),
{
request
:
{
headers
},
})
}
else
if
(
pathname
===
'/user-traceparent'
)
{
const
headers
=
new
Headers
(
request
.
headers
)
headers
.
set
(
'traceparent'
,
`00-
${
USER_TRACE_ID
}
-
${
USER_SPAN_ID
}
-01`
)
response
=
NextResponse
.
rewrite
(
new
URL
(
'/headers-echo'
,
request
.
url
),
{
request
:
{
headers
},
})
}
else
{
response
=
NextResponse
.
next
()
}
response
.
headers
.
set
(
'x-mw-trace-id'
,
traceId
)
response
.
headers
.
set
(
'x-mw-span-id'
,
spanId
)
return
response
}
test/e2e/app-dir/otel-middleware-single-trace/next.config.ts
deleted
100644 → 0
View file @
15e8f35f
import
type
{
NextConfig
}
from
'next'
const
nextConfig
:
NextConfig
=
{}
export
default
nextConfig
test/e2e/app-dir/otel-middleware-single-trace/otel-middleware-single-trace.test.ts
deleted
100644 → 0
View file @
15e8f35f
import
{
isNextDeploy
,
nextTestSetup
}
from
'e2e-utils'
import
cheerio
from
'cheerio'
const
USER_TRACE_ID
=
'0af7651916cd43dd8448eb211c80319c'
const
INCOMING_TRACE_ID
=
'4bf92f3577b34da6a3ce929d0e0e4736'
const
INCOMING_TRACEPARENT
=
`00-
${
INCOMING_TRACE_ID
}
-00f067aa0ba902b7-01`
const
TRACE_ID
=
/^
(?!
0
{32}
$
)[
0-9a-f
]{32}
$/
const
SPAN_ID
=
/^
(?!
0
{16}
$
)[
0-9a-f
]{16}
$/
const
MATCHER
=
[
'/page'
,
'/route-handler'
,
'/rewrite'
,
'/redirect'
,
'/direct'
,
'/user-overrides'
,
'/user-traceparent'
,
]
// The middleware entry file is generated per variant: `config` must be a
// static literal in the entry file itself, and the shared implementation is
// imported relative to the app root, where the entry file is written.
function
middlewareEntry
(
exportName
:
'proxy'
|
'middleware'
)
{
return
[
`import type { NextRequest } from 'next/server'`
,
`import { handler } from './middleware-impl'`
,
``
,
`export function
${
exportName
}
(request: NextRequest) {`
,
` return handler(request)`
,
`}`
,
``
,
`export const config = { matcher:
${
JSON
.
stringify
(
MATCHER
)}
}`
,
``
,
].
join
(
'
\
n'
)
}
// The app reports its active trace IDs itself (no local collector), so these
// assertions also hold when deployed. Every request that passes through
// middleware must stay in a single trace: the trace ID seen by the middleware
// has to be the one seen by the page / route handler that renders afterwards.
// The render must also be nested inside the middleware span: the trace context
// it was started from (the `traceparent` it received) is the middleware span.
describe
.
each
([
// `proxy.ts` always runs in the Node.js runtime.
{
name
:
'proxy (nodejs runtime)'
,
file
:
'proxy.ts'
,
exportName
:
'proxy'
},
// `middleware.ts` defaults to the edge runtime.
{
name
:
'middleware (edge runtime)'
,
file
:
'middleware.ts'
,
exportName
:
'middleware'
,
},
]
as
const
)(
'otel-middleware-single-trace - $name'
,
({
file
,
exportName
})
=>
{
const
{
next
}
=
nextTestSetup
({
files
:
__dirname
,
overrideFiles
:
{
[
file
]:
middlewareEntry
(
exportName
),
},
dependencies
:
{
'@vercel/otel'
:
'2.1.3'
,
'@opentelemetry/api'
:
'1.9.1'
,
'@opentelemetry/api-logs'
:
'0.223.0'
,
'@opentelemetry/instrumentation'
:
'0.223.0'
,
'@opentelemetry/resources'
:
'2.12.0'
,
'@opentelemetry/sdk-logs'
:
'0.223.0'
,
'@opentelemetry/sdk-metrics'
:
'2.12.0'
,
'@opentelemetry/sdk-trace-base'
:
'2.12.0'
,
},
})
function
getMiddlewareTraceId
(
res
:
Response
)
{
const
traceId
=
res
.
headers
.
get
(
'x-mw-trace-id'
)
expect
(
traceId
).
toMatch
(
TRACE_ID
)
return
traceId
}
// Asserts the render is in the middleware's trace and a direct child of the
// middleware span.
function
expectNestedInMiddleware
(
res
:
Response
,
render
:
{
traceId
:
string
;
traceparent
:
string
}
)
{
const
traceId
=
getMiddlewareTraceId
(
res
)
const
spanId
=
res
.
headers
.
get
(
'x-mw-span-id'
)
expect
(
spanId
).
toMatch
(
SPAN_ID
)
expect
(
render
.
traceId
).
toBe
(
traceId
)
const
[,
parentTraceId
,
parentSpanId
]
=
render
.
traceparent
.
split
(
'-'
)
expect
({
parentTraceId
,
parentSpanId
}).
toEqual
({
parentTraceId
:
traceId
,
parentSpanId
:
spanId
,
})
}
async
function
getPageTrace
(
res
:
Response
)
{
const
$
=
cheerio
.
load
(
await
res
.
text
())
return
{
traceId
:
$
(
'#trace-id'
).
text
(),
traceparent
:
$
(
'#traceparent'
).
text
(),
}
}
function
expectNoInternalHeaders
(
res
:
Response
)
{
for
(
const
key
of
res
.
headers
.
keys
())
{
expect
(
key
).
not
.
toMatch
(
/^x-middleware-
(
request-|override-headers
)
/
)
}
}
it
(
'nests a page rendered after NextResponse.next() in the middleware span'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/page'
)
expect
(
res
.
status
).
toBe
(
200
)
expectNestedInMiddleware
(
res
,
await
getPageTrace
(
res
))
expectNoInternalHeaders
(
res
)
})
it
(
'nests a route handler executed after NextResponse.next() in the middleware span'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/route-handler'
)
expect
(
res
.
status
).
toBe
(
200
)
expectNestedInMiddleware
(
res
,
await
res
.
json
())
expectNoInternalHeaders
(
res
)
})
it
(
'nests a rewritten page in the middleware span'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/rewrite'
)
expect
(
res
.
status
).
toBe
(
200
)
expectNestedInMiddleware
(
res
,
await
getPageTrace
(
res
))
expectNoInternalHeaders
(
res
)
})
it
(
'traces a middleware redirect'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/redirect'
,
{
redirect
:
'manual'
})
expect
(
res
.
status
).
toBe
(
307
)
getMiddlewareTraceId
(
res
)
expectNoInternalHeaders
(
res
)
})
it
(
'traces a direct middleware response'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/direct'
)
expect
(
res
.
status
).
toBe
(
200
)
expect
(
await
res
.
text
()).
toBe
(
'direct response from middleware'
)
getMiddlewareTraceId
(
res
)
expectNoInternalHeaders
(
res
)
})
it
(
'traces a request the middleware does not match'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/unmatched'
)
expect
(
res
.
status
).
toBe
(
200
)
expect
(
res
.
headers
.
get
(
'x-mw-trace-id'
)).
toBeNull
()
const
$
=
cheerio
.
load
(
await
res
.
text
())
expect
(
$
(
'#trace-id'
).
text
()).
toMatch
(
TRACE_ID
)
expectNoInternalHeaders
(
res
)
})
it
.
each
([
'/page'
,
'/route-handler'
,
'/rewrite'
])(
'nests %s in the middleware span with an incoming traceparent'
,
async
(
pathname
)
=>
{
const
res
=
await
next
.
fetch
(
pathname
,
{
headers
:
{
traceparent
:
INCOMING_TRACEPARENT
},
})
expect
(
res
.
status
).
toBe
(
200
)
const
render
=
pathname
===
'/route-handler'
?
await
res
.
json
()
:
await
getPageTrace
(
res
)
expectNestedInMiddleware
(
res
,
render
)
// Self-hosted Next.js continues the caller's trace. When deployed, the
// platform decides whether a client-supplied traceparent is trusted, so
// only the single-trace and nesting guarantees are asserted there.
if
(
!
isNextDeploy
)
{
expect
(
render
.
traceId
).
toBe
(
INCOMING_TRACE_ID
)
}
expectNoInternalHeaders
(
res
)
}
)
it
(
'still applies request header overrides set by middleware'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/user-overrides'
,
{
headers
:
{
'x-delete-me'
:
'please'
,
'x-keep-me'
:
'kept'
},
})
expect
(
res
.
status
).
toBe
(
200
)
const
$
=
cheerio
.
load
(
await
res
.
text
())
const
headers
=
JSON
.
parse
(
$
(
'#headers'
).
text
())
expect
(
headers
[
'x-user-added'
]).
toBe
(
'added-by-middleware'
)
expect
(
headers
[
'x-keep-me'
]).
toBe
(
'kept'
)
expect
(
headers
[
'x-delete-me'
]).
toBeUndefined
()
expectNestedInMiddleware
(
res
,
{
traceId
:
$
(
'#trace-id'
).
text
(),
traceparent
:
headers
[
'traceparent'
],
})
expectNoInternalHeaders
(
res
)
})
it
(
'respects a traceparent explicitly set by middleware'
,
async
()
=>
{
const
res
=
await
next
.
fetch
(
'/user-traceparent'
)
expect
(
res
.
status
).
toBe
(
200
)
const
$
=
cheerio
.
load
(
await
res
.
text
())
expect
(
$
(
'#trace-id'
).
text
()).
toBe
(
USER_TRACE_ID
)
expectNoInternalHeaders
(
res
)
})
})
test/e2e/opentelemetry/instrumentation/app/behind-middleware/route-handler/route.ts
deleted
100644 → 0
View file @
15e8f35f
export
async
function
GET
()
{
return
new
Response
(
JSON
.
stringify
({
behind
:
'middleware'
}))
}
export
const
dynamic
=
'force-dynamic'
test/e2e/opentelemetry/instrumentation/collector.ts
View file @
f1a69d7d
...
...
@@ -3,12 +3,6 @@ import { SavedSpan } from './constants'
export
interface
Collector
{
getSpans
:
()
=>
SavedSpan
[]
/**
* Like `getSpans`, but also includes spans marked `next.bubble` (e.g.
* next-server's middleware-invoke `handleRequest` span), which are needed to
* check the full span hierarchy of a request.
*/
getAllSpans
:
()
=>
SavedSpan
[]
reset
:
()
=>
void
shutdown
:
()
=>
Promise
<
void
>
}
...
...
@@ -19,7 +13,6 @@ export async function connectCollector({
port
:
number
}):
Promise
<
Collector
>
{
const
spans
:
SavedSpan
[]
=
[]
const
allSpans
:
SavedSpan
[]
=
[]
const
server
=
new
HttpServer
(
async
(
req
,
res
)
=>
{
if
(
req
.
method
!==
'POST'
)
{
...
...
@@ -40,7 +33,6 @@ export async function connectCollector({
})
const
newSpans
=
JSON
.
parse
(
body
.
toString
(
'utf-8'
))
as
SavedSpan
[]
allSpans
.
push
(...
newSpans
)
const
filteredSpans
=
newSpans
.
filter
((
span
)
=>
{
if
(
span
.
attributes
?.[
'next.bubble'
]
===
true
)
{
return
false
...
...
@@ -69,12 +61,8 @@ export async function connectCollector({
getSpans
()
{
return
spans
},
getAllSpans
()
{
return
allSpans
},
reset
()
{
spans
.
length
=
0
allSpans
.
length
=
0
},
shutdown
()
{
return
new
Promise
<
void
>
((
resolve
,
reject
)
=>
...
...
test/e2e/opentelemetry/instrumentation/custom-entrypoint-server.ts
View file @
f1a69d7d
...
...
@@ -63,10 +63,6 @@ async function main() {
'app/app/[param]/rsc-fetch/error/page.js'
,
],
[
/^
\/
behind-middleware$/
,
'app/behind-middleware/page.js'
],
[
/^
\/
behind-middleware
\/
route-handler$/
,
'app/behind-middleware/route-handler/route.js'
,
],
// ---
[
/^
\/
api
\/
pages
\/
param
\/
basic$/
,
'pages/api/pages/[param]/basic.js'
],
[
/^
\/
api
\/
pages
\/
param
\/
error$/
,
'pages/api/pages/[param]/error.js'
],
...
...
test/e2e/opentelemetry/instrumentation/middleware-node.ts
View file @
f1a69d7d
...
...
@@ -10,15 +10,5 @@ export async function middleware(
request
:
NextRequest
,
event
?:
NextFetchEvent
):
Promise
<
Response
>
{
const
{
pathname
}
=
request
.
nextUrl
if
(
pathname
===
'/behind-middleware/rewrite'
)
{
// Keep the query string so tests can correlate the rewritten render.
const
url
=
request
.
nextUrl
.
clone
()
url
.
pathname
=
'/behind-middleware'
return
NextResponse
.
rewrite
(
url
)
}
if
(
pathname
===
'/behind-middleware/redirect'
)
{
return
NextResponse
.
redirect
(
new
URL
(
'/behind-middleware'
,
request
.
url
))
}
return
NextResponse
.
next
()
}
test/e2e/opentelemetry/instrumentation/middleware.ts
View file @
f1a69d7d
...
...
@@ -9,15 +9,5 @@ export async function middleware(
request
:
NextRequest
,
event
?:
NextFetchEvent
):
Promise
<
Response
>
{
const
{
pathname
}
=
request
.
nextUrl
if
(
pathname
===
'/behind-middleware/rewrite'
)
{
// Keep the query string so tests can correlate the rewritten render.
const
url
=
request
.
nextUrl
.
clone
()
url
.
pathname
=
'/behind-middleware'
return
NextResponse
.
rewrite
(
url
)
}
if
(
pathname
===
'/behind-middleware/redirect'
)
{
return
NextResponse
.
redirect
(
new
URL
(
'/behind-middleware'
,
request
.
url
))
}
return
NextResponse
.
next
()
}
test/e2e/opentelemetry/instrumentation/opentelemetry.test.ts
View file @
f1a69d7d
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment