docs(tanstackstart-react): Document tunnel route adapter#17504
Draft
nikolovlazar wants to merge 1 commit intomasterfrom
Draft
docs(tanstackstart-react): Document tunnel route adapter#17504nikolovlazar wants to merge 1 commit intomasterfrom
nikolovlazar wants to merge 1 commit intomasterfrom
Conversation
Surface the new tunnel APIs shipped in sentry-javascript#20264:
`sentryTanstackStart({ tunnelRoute })` for the managed Vite-plugin path
and `createSentryTunnelRoute` for users who need to define the route
file themselves.
- Replace the generic tunneling include in Step 5 of the setup guide
with TanStack-specific copy that recommends `tunnelRoute: true`.
- Add a `Tunnel Route` section to the `sentryTanstackStart` feature
page covering all three accepted shapes (`true`, static string,
object), plus override and opaque-path caveats.
- Add a dedicated `createSentryTunnelRoute` feature page with a file
route example, the matching client `tunnel` reminder, and
`allowedDsns` fallback behavior.
Version markers are placeholders and need to be filled in once the
`@sentry/tanstackstart-react` release ships.
Refs JS-2144
Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Warning
DO NOT MERGE until both
<AvailableSince version="TBD" />markers are replaced with the real@sentry/tanstackstart-reactrelease version.Affected files:
docs/platforms/javascript/guides/tanstackstart-react/features/sentryTanstackStart.mdx(the new## Tunnel Routesection)docs/platforms/javascript/guides/tanstackstart-react/features/createSentryTunnelRoute.mdxDESCRIBE YOUR PR
Documents the new tunnel APIs shipped in sentry-javascript#20264 for
@sentry/tanstackstart-react. The SDK now exposes two ways to tunnel browser events through a same-origin route to dodge ad blockers and corporate firewalls:sentryTanstackStart({ tunnelRoute })— Vite plugin option that auto-registers the route AND auto-sets the clienttunneloption. Recommended path.createSentryTunnelRoute({ allowedDsns? })— manual server-route helper for users who need full control over the route file or DSN allowlist, or can't use the Vite plugin.Changes:
tunnelRoute: true(opaque path regenerated each build) and links to both feature pages.Tunnel Routesection to the existingsentryTanstackStartfeature page covering all three accepted shapes (true, static string,{ allowedDsns, path }), plus override behavior and the opaque-path caveat.createSentryTunnelRoutefeature page (auto-discovered via<PageGrid />) with asrc/routes/monitor.tsexample, the matching clienttunnelreminder, andallowedDsnsfallback behavior.Refs JS-2144
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
<AvailableSince version="TBD" />markers with the real SDK version