Add integration with Session Replay product for native platforms#1445
Conversation
Instructions and example for changelogPlease add an entry to Example: ## Unreleased
### Features
- Add integration with Session Replay product for native platforms ([#1445](https://github.com/getsentry/sentry-unreal/pull/1445))If none of the above apply, you can opt out of this check by adding |
4bd006c to
1ae3c03
Compare
Removed unnecessary .deps.json and .runtimeconfig.json files from the package snapshot.
|
Is this ready to go, or waiting for a sentry-native release? |
Technically, this can be merged as-is. However, I'd like to add end-to-end tests for replay envelope capturing and to do that we'll first need to pull in the native changes introduced in getsentry/sentry-native#1809. |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 48652af. Configure here.
# Conflicts: # CHANGELOG.md
This PR updates the Unreal SDK Session Replay documentation now that the feature is fully integrated with the corresponding Sentry product. Related items: - getsentry/sentry-unreal#1445 - getsentry/sentry-unreal#1468

This PR adds Session Replay product integration for platforms where
sentry-nativeis used (desktop, bothcrashpadandnativebackends supported). The gameplay recorded in the rolling buffer before a crash is now delivered to Sentry as a separate session replay envelope (discoverable in the Replays dashboard and associated with the crash) instead of only being attached to the event as an MP4 file.Example replay capture.
Key Changes
replay-<id>.json) next to the rolling MP4.replay_idis set on the event's replay context so the crash and the replay are linked.replay_videoenvelope from the sidecar + MP4 and sends it to Sentry:crashpad: writes the envelope to the run directory via the disk transport, where it is picked up on the next application launch.native: uploads the envelope out of process during the same crashed session.trace id, so the it correlates with the crash's events/spans.Known Limitations
crashpadbackend (default) is used, the replay envelope is uploaded on the next application launch after the crash occurs. With thenativebackend (opt-in), the replay envelope is uploaded to Sentry during the same crashed session.cocoabackend is used, the replay clip remains attached to the crash event as an MP4 attachment.Depends on:
Related items