Skip to content

feat(nextjs): Send the trace in the Server-Timing header of document responses - #26107

Draft
chargome wants to merge 7 commits into
developfrom
chargome/feat/nextjs-server-timing-header
Draft

chargome wants to merge 7 commits into
developfrom
chargome/feat/nextjs-server-timing-header

Conversation

@chargome

@chargome chargome commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Why: Under cacheComponents the sentry-trace meta tag arrives with the resumed part of the document, usually after the browser SDK started, so the pageload has to wait for it (#25142). A Server-Timing header reaches the browser before any HTML. The browser SDK already reads it, and Remix and Nitro already send it. On a self-hosted server Next.js flushes the headers with the first chunk, inside the request span, so the header is set in writeHead rather than when the request comes in.

Before, with the meta tag only:

sequenceDiagram
    participant B as Browser
    participant S as Next.js server
    B->>S: GET /page
    Note over S: request span starts, shell comes from cache
    S-->>B: headers + shell (no trace context)
    Note over B: SDK starts, pageload has to wait
    Note over S: dynamic part renders
    S-->>B: resumed part with sentry-trace meta tag
    Note over B: pageload starts late, fetches and errors before it are unattached
Loading

After, with the header:

sequenceDiagram
    participant B as Browser
    participant S as Next.js server
    B->>S: GET /page
    Note over S: request span starts, shell comes from cache
    Note over S: writeHead on the first chunk: Server-Timing carries the active trace
    S-->>B: headers + shell (Server-Timing: sentry-trace, baggage)
    Note over B: SDK starts, pageload continues the trace at once
    Note over S: dynamic part renders
    S-->>B: resumed part with sentry-trace meta tag
    Note over B: tag only settles page.server_rendering.type
Loading

The header is left off responses a shared cache may store, which is what Next.js sends for static and ISR app router documents. A CDN in front of the server would otherwise replay one visitor's trace and sampling decision to everyone. The check is the one the Remix 3 middleware already had, now shared as isSharedCacheable in core. Non-document responses get no header either.

Since the pageload no longer waits for the tag, page.server_rendering.type is settled after span start for a runtime shell with a dynamic part, so tracesSampler does not see it in that case.

Closes #24945
Refs JS-3864

…responses

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@chargome chargome self-assigned this Nov 4, 2026
@chargome

chargome commented Nov 4, 2026

Copy link
Copy Markdown
Member Author

bugbot run

@linear-code

linear-code Bot commented Nov 4, 2026

Copy link
Copy Markdown

JS-3864

@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

Compared: e6172de (PR test merge using develop at c491307)

Against: c491307 (develop) · base run #65764

✅ Baseline matches: this diff contains only this PR's changes.

Path Size % Change Change
@sentry/browser 30.04 kB - -
@sentry/browser - with treeshaking flags 28.23 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 28.14 kB - -
@sentry/browser (incl. Tracing) 52.21 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.22 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.17 kB - -
@sentry/browser (incl. Tracing, Replay) 92.75 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 81.5 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 97.1 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 110.52 kB - -
@sentry/browser (incl. Feedback) 47.66 kB - -
@sentry/browser (incl. sendFeedback) 30.61 kB - -
@sentry/browser (incl. FeedbackAsync) 35.63 kB - -
@sentry/browser (incl. Metrics) 31.36 kB - -
@sentry/browser (incl. Logs) 31.63 kB - -
@sentry/browser (incl. Metrics & Logs) 32.29 kB - -
@sentry/react 32.04 kB - -
@sentry/react (incl. Tracing) 54.84 kB - -
@sentry/vue 38.2 kB - -
@sentry/vue (incl. Tracing) 55.12 kB - -
@sentry/svelte 30.06 kB - -
@sentry/remix (Remix 3 client bundle) 57.93 kB - -
CDN Bundle 31.8 kB - -
CDN Bundle (incl. Tracing) 52.55 kB - -
CDN Bundle (incl. Logs, Metrics) 34.58 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 55.1 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 75.62 kB - -
CDN Bundle (incl. Tracing, Replay) 90.6 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 93.22 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 96.01 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 98.61 kB - -
CDN Bundle - uncompressed 92.67 kB - -
CDN Bundle (incl. Tracing) - uncompressed 155.11 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 101.01 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 162.75 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 231.09 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 275.26 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 282.89 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 287.05 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 294.68 kB - -
@sentry/nextjs (client) 58.3 kB +0.12% +66 B 🔺
@sentry/sveltekit (client) 53.24 kB - -
@sentry/core/server 44.52 kB - -
@sentry/core/browser 13.99 kB - -
@sentry/node 149.18 kB -0.01% -6 B 🔽
@sentry/node/import (ESM hook with diagnostics-channel injection) 83.16 kB - -
@sentry/node - without tracing 88.24 kB -0.01% -5 B 🔽
@sentry/node - without channel injection 138.16 kB -0.01% -5 B 🔽
@sentry/aws-serverless 97.1 kB -0.01% -4 B 🔽
@sentry/cloudflare (withSentry) - minified 204.16 kB - -
@sentry/cloudflare (withSentry) 473.86 kB - -
@sentry/nextjs/cloudflare (withSentry) - minified 229.47 kB - -

View base workflow run

@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Optional E2E tests

Some optional checks were not successful. They do not block the merge. 4 not successful, 53 successful. See the run.

Check Status
❌ CI: Optional E2E Tests / E2E node-eve Test (optional) Failing after 2m Details
❌ CI: Optional E2E Tests / E2E nextjs-16-cacheComponents (cloudflare) Test (optional) Failing after 10m Details
❌ CI: Optional E2E Tests / E2E node-eve (latest) Test (optional) Failing after 55s Details
❌ CI: Optional E2E Tests / E2E node-eve (orchestrion) Test (optional) Failing after 2m Details
Successful checks
Check Status
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable Test (optional) Successful in 45s Details
✅ CI: Optional E2E Tests / E2E deno (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions Test (optional) Successful in 25s Details
✅ CI: Optional E2E Tests / E2E debug-id-sourcemaps Test (optional) Successful in 41s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable (latest) Test (optional) Successful in 52s Details
✅ CI: Optional E2E Tests / E2E vue-3 (no Options API) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E astro-7 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think Test (optional) Successful in 54s Details
✅ CI: Optional E2E Tests / E2E cloudflare-mastra Test (optional) Successful in 54s Details
✅ CI: Optional E2E Tests / E2E cloudflare-agent Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E astro-7-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries Test (optional) Successful in 59s Details
✅ CI: Optional E2E Tests / E2E nextjs-16-tunnel (cloudflare) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think (ai v6) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps Test (optional) Successful in 34s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (deno) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-workers-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (latest) Test (optional) Successful in 47s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (turbo) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v2 Test (optional) Successful in 26s Details
✅ CI: Optional E2E Tests / E2E cloudflare-flue-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (static / nuxt generate) Test (optional) Successful in 43s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext, bun) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-orpc Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-mastra Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (cloudflare) Test (optional) Successful in 45s Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v1 Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E node-pi-durable (latest) Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (cloudflare, latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E solidstart-2 Test (optional) Successful in 53s Details
✅ CI: Optional E2E Tests / E2E node-flue Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (latest) Test (optional) Successful in 55s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (client source maps kept) Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-cloudflare Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E supabase-nextjs Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-pi-durable Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 (tracer provider) Test (optional) Successful in 31s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (tunnel-dev) Test (optional) Successful in 54s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions (latest) Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E react-router-7-framework-instrumentation Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-sourcemaps Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E node-flue (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-mastra (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E react-send-to-sentry Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-cloudflare Test (optional) Successful in 30s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (latest) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 Test (optional) Successful in 42s Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (latest) Test (optional) Successful in 1m Details

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

… is sent

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@chargome

chargome commented Nov 4, 2026

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

Comment thread packages/nextjs/src/server/index.ts Resolved
@chargome

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@chargome

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

…js-server-timing-header

# Conflicts:
#	packages/nextjs/src/server/index.ts
@chargome

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 2091a1e. Configure here.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Send trace context in the Server-Timing header for self-hosted Next.js

1 participant