Repository navigation
docs(js): Document the managed tunnel and serveTunnelIntegration - #20264
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
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.
Mention |
Lms24
left a comment
There was a problem hiding this comment.
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?
ebe3a6d to
03766f6
Compare
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.
4e313a4 to
b758cac
Compare
|
Please update the IS YOUR CHANGE URGENT? section of the PR description:
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.
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