Skip to content

docs(apple): Add replay overmask troubleshooting - #18861

Merged
philprime merged 1 commit into
masterfrom
philprime/session-replay-exception-trouble-shooting
Jul 30, 2026
Merged

docs(apple): Add replay overmask troubleshooting#18861
philprime merged 1 commit into
masterfrom
philprime/session-replay-exception-trouble-shooting

Conversation

@philprime

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Add troubleshooting guidance for Session Replay regions that become completely masked when Core Animation raises during layer traversal.

The entry explains the privacy-safe fallback, identifies mismatched CABasicAnimation endpoint types as a possible cause, provides incorrect and corrected Swift examples, and shows the related SDK warning. This documents the behavior introduced by getsentry/sentry-cocoa#8537.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

EXTRA RESOURCES

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview Jul 29, 2026 11:38am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Jul 29, 2026 11:38am

Request Review

@philipphofmann philipphofmann left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks a lot for updating the troubleshooting guide.


<Expandable title="Why are parts of my replay completely masked?" permalink>

Session Replay may mask an entire layer subtree if Core Animation raises an exception while the SDK inspects it. This privacy-safe fallback prevents the exception from crashing your app and avoids exposing content that the SDK could not inspect for sensitive data.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: I think it would be great to add the SDK version since we have this behavior.

@philprime
philprime merged commit 3107a6c into master Jul 30, 2026
22 checks passed
@philprime
philprime deleted the philprime/session-replay-exception-trouble-shooting branch July 30, 2026 13:33
philprime added a commit that referenced this pull request Jul 31, 2026
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

## DESCRIBE YOUR PR

Follow-up to #18861 addressing the [review
feedback](#18861 (comment)):
the troubleshooting entry for completely masked replays now states that
the privacy-safe fallback applies starting with Sentry Cocoa **9.24.0**,
the release that shipped the fix (getsentry/sentry-cocoa#8537).

## IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs
to go live.

- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
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.

2 participants