Skip to content

Commit c301cee

Browse files
committed
add specific intro for screenshot and session replay
1 parent 8f7b00b commit c301cee

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@ Sampling allows you to control how much of your website's traffic will result in
6060

6161
Sampling starts as soon as a session begins. The `sessionSampleRate` is then evaluated. If the session is sampled, replay recording will start immediately. If not, `onErrorSampleRate` will be evaluated. If the session is sampled at this point, the replay will be buffered and will only be uploaded to Sentry if an error occurs.
6262

63+
## Redact Session Replay via `masking`
64+
65+
By default, the SDK is recording and aggressively redacting (masking) all `Text`, `EditableText`, and `Image` widgets for <PlatformLink to="/session-replay/">`Session Replay`</PlatformLink>. To modify or disable this beahvior, use the `options.experimental.privacy` parameter.
66+
67+
<Alert level="warning">
68+
Modifying this parameter will also affect `masking` for
69+
<PlatformLink to="/enriching-events/screenshots/">`Screenshots`</PlatformLink>
70+
.
71+
</Alert>
72+
6373
<PlatformContent includePath="replay/privacy-configuration" />
6474

6575
## Error Linking

platform-includes/enriching-events/attach-screenshots/flutter.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ await SentryFlutter.init(
1313
);
1414
```
1515

16+
## Redact Screenshots via `masking`
17+
18+
The masking feature is by default disabled for Screenshots. To enable masking, use the `options.experimental.privacy` parameter.
19+
20+
<Alert level="warning">
21+
Modifying this parameter will also affect `masking` for{" "}
22+
<PlatformLink to="/session-replay/">`Session Replay`</PlatformLink>.
23+
</Alert>
24+
1625
<PlatformContent includePath="replay/privacy-configuration" />
1726

1827
## Filtering Screenshots

platform-includes/replay/privacy-configuration/flutter.mdx

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
## Privacy
2-
3-
<Alert level="warning">
4-
Setting these parameter will affect `masking` for{" "}
5-
<PlatformLink to="/enriching-events/screenshots/">`Screenshots`</PlatformLink>{" "}
6-
and <PlatformLink to="/session-replay/">`Session Replay`</PlatformLink>.
7-
</Alert>
8-
<Note>
9-
By default, `masking` is disabled for{" "}
10-
<PlatformLink to="/enriching-events/screenshots/">`Screenshots`</PlatformLink>{" "}
11-
and enabled for{" "}
12-
<PlatformLink to="/session-replay/">`Session Replay`</PlatformLink>
13-
</Note>
14-
15-
By default, the SDK is recording and aggressively redacting (masking) all `Text`, `EditableText`, and `Image` widgets for <PlatformLink to="/session-replay/">`Session Replay`</PlatformLink>.
161
Masking in the Sentry Flutter SDK is based on Widget _types_, e.g. `Image`, not the string representation of the type (i.e. we check whether
172
a `widgetInstance` should be masked by checking `if (widgetInstance is Image)` instead of `if (widgetInstance.runtimeType == 'Image')`).
183
This means we can ensure masking works regardless of obfuscation in release builds and also works for subclasses.

0 commit comments

Comments
 (0)