Skip to content

docs(apple): Add replay overmask troubleshooting #18861

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.

Sign up for GitHub

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

Merged
philprime merged 1 commit into from
Jul 30, 2026
Merged

docs(apple): Add replay overmask troubleshooting #18861

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/platforms/apple/common/session-replay/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,36 @@ Text views, input views, images, video players and webviews are all masked by de

</Expandable>

<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.

@philipphofmann philipphofmann Jul 30, 2026

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.


A malformed `CABasicAnimation` is one possible cause. The animation's `fromValue` and `toValue` must use types compatible with each other and with the animated key path. For example, a `position` animation must use `CGPoint` values for both endpoints:

```swift
// Incorrect: mixes a scalar value with a CGPoint value.
let animation = CABasicAnimation(keyPath: "position")
animation.fromValue = NSNumber(value: 0)
animation.toValue = NSValue(cgPoint: CGPoint(x: 100, y: 100))
```

```swift
// Correct: both endpoints contain CGPoint values.
let animation = CABasicAnimation(keyPath: "position")
animation.fromValue = NSValue(cgPoint: CGPoint(x: 0, y: 0))
animation.toValue = NSValue(cgPoint: CGPoint(x: 100, y: 100))
```

If your code creates the animation, correct the endpoint types. If a third-party UI library creates it, update the library and check its release notes for animation-related fixes.

When SDK debug logging is enabled, a warning similar to the following confirms that Session Replay used this fallback:

```text
Caught Objective-C exception NSInvalidArgumentException: -[NSConcreteValue doubleValue]: unrecognized selector
```

</Expandable>

<Expandable title="What's the lowest version of iOS supported?" permalink>

Session Replay recording happens even on the lowest version supported by the Sentry SDK, which is aligned with App Store support.
Expand Down
Loading