Skip to content

docs(nextjs): Document the tunnel route handler and tunnel credentials - #20075

Open
s1gr1d wants to merge 3 commits into
masterfrom
sig/js-tunnel-docs
Open

s1gr1d wants to merge 3 commits into
masterfrom
sig/js-tunnel-docs

Conversation

@s1gr1d

@s1gr1d s1gr1d commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Documents the tunnel changes in SDK 11.9.0.

⚠️ Merge this PR only after 10.78.0 and 11.9.0 are released.

  • Next.js tunnelRoute: add handler mode (app/sentry-tunnel/route.ts). In this mode, a route handler in the app forwards only the request body to Sentry. Rewrite mode now sends with credentials: "omit". Apps behind Vercel Deployment Protection or another login should use handler mode.
  • Troubleshooting: list what a custom tunnel must do, add handleTunnelRequest, and add a new "Credentials on Tunnel Requests" entry.
  • Short notes in options.mdx, the getting-started includes, the Next.js setup pages, and TanStack Start.

Related SDK PRs, all going to be released in 11.9.0:

Backport PRs for 10.78.0:

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: with the 11.9.0 release
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 20, 2026 2:08pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 20, 2026 2:08pm UTC

Request Review

@s1gr1d
s1gr1d marked this pull request as draft October 19, 2026 11:33
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 19, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 19, 2026 11:34
@cursor

cursor Bot commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

The plan checks page loads of the edited tunnel docs, client errors on those pages, and JavaScript docs 404s. An issue escalates when client errors rise or JavaScript 404s rise.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Readers of the Next.js build-options page now see tunnel handler mode. JavaScript troubleshooting pages now say a tunnel must forward only the request body and must not send credentials in rewrite mode.

sentry-docs must deploy before this copy is live. The Vercel production project sentry-docs maps to that service in the deploy report workflow.

Risk

A render fault in the shared troubleshooting MDX can break every JavaScript troubleshooting page. A bad new link can send readers to a 404. A fault in the new Expandable or new code samples can throw in the browser.

Intended effect

Connected telemetry cannot show that the new copy is live. No metric increments when handler mode or handleTunnelRequest appears on the page. absent means the live pages still omit that copy after deploy. That HTML check is not in Sentry. See Not observable.

Page loads of the edited paths only show that the pages still open. They do not prove the new copy.

Regression watch

Watch client errors on the edited tunnel pages, JavaScript 404s, and page-load volume on those paths. Pageload failure rate on the JavaScript troubleshooting URLs is the availability signal. The shared troubleshooting MDX is the widest blast radius.

Known error titles in this baseline are TypeError: Cannot read properties of undefined (reading 'xS') and Event: Event \Event` (type=error) captured as promise rejection`. Treat a new title as a regression. Volume may be lower on weekends. The lower page-load bound is the weekend window.

Signal Baseline Window Source Rule
Client errors on tunnel docs URLs as a share of docs.page.load 2 errors and 69 page loads, 2.9%. 48h: 10 errors and 98 page loads, 10.2% 2026-10-18T11:30:00Z to 2026-10-19T11:30:00Z and 2026-10-17T11:30:00Z to 2026-10-19T11:30:00Z Sentry org sentry project docs. Errors: environment:production http.url:[*/platforms/javascript/guides/nextjs/configuration/build*,*/platforms/javascript/troubleshooting*,*/platforms/javascript/guides/nextjs/manual-setup*]. Page loads: environment:production path:[/platforms/javascript/guides/nextjs/configuration/build/,/platforms/javascript/troubleshooting/,/platforms/javascript/guides/nextjs/manual-setup/] sum of docs.page.load Hold the 24h error share at or below 10.2%. Escalate when the share rises above that band or a new error title appears
docs.page.not_found for platforms/javascript 20 events in 24h. 35 events in the prior 24h 2026-10-18T11:30:00Z to 2026-10-19T11:30:00Z and 2026-10-17T11:30:00Z to 2026-10-18T11:30:00Z Sentry org sentry project docs. environment:production requested_path:"platforms/javascript" sum of docs.page.not_found Hold in 20-35 events per 24h. Escalate when the count rises above 35
Combined docs.page.load on the edited tunnel paths 162 loads in 24h. 93 loads in the prior 24h 2026-10-18T11:30:00Z to 2026-10-19T11:30:00Z and 2026-10-17T11:30:00Z to 2026-10-18T11:30:00Z Sentry org sentry project docs. environment:production path:[/platforms/javascript/guides/nextjs/,/platforms/javascript/guides/nextjs/manual-setup/,/platforms/javascript/guides/nextjs/configuration/build/,/platforms/javascript/troubleshooting/,/platforms/javascript/guides/nextjs/troubleshooting/] sum of docs.page.load Hold in 93-162 loads per 24h. Escalate when volume falls below 93
Pageload failure rate on JavaScript troubleshooting URLs 0 failures in 13 sampled pageloads. p95 2765-3106ms 2026-10-18T11:30:00Z to 2026-10-19T11:30:00Z Sentry org sentry project docs. span.op:pageload environment:production url.full:*platforms/javascript/troubleshooting* failure_rate() Hold failure rate at 0. Escalate when failure rate rises above 0

If client errors rise, inspect Expandable, code tabs, and MDX render on the Next.js build-options and JavaScript troubleshooting pages.

Not observable

Live HTML of the edited pages. Sentry does not store page body text. The executor cannot confirm handler mode, handleTunnelRequest, or Credentials on Tunnel Requests from telemetry. Server 5xx sliced by docs path. Pageload spans use transaction /:path*?. Pageload failure rate has no prior-day sample. Soft-navigation web vitals are not in this baseline.

Get Slack DMs about this change: cursor.com/automations/rollouts

@s1gr1d
s1gr1d marked this pull request as ready for review October 20, 2026 12:50
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 20, 2026 12:50
@github-actions

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 935a750e Deployed Oct 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants