Skip to content

docs(android): Document connecting WebView traces - #20550

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

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

Conversation

@antonis

@antonis antonis commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Documents connecting traces between an Android app and the web content in its WebView, added to the Android SDK in getsentry/sentry-java#6395.

This replaces the Android WebView page's statement that the SDK doesn't interact with web views. The new Connect Traces section covers:

  • SentryWebViewTracing.addTracePropagation, with Kotlin and Java examples;
  • the androidx.webkit dependency the app has to add;
  • how allowed hosts are matched;
  • the trust-boundary warning;
  • serving bundled pages with WebViewAssetLoader;
  • the limitations.

The structure and wording follow the Apple (#20399) and React Native (#19659) WebView pages.

⚠️ The mentioned Android SDK 8.64.0 should change if this lands sooner or later

Resolves getsentry/sentry-java#6161

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • 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

🤖 Generated with Claude Code

Replace the Android WebView guidance, which said the SDK doesn't
interact with web views, with setup for SentryWebViewTracing.
addTracePropagation, matching the Apple and React Native pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

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

Request Review

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

sentry-junior Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

📸 Screenshots

Before = production (docs.sentry.io) · After = Vercel preview of fb03f93 (preview)

🟥 red = removed / replaced · 🟩 green = new / changed · dashed green = where new content is inserted

Android › WebView

Before Before: Android WebView page on production
After — intro, Application Monitoring, Connect Traces setup After: updated intro and Connect Traces setup
After — requirements, host matching, warning, snapshot note After: requirements, host matching and alerts
After — bundled pages, Limitations, trace scope notes After: bundled pages, limitations and trace scope notes

Checks

  • Preview renders cleanly; Kotlin / Java tabs work on both code-tab blocks.
  • The in-page WebView Monitoring link lands on #webview-monitoring. Android, React, Angular, JavaScript, Distributed Tracing, AndroidX WebKit and WebViewAssetLoader links all return 200.
  • Small note: the dependency snippet pins androidx.webkit:webkit:1.14.0, while the current stable release is 1.18.0. Fine if 1.14.0 is meant as the minimum, otherwise worth bumping or saying "1.14.0 or later".

@antonis
antonis marked this pull request as ready for review November 5, 2026 11:58
@codeowner-assignment
codeowner-assignment Bot requested review from a team November 5, 2026 11:59
@cursor

cursor Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Getting ready to monitor this change · Rollout details

Status Service Environment
⏳ Getting ready to monitor this change

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — fb03f93d Deployed Nov 5, 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 Android WebView guidance for connected traces

1 participant