feat(apple): Replay Redact #11418
Open
feat(apple): Replay Redact #11418
+69
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docs/platforms/apple/guides/ios/session-replay/customredact.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/apple/guides/ios/session-replay/customredact.mdx
Outdated
Show resolved
Hide resolved
Bundle ReportChanges will increase total bundle size by 14.09MB (99.79%) ⬆️
ℹ️ *Bundle size includes cached data from a previous commit |
|
@brustolin please rebase this on master, then the pr should be un-blocked! |
lizokm
approved these changes
Sep 26, 2024
| @@ -0,0 +1,66 @@ | |||
| --- | |||
| title: Using custom redact for Session Replay | |||
There was a problem hiding this comment.
Suggested change
| title: Using custom redact for Session Replay | |
| title: Using Custom Redact for Session Replay |
| title: Using custom redact for Session Replay | ||
| sidebar_order: 5501 | ||
| notSupported: | ||
| description: "Learn how to choose which part of your app's data to redact in Session Replay." |
There was a problem hiding this comment.
Suggested change
| description: "Learn how to choose which part of your app's data to redact in Session Replay." | |
| description: "Learn how to redact parts of your app's data in Session Replay." |
Comment on lines
+8
to
+12
| <Note> | ||
|
|
||
| Using custom redaction for Session Replay can expose sensitive data. Make sure to double-check every part of your app's data that you choose to redact or not. | ||
|
|
||
| </Note> |
There was a problem hiding this comment.
Suggested change
| <Note> | |
| Using custom redaction for Session Replay can expose sensitive data. Make sure to double-check every part of your app's data that you choose to redact or not. | |
| </Note> | |
| <Alert> | |
| If you custom redact your Session Replays, you may accidentally expose sensitive customer data. Be sure to double-check what you choose to expose. | |
| </Alert> |
Comment on lines
+14
to
+15
| By default, our Session Replay SDK masks all text content, images, and user input, giving you heightened confidence that no sensitive data will leave the device. However, you can choose which parts of your app's data to redact or not by using some different options. | ||
|
|
There was a problem hiding this comment.
Suggested change
| By default, our Session Replay SDK masks all text content, images, and user input, giving you heightened confidence that no sensitive data will leave the device. However, you can choose which parts of your app's data to redact or not by using some different options. | |
| By default, our Session Replay SDK masks all text content, images, and user input. This helps ensure that no sensitive data will be exposed. You can also manually choose which parts of your app's data to redact by using the different options listed below. | |
| By default, our Session Replay SDK masks all text content, images, and user input, giving you heightened confidence that no sensitive data will leave the device. However, you can choose which parts of your app's data to redact or not by using some different options. | ||
|
|
||
|
|
||
| ## Redact by View class |
There was a problem hiding this comment.
Suggested change
| ## Redact by View class | |
| ## Redact by View Class |
| options.experimental.sessionReplay.ignoreViewClasses = [MyCustomLabel.self] | ||
| ``` | ||
|
|
||
| ## Redact View by instance |
There was a problem hiding this comment.
Suggested change
| ## Redact View by instance | |
| ## Redact by View Instance |
|
|
||
| ## Redact View by instance | ||
|
|
||
| You can also choose to redact or ignore a specific view instance by using the replay API or view extensions like this: |
There was a problem hiding this comment.
Suggested change
| You can also choose to redact or ignore a specific view instance by using the replay API or view extensions like this: | |
| You can also choose to redact or ignore a specific view instance by using the [replay API](/api/replays/) or view extensions like this: |
| options.experimental.sessionReplay.redactAllImages = false | ||
| ``` | ||
|
|
||
| Then you can manually choose which `View` you want to redact with the `replayRedact` modifier |
There was a problem hiding this comment.
Suggested change
| Then you can manually choose which `View` you want to redact with the `replayRedact` modifier | |
| Then you can manually choose which `View` you want to redact with the `replayRedact` modifier: |
Comment on lines
+62
to
+65
| <Note> | ||
| Dissabling the default redaction options will expose all text and images in the session replay. | ||
| Make sure to redact them manually. | ||
| </Note> |
There was a problem hiding this comment.
Suggested change
| <Note> | |
| Dissabling the default redaction options will expose all text and images in the session replay. | |
| Make sure to redact them manually. | |
| </Note> | |
| <Note> | |
| Disabling the default redaction options will expose all text and images in the session replay. | |
| Make sure to redact them manually. | |
| </Note> |
Comment on lines
+76
to
+78
| The SDK is recording and aggressively redacting all text and images. | ||
| Please don't turn it off if you have sensitive data in your app. | ||
| If you want to manually choose which part of your app's data to redact, read our guide on [custom redaction](/platforms/apple/guides/ios/session-replay/customredact). |
There was a problem hiding this comment.
Suggested change
| The SDK is recording and aggressively redacting all text and images. | |
| Please don't turn it off if you have sensitive data in your app. | |
| If you want to manually choose which part of your app's data to redact, read our guide on [custom redaction](/platforms/apple/guides/ios/session-replay/customredact). | |
| The SDK aggressively records and redacts all text and images. | |
| Please don't turn it off if you have sensitive data in your app. | |
| If you want to manually redact parts of your app's data, read our guide on [custom redaction](/platforms/apple/guides/ios/session-replay/customredact). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding instructions on how to use custom redact APIs for Apple SDK.