Skip to content

Add UE Crash Reporter and Sentry Unreal SDK comparison #12809

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

Merged
merged 4 commits into from
Feb 24, 2025
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,34 @@ to the user:

The UE Crash Reporter works if the Sentry SDK is installed. Sentry SDK can help with configuring the UE Crash Reporter, uploading debug symbols, and enriching crash reports with custom data. **Starting from UE 5.2** users have to choose between the two available crash capturing mechanisms - the UE Crash Reporter or the `sentry-native` library that's integrated into the Sentry plugin. By default, the `sentry-native` library is used instead of the UE Crash Reporter. (See "Enable automatic crash capturing (Windows, UE 5.2+)" in the plugin settings.) The two solutions are mutually exclusive and can't be used simultaneously.

### Include the UE Crash Reporter
## Sentry SDK and UE Crash Reporter feature comparison

Sentry SDK can integrate with the UE Crash Reporter, but it also offers additional features beyond those provided by the built-in tool. The table below outlines the key feature differences:

| Feature | Sentry SDK | Crash Reporter |
|------------------------------|----------------------------|------------------------|
| Supported engine versions | All UE 5 and UE 4.27 | Built-in engine tool |
| Supported platforms | Desktop, mobile, consoles | Desktop |
| Crash capturing * | Supported ** | Supported |
| Additonal event context | Supported | Supported |
| Automatic breadcrumbs | Supported | Not supported |
| Screenshot attachment | Supported *** | Not supported |
| Crash events filtering | Supported | Not supported |
| Release health monitoring | Supported | Not supported |
| Performance insights | Supported | Not supported |

Legend:
`*`: On Windows, the underlying crash capturing mechanisms used in the Sentry SDK and the UE Crash Reporter are mutually exclusive.
`**`: On Windows, crash capturing is supported out of the box starting from UE 5.2.
`***`: Currently this [feature](https://github.com/getsentry/sentry-unreal/issues/567) is supported only on Windows/Linux.

### Using Sentry SDK and UE Crash Reporter together

Adding event context (e.g., tags, custom breadcrumbs, or user information) can always be done through the unified Sentry SDK interface. While only one crash-capturing mechanism can be active at a time, both solutions can be used together for context enrichment, helping to improve the debugging process.

Features like crash events filtering, screenshot attachment and release health monitoring require the Sentry SDK to be enabled for crash capturing to work properly.

## Include the UE Crash Reporter

You can add the _Crash Reporter Client_ to your game in your _Project Settings_.

Expand Down