docs(session-replay): Clarify iOS performance impact on older devices #16205
+111
−18
Conversation
This file contains hidden or 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
Overhaul the Session Replay performance overhead documentation to better communicate the potential for scrolling stutter and frame drops on older iOS devices. This addresses feedback that the documentation didn't clearly explain the impact on scroll behavior. Changes: - Add dedicated "Performance on Older Devices" section with clear warning - Explain why stutter occurs (main thread blocking during screenshot capture) - Document scenarios that increase likelihood of stutter (heavy animations, complex view hierarchies) - Add "Understanding Main Thread Impact" section with timing details - Include View Renderer V2 performance comparison table - Add cross-references from React Native and mobile docs to iOS-specific guidance Closes getsentry/sentry-cocoa#7225
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+130
to
+135
|
|
||
| ```swift | ||
| SentrySDK.start(configureOptions: { options in | ||
| options.sessionReplay.enableFastViewRendering = true | ||
| }) | ||
| ``` |
There was a problem hiding this comment.
Bug: The documentation for sessionReplay.enableFastViewRendering omits the requirement that enableViewRendererV2 must also be enabled, unlike the corresponding screenshot documentation.
Severity: MEDIUM
Suggested Fix
Update the "Enable Fast View Rendering" section in the Session Replay documentation to include a note, similar to the one for screenshots, stating that enableFastViewRendering requires enableViewRendererV2 to be enabled to function correctly.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: docs/platforms/apple/common/session-replay/performance-overhead.mdx#L130-L135
Potential issue: The new documentation for `sessionReplay.enableFastViewRendering` fails
to mention its dependency on `enableViewRendererV2`. The documentation for the
equivalent screenshot feature explicitly states this requirement. A user could disable
`enableViewRendererV2` for troubleshooting and then enable `enableFastViewRendering`,
expecting a performance gain that will not materialize because the prerequisite is
missing. This inconsistency can lead to incorrect SDK configuration and the feature not
providing the expected performance benefits.
Did we get this right? 👍 / 👎 to inform future reviews.
antonis
approved these changes
Jan 29, 2026
Contributor
antonis
left a comment
antonis
left a comment
There was a problem hiding this comment.
LGTM. Thank you for also updating the RN section 🙇
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.
DESCRIBE YOUR PR
Overhaul the Session Replay performance overhead documentation to better communicate the potential for scrolling stutter and frame drops on older iOS devices. This addresses feedback that the documentation didn't clearly explain the impact on scroll behavior.
Changes:
Closes getsentry/sentry-cocoa#7225
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: