Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(apple): Replay Redact #11418

Merged
merged 11 commits into from
Oct 14, 2024
Merged

feat(apple): Replay Redact #11418

merged 11 commits into from
Oct 14, 2024

Conversation

brustolin
Copy link
Contributor

@brustolin brustolin commented Sep 23, 2024

Adding instructions on how to use custom redact APIs for Apple SDK.

Copy link

vercel bot commented Sep 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 6:29am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 6:29am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 8, 2024 6:29am

Copy link
Member

@JoshuaMoelans JoshuaMoelans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just have some minor nitpicks on grammar & small question about using ignoreView without disabling the default

Copy link

codecov bot commented Sep 26, 2024

Bundle Report

Changes will increase total bundle size by 14.09MB (99.77%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
sentry-docs-server* 7.46MB 7.46MB (100%) ⬆️⚠️
sentry-docs-edge-server* 254.44kB 254.44kB (100%) ⬆️⚠️
sentry-docs-client* 6.38MB 6.38MB (100%) ⬆️⚠️
sentry-docs-server-cjs 7.45MB 224 bytes (0.0%) ⬆️
sentry-docs-edge-server-array-push 257.07kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.42MB 6 bytes (-0.0%) ⬇️

ℹ️ *Bundle size includes cached data from a previous commit

@chargome
Copy link
Member

@brustolin please rebase this on master, then the pr should be un-blocked!

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this! I left a few edits, but overall it looks great.

docs/platforms/apple/guides/ios/session-replay/index.mdx Outdated Show resolved Hide resolved
Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to explain the difference between redact and ignore, cause I don't get it 😅


## Redact by View class

You can choose which type of view you want to redact or ignore by using the `redactViewClasses` or `ignoreViewClasses` options.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: After reading this and the whole document, I'm still unsure of the difference between redact and ignore. Can we add a short explanation, please?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document was updated. Please take another look

Co-authored-by: Liza Mock <liza.mock@sentry.io>
@@ -0,0 +1,66 @@
---
title: Using Custom Redact for Session Replay
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we name it Privacy similar to the JS sdk? https://docs.sentry.io/platforms/javascript/session-replay/privacy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont know, should we?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also add here the resume/pause functionality, and I think in this case it'd make sense to rename it as it's not only custom redaction/masking anymore. Maybe Privacy Controls or something like that would do?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I will improve in another doc. This is waiting for too long

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's clearer to me now. LGTM

Copy link
Member

@bruno-garcia bruno-garcia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one note but LGTM


<Alert>

If you choose to use custom masking in your Session Replays, you may accidentally expose sensitive customer data. Be sure to double-check what you choose to expose.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's because for that they must disable the default masking, right?
Worth calling that out?

@lizokm might have ideas?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just an extra reminder, so the user understands the severity of it.

@bruno-garcia
Copy link
Member

Lets add the min version need for this. We can remove later when we GA the whole thing and remove the .experimental property. Mention the final version with the non beta support

Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FAQ for SwiftUI Replay Redaction
7 participants