diff --git a/docs/platforms/android/session-replay/troubleshooting.mdx b/docs/platforms/android/session-replay/troubleshooting.mdx index e271431a85ac41..9e20607fa221d2 100644 --- a/docs/platforms/android/session-replay/troubleshooting.mdx +++ b/docs/platforms/android/session-replay/troubleshooting.mdx @@ -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. - \ No newline at end of file + + + + +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). + + + +Do not use the debug masking overlay in production. It is intended only for local testing purposes. + + + +```kotlin +Sentry.replay().enableDebugMaskingOverlay() +``` + +