Skip to content

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

Draft
logaretm wants to merge 13 commits into
masterfrom
awad/managed-tunnel-docs
Draft

docs(js): Document the managed tunnel and serveTunnelIntegration#20264
logaretm wants to merge 13 commits into
masterfrom
awad/managed-tunnel-docs

Conversation

@logaretm

@logaretm logaretm commented Oct 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Browser events still get dropped by ad blockers unless users write their own tunnel, this is now shipped in v11.10.

@vercel

vercel Bot commented Oct 27, 2026 •
edited
Loading

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 30, 2026 5:29pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 30, 2026 5:29pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 27, 2026
@logaretm
logaretm marked this pull request as ready for review October 29, 2026 14:13
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 29, 2026 14:13
@logaretm
logaretm requested review from Lms24 and s1gr1d October 29, 2026 14:14
@cursor

cursor Bot commented Oct 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Services awaiting deployment · Rollout details

Status Service Environment
⚪ Not deployed yet sentry-docs

Mention @rollout in a comment to update the plan.

Lms24
Lms24 approved these changes Oct 30, 2026
View reviewed changes

@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?

Comment thread docs/platforms/javascript/common/configuration/integrations/servetunnel.mdx
Comment thread docs/platforms/javascript/common/configuration/integrations/servetunnel.mdx Outdated
Comment thread docs/platforms/javascript/common/configuration/integrations/servetunnel.mdx Outdated
Comment thread docs/platforms/javascript/common/configuration/integrations/servetunnel.mdx Outdated
Comment thread docs/platforms/javascript/common/configuration/options.mdx Outdated
Comment thread docs/platforms/javascript/common/configuration/options.mdx Outdated
Comment thread docs/platforms/javascript/common/configuration/options.mdx Outdated
Comment thread docs/platforms/javascript/common/troubleshooting/index.mdx Outdated
@codeowner-assignment
codeowner-assignment Bot requested review from a team, 0xadam-brown, antonis, buenaflor and runningcode and removed request for a team October 30, 2026 14:55
@logaretm
docs(js): Document the managed tunnel and serveTunnelIntegration
357da46 
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.
@logaretm
docs(js): Document serving the managed tunnel on any server
2d33fea 
Covers the tunnel helpers every server SDK exports and the new
handleTunnelRequest signature from getsentry/sentry-javascript#25783.
@logaretm
docs(js): Align the managed tunnel docs with the 11.10.0 release
192476d 
Hides SolidStart until it serves the managed tunnel, fixes the Cloudflare
example, and notes that the manual helpers need serveTunnelIntegration to
drop tunnel spans.
@logaretm
docs(js): Hide the managed tunnel docs from Next.js for now
2902430
@logaretm
docs(js): Align the tunnel endpoint rules with handleTunnelRequest
40a501c
@logaretm
docs(js): Keep the handleTunnelRequest paragraph, with the non-deprec…
77ff18e 
…ated signature
@logaretm
docs(js): Link browser-only platforms to the Node.js serveTunnel page
30ea67f 
The serveTunnel page only exists on server platforms, so the links 404'd on browser-only ones.
@logaretm
docs(js): Document only the middleware for serving the tunnel yourself
6b56580
@logaretm
docs(js): Document handleTunnelRequest for a fixed tunnel path
26e087e
@logaretm
docs(js): Apply the docs style guide to the managed tunnel docs
54789bb
@logaretm
docs(js): Clarify that serveTunnelIntegration needs a request hook to…
2a75393 
… serve the tunnel

On servers without a framework SDK hook, including Cloudflare Workers, the integration only configures the tunnel.
@logaretm
docs(js): Show per-platform tunnel serving notes instead of listing e…
d37473e 
…very framework
@logaretm
docs(js): Move tunneling docs to their own configuration page
03766f6 
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.
@logaretm
logaretm force-pushed the awad/managed-tunnel-docs branch from ebe3a6d to 03766f6 Compare October 30, 2026 17:22
@codeowner-assignment
codeowner-assignment Bot requested review from a team October 30, 2026 17:23
@logaretm
logaretm marked this pull request as draft October 30, 2026 17:51
@logaretm

logaretm commented Oct 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

@Lms24 thanks for the review, I took a holistic view on this after a few iterations and I feel the tunnel entire story is confusing. So I'm pulling this back for a few days till I get it right.

I'm working on a different idea that could make this way easier to document with less edge cases: getsentry/sentry-javascript#25917

The idea I have in my mind is getting serveTunnelIntegration to "just work" regardless of their framework or setup. Reserving the manual setup for those who want to build a tunnel completely manually without the integration.

This branch was successfully deployed

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

Reviewers

@Lms24 Lms24 Lms24 approved these changes
@s1gr1d s1gr1d Awaiting requested review from s1gr1d
@runningcode runningcode Awaiting requested review from runningcode runningcode was automatically assigned from getsentry/team-mobile-android-sdk
@0xadam-brown 0xadam-brown Awaiting requested review from 0xadam-brown 0xadam-brown was automatically assigned from getsentry/team-mobile-android-sdk
@antonis antonis Awaiting requested review from antonis antonis was automatically assigned from getsentry/team-mobile-cross-platform-sdks
@buenaflor buenaflor Awaiting requested review from buenaflor buenaflor was automatically assigned from getsentry/team-mobile-cross-platform-sdks

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@logaretm @Lms24