Add RN Replay Privacy page #11798
Open
Add RN Replay Privacy page #11798
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
Member
krystofwoldrich
commented
Nov 12, 2024
•
krystofwoldrich
commented
- Need when feat(replay): Add SentryMask and SentryUnmask native components sentry-react-native#4224 is released. (This week/next week as beta.)
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will increase total bundle size by 210 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
antonis
reviewed
Nov 12, 2024
Comment on lines
+78
to
+79
| 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. | ||
| 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/). |
There was a problem hiding this comment.
l: Nit pick because I was initially confused on what to turn off. Probably it's clear enough based on the context even without the suggested change.
h: we need to change the link to react-native
Suggested change
| 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. | |
| 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/). | |
| The SDK is recording and aggressively masking all text, images, and webviews. Please don’t disable masking if you have sensitive data in your app. | |
| However, if you're working on a mobile app that doesn't contain any PII or 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/react-native/session-replay/privacy/). |
Made a few small language tweaks.
| @@ -75,7 +75,8 @@ Sampling begins as soon as a session starts. <PlatformIdentifier name="replays-s | |||
|
|
|||
| ## Privacy | |||
|
|
|||
| 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. | |||
| 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. | |||
There was a problem hiding this comment.
Is this text widespread? If so, we could reword it everywhere IMO
Suggested change
| 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. | |
| The SDK is recording and aggressively masking all text, images, and webviews by default. If your app has any sensitive data, you should only turn the default masking off after explicitly masking out any sensitive data, using the APIs described below. |
Made a few language tweaks to @bruno-garcia edits :)
| @@ -75,7 +75,8 @@ Sampling begins as soon as a session starts. <PlatformIdentifier name="replays-s | |||
|
|
|||
| ## Privacy | |||
|
|
|||
| 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. | |||
| 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. | |||
| 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/). | |||
There was a problem hiding this comment.
We should reword it on the Android docs too:
Suggested change
| 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/). | |
| However, if you're working on a mobile app that doesn't contain any PII or 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/react-native/session-replay/privacy/). |
Comment on lines
+26
to
+28
| _Make sure your Sentry React Native SDK version is at least 5.36.0 or 6.3.0._ | ||
|
|
||
| ## Mask and Unmask Components |
There was a problem hiding this comment.
I: Masking all items doesn't require the mentioned versions, but masking specific items surely do, so I suggest moving this part inside of Mask and Unmask Components
Suggested change
| _Make sure your Sentry React Native SDK version is at least 5.36.0 or 6.3.0._ | |
| ## Mask and Unmask Components | |
| ## Mask and Unmask Components | |
| <Note> | |
| Mask and Unmask components requires a Sentry React Native SDK version 5.36.0, 6.3.0 and up. | |
| </Note> |
lizokm
approved these changes
Nov 13, 2024
| title: Privacy | ||
| sidebar_order: 5501 | ||
| notSupported: | ||
| description: "Learn how to mask parts of your app's data in Session Replay." |
There was a problem hiding this comment.
Suggested change
| description: "Learn how to mask parts of your app's data in Session Replay." | |
| description: "Learn how to mask sensitive data that may appear in your app in Session Replay." |
Comment on lines
+8
to
+12
| <Alert> | ||
|
|
||
| Using custom masking in your Session Replays may accidentally expose sensitive customer data. Before publishing an App with Session Replay enabled, make sure to test it thoroughly to ensure that no sensitive data is exposed. | ||
|
|
||
| </Alert> |
There was a problem hiding this comment.
Suggested change
| <Alert> | |
| Using custom masking in your Session Replays may accidentally expose sensitive customer data. Before publishing an App with Session Replay enabled, make sure to test it thoroughly to ensure that no sensitive data is exposed. | |
| </Alert> | |
| <Alert> | |
| Using custom masking in your Session Replays instead of our default settings, may accidentally expose sensitive customer data. Make sure to test your app thoroughly to ensure that no sensitive data is exposed before publishing it. | |
| </Alert> |
Comment on lines
+13
to
+27
|
|
||
| By default, our Session Replay SDK masks all text content, images, webviews, and user input. This helps ensure that no sensitive data is exposed. You can also manually choose which parts of your app's data you want to mask by using the different options listed below. | ||
|
|
||
| To disable the default masking behavior (not to be used on applications with sensitive data): | ||
|
|
||
| ```javascript | ||
| Sentry.mobileReplayIntegration({ | ||
| maskAllText: false, | ||
| maskAllImages: false, | ||
| maskAllVectors: false, | ||
| }), | ||
| ``` | ||
|
|
||
| _Make sure your Sentry React Native SDK version is at least 5.36.0 or 6.3.0._ | ||
|
|
There was a problem hiding this comment.
Suggested change
| By default, our Session Replay SDK masks all text content, images, webviews, and user input. This helps ensure that no sensitive data is exposed. You can also manually choose which parts of your app's data you want to mask by using the different options listed below. | |
| To disable the default masking behavior (not to be used on applications with sensitive data): | |
| ```javascript | |
| Sentry.mobileReplayIntegration({ | |
| maskAllText: false, | |
| maskAllImages: false, | |
| maskAllVectors: false, | |
| }), | |
| ``` | |
| _Make sure your Sentry React Native SDK version is at least 5.36.0 or 6.3.0._ | |
| The Session Replay SDK masks all text content, images, webviews, and user input by default. This helps ensure that no sensitive data is exposed. You can also manually choose which parts of your app to mask by using the options listed below. | |
| If your app doesn't contain any sensitive date, you can disable the default masking behavior with: | |
| ```javascript | |
| Sentry.mobileReplayIntegration({ | |
| maskAllText: false, | |
| maskAllImages: false, | |
| maskAllVectors: false, | |
| }), | |
| _Make sure your Sentry React Native SDK version is 5.36.0, 6.3.0 and up_ | |
Comment on lines
+49
to
+51
| ## General Masking Rules | ||
|
|
||
| When components are wrapped by `Unmask`, **only direct children will be unmasked**. You'll need to explicitly wrap each further child if you want them to appear in the replay. |
There was a problem hiding this comment.
Suggested change
| ## General Masking Rules | |
| When components are wrapped by `Unmask`, **only direct children will be unmasked**. You'll need to explicitly wrap each further child if you want them to appear in the replay. | |
| ## General Masking Rules | |
| When components are wrapped by `Unmask`, **only direct children will be unmasked**. You'll need to explicitly wrap any indirect children that you want to appear in the replay. |
Comment on lines
+106
to
+112
| ## Troubleshooting | ||
|
|
||
| The `Mask` and `Unmask` components are native components on iOS and Android and are compatible with both the New Architecture and the Legacy Architecture. | ||
|
|
||
| The masking components behave as standard React Native `View` components. | ||
|
|
||
| If you are experiencing issues with unmasking more than one level deep, check if the wrapped components are present in the native views hierarchy. If not your view were evaluated by React Native to be flattened. Read more about [flattening views](https://reactnative.dev/architecture/view-flattening) in the React Native documentation. |
There was a problem hiding this comment.
Suggested change
| ## Troubleshooting | |
| The `Mask` and `Unmask` components are native components on iOS and Android and are compatible with both the New Architecture and the Legacy Architecture. | |
| The masking components behave as standard React Native `View` components. | |
| If you are experiencing issues with unmasking more than one level deep, check if the wrapped components are present in the native views hierarchy. If not your view were evaluated by React Native to be flattened. Read more about [flattening views](https://reactnative.dev/architecture/view-flattening) in the React Native documentation. | |
| ## Troubleshooting | |
| The `Mask` and `Unmask` components are native on iOS and Android and are compatible with both the New and the Legacy Architecture. | |
| The masking components behave as standard React Native `View` components. | |
| If you're experiencing issues with unmasking that are more than one level deep, check if the wrapped components are present in the native views hierarchy. If not, it means that your view was evaluated by React Native and flattened. Read more about [flattening views](https://reactnative.dev/architecture/view-flattening) in the React Native documentation. |
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.