Skip to content

docs(apple): Document connecting WebView traces - #20399

Open
antonis wants to merge 1 commit into
masterfrom
docs/apple-webview-trace-propagation
Open

antonis wants to merge 1 commit into
masterfrom
docs/apple-webview-trace-propagation

Conversation

@antonis

@antonis antonis commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Updates the Apple WebView page for the new trace connection in the Cocoa SDK. It replaces the statement that the SDK doesn't interact with web views with setup for SentryWebViewTracing.addTracePropagation, which writes the app's trace into WKWebView pages as sentry-trace and baggage meta tags before page scripts run, so @sentry/browser continues it on pageload.

  • Swift and SentryObjC examples, plus a SwiftUI WebPage section (iOS, macOS, visionOS 26+)
  • allowedHosts matching and the trust warning, aligned with the React Native WebView page
  • The snapshot behavior, supported platforms, and limitations

Resolves getsentry/sentry-cocoa#9136

⚠️ SDK changes: getsentry/sentry-cocoa#9474 (Swift API) and getsentry/sentry-cocoa#9488 (SentryObjC API). The version alert says 9.33.0; it will be updated if the release differs. Keep this as a draft until those PRs ship.

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: YYYY-MM-DD
  • 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

EXTRA RESOURCES

Replace the statement that the Cocoa SDK doesn't interact with web
views with setup for SentryWebViewTracing, which injects the app's
trace into WKWebView pages so @sentry/browser continues it on
pageload. Cover the SwiftUI WebPage overload, allowedHosts, the
snapshot behavior, and the limitations.
@vercel

vercel Bot commented Nov 3, 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 3, 2026 10:17am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 3, 2026 10:17am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Nov 3, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from a team, itaybre and philprime and removed request for a team November 3, 2026 10:11
@sentry-junior

sentry-junior Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Screenshots

Rendered from the Vercel preview for this branch (docs/apple-webview-trace-propagation, commit 9e7ffda). The "before" shot is the same page on production (docs.sentry.io). Highlights were added for review only.

Apple WebView (/platforms/apple/configuration/webview/)

Before: old description, intro, and the "doesn't interact with the web views" statement; the dashed line marks where Connect Traces goes
Before: Apple WebView

After: updated description, intro, and Application Monitoring text, plus the Connect Traces version notice and the Swift / SentryObjC usage
After: Apple WebView intro and Connect Traces usage

After: setup requirements, allowedHosts matching, the trust warning, and the snapshot note
After: Apple WebView requirements and warnings

After: SwiftUI WebPage section, Limitations, and trace scope notes
After: Apple WebView SwiftUI and limitations

The WebView Monitoring in-page link and the linked Apple, JavaScript, React, Angular, and Distributed Tracing pages all resolve on the preview.

@antonis
antonis marked this pull request as ready for review November 3, 2026 10:22
@codeowner-assignment
codeowner-assignment Bot requested review from a team November 3, 2026 10:22

This branch was successfully deployed

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

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Update Apple WebView guidance for connected traces

1 participant