Skip to content

Commit 649b485

Browse files
committed
feat(android): Add custom masking options for session replay
1 parent c0bceab commit 649b485

File tree

1 file changed

+11
-7
lines changed
  • docs/platforms/android/session-replay

1 file changed

+11
-7
lines changed

docs/platforms/android/session-replay/index.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,20 +94,20 @@ Sampling begins as soon as a session starts. `sessionSampleRate` is evaluated fi
9494

9595
## Privacy
9696

97-
The SDK is recording and aggressively redacting all text and images. We plan to add fine controls for redacting, but in this version, we just allow either on or off. The default is on. Please don’t turn it off if you have sensitive data in your app. Before the Beta is complete, we'll give you the controls you need.
97+
The SDK is recording and aggressively masking all text, images and webviews. Please don’t turn it off if you have sensitive data in your app.
98+
However, if you're working on a mobile app that's free of PII or other types of private data, you can opt out of the default text and image masking settings. To learn more about Session Replay privacy, [read our docs](/platforms/android/session-replay/privacy/).
9899

99100
<Note>
100101

101-
Jetpack Compose views are not yet redacted. This is being [tracked here](https://github.com/getsentry/sentry-java/issues/3577).
102-
If you encounter any other data not being redacted with the default settings, please let us know through a [GitHub issue](https://github.com/getsentry/sentry-java/issues/new?assignees=&labels=Platform%3A+Android%2CType%3A+Bug&projects=&template=bug_report_android.yml).
102+
If you encounter any other data not being masked with the default settings, please let us know through a [GitHub issue](https://github.com/getsentry/sentry-java/issues/new?assignees=&labels=Platform%3A+Android%2CType%3A+Bug&projects=&template=bug_report_android.yml).
103103

104104
</Note>
105105

106-
To disable redaction altogether (not to be used on applications with sensitive data):
106+
To disable masking altogether (not to be used on applications with sensitive data):
107107

108108
```kotlin
109-
options.experimental.sessionReplay.redactAllText = false
110-
options.experimental.sessionReplay.redactAllImages = false
109+
options.experimental.sessionReplay.maskAllText = false
110+
options.experimental.sessionReplay.maskAllImages = false
111111
```
112112

113113
## Error Linking
@@ -120,8 +120,12 @@ Errors that happen on the page while a replay is running will be linked to the r
120120

121121
## FAQ
122122

123+
Q: Why are parts of my replay not masked?
124+
A: Text fields, input fields, images, video players and webviews are all masked by default. Local assets, such as colors or vector drawables, are not masked due to their low likelihood of containing PII. If you encounter a view/component that should be masked by default, consider opening a [GitHub issue](https://github.com/getsentry/sentry-java/issues).
125+
123126
Q: Does Session Replay work with Jetpack Compose?
124-
A: Yes, but we're still adding support for redaction for Jetpack Compose views. Redaction will be added during the Beta program and after GA these views will be masked by default.
127+
A: Yes, by default text, input field and image composables should be masked. Masking within embedded android views (`AndroidView`)
128+
in Compose is currently not supported. If you encounter composables that are not masked but should be, consider opening a [GitHub issue](https://github.com/getsentry/sentry-java/issues).
125129

126130
Q: What's the lowest version of Android supported?
127131
A: Recording only happens on Android 8 (API level 26) or newer. For devices running an older version, SDK features other than recording work normally.

0 commit comments

Comments
 (0)