Skip to content

docs(js): Document the managed tunnel and serveTunnelIntegration - #20264

Merged
logaretm merged 18 commits into
masterfrom
awad/managed-tunnel-docs
Nov 16, 2026
Merged

logaretm merged 18 commits into
masterfrom
awad/managed-tunnel-docs

Conversation

@logaretm

@logaretm logaretm commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Browser events still get dropped by ad blockers unless users write their own tunnel, this is now shipped spread out v11.10~v11.13 releases

@vercel

vercel Bot commented Oct 27, 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 Nov 12, 2026 11:02am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 12, 2026 11:02am UTC

Request Review

@cursor

cursor Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Services awaiting deployment · Rollout details

Warning

Rollouts can't watch this change after it deploys: every data source for this team needs to be signed in again, so a check has no telemetry to read. Sign in to your data sources, or ask a team admin to.

Status Service Environment
⚪ Not deployed yet sentry-docs

Mention @rollout in a comment to update the plan.

@Lms24 Lms24 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks good to me based on the docs structure we have today. Just had minor wording suggestions mostly.

One Follow-up suggestion: I think we could add something like a "Tunneling" page to the extended configuration section where we display most of the content we now have in "Troubleshooting" and "ServeTunnel" integration docs. Then we link from both pages to that new page. I think this is better than having so much content in troubleshooting. WDYT?

Adds the serveTunnelIntegration page, the browser tunnel: true option, a
managed tunnel section in troubleshooting, framework getting-started
snippets, and updates TanStack Start tunnelRoute docs for 11.10.0.
Covers the tunnel helpers every server SDK exports and the new
handleTunnelRequest signature from getsentry/sentry-javascript#25783.
Hides SolidStart until it serves the managed tunnel, fixes the Cloudflare
example, and notes that the manual helpers need serveTunnelIntegration to
drop tunnel spans.
The serveTunnel page only exists on server platforms, so the links 404'd on browser-only ones.
… serve the tunnel

On servers without a framework SDK hook, including Cloudflare Workers, the integration only configures the tunnel.
Add a Tunneling page under Extended Configuration and move the tunnel
content there from Troubleshooting, which now only links to it. Point
existing tunneling links at the new page.

Also address review feedback on the managed tunnel docs: list
serveTunnelIntegration in the server integration tables, add a Fastify
example, and tighten the tunnel option wording.
Rewrites the tunneling docs around tunnel: true and serveTunnelIntegration,
which the server SDKs answer in the runtime from 11.12.0 (11.13.0 for
Next.js). The manual setup covers handleTunnelRequest and endpoints on
other servers. The deprecated tunnelRoute options in Next.js and TanStack
Start now point to the new setup, and the tunnel diagram is an SVG.
@logaretm
logaretm marked this pull request as ready for review November 12, 2026 09:37
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Nov 12, 2026
@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.

Mark the whole managed tunnel as 11.13.0, note that Next.js middleware
still runs on Vercel, clarify that a fixed `path` skips the framework
base path, use runtime-native routes for Bun, Deno, Elysia and
Cloudflare, show `withSentry` instead of `Sentry.init` on Cloudflare,
and list `serveTunnelIntegration` for Next.js and SolidStart.
@logaretm
logaretm merged commit ccfa3b9 into master Nov 16, 2026
28 checks passed
@logaretm
logaretm deleted the awad/managed-tunnel-docs branch November 16, 2026 15:11

This branch had an error being deployed

1 failed (outdated) and 1 active deployments
Preview – sentry-docs — 64acea59 Deployed Nov 12, 2026 by vercel[bot]
Preview – develop-docs — 55d0ca10 Deployed Nov 11, 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