Skip to content

docs(android): Add docs on how to enable session replay masking #14646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
markushi wants to merge 5 commits into from
+17 −1
Closed

docs(android): Add docs on how to enable session replay masking #14646

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d805d7
docs(android): Add docs on how to enable session replay masking
markushi Aug 13, 2025
f6970ca
Update docs/platforms/android/session-replay/index.mdx
markushi Aug 28, 2025
6a442b9
Merge branch 'master' into markushi/session-replay-android-masking
markushi Aug 29, 2025
c432abd
Update troubleshooting.mdx
markushi Aug 29, 2025
f5b05b0
Delete FAQ in favor of troubleshooting page
markushi Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/platforms/android/session-replay/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,20 @@ Recording only happens on Android 8 (API level 26) or newer. For devices running

An issue may be missing a replay because the user's device was [offline](/product/explore/session-replay/mobile#frequently-asked-questions) while `sessionSampleRate` was specified, your project/organization was rate-limited, or (in rare cases) the device failed to capture the replay video.

</Expandable>
</Expandable>

<Expandable title="How can I debug which UI elements are being masked?" permalink>

You can enable a debug overlay that highlights which UI widgets are masked. Call `Sentry.replay().enableDebugMaskingOverlay()` to turn the overlay on and `Sentry.replay().disableDebugMaskingOverlay()` to turn it off. These methods must be called after the SDK is initialized. The masks will be invalidated at most once per frame rate (default 1 fps).

<Alert>

Do not use the debug masking overlay in production. It is intended only for local testing purposes.

</Alert>

```kotlin
Sentry.replay().enableDebugMaskingOverlay()
```

</Expandable>