Skip to content

Commit e69d645

Browse files
authored
Add UE Crash Reporter and Sentry Unreal SDK comparison (#12809)
* Add CRC vs Unreal SDK comparison * Move comparison higher * Fix wording * Update index.mdx
1 parent bc821be commit e69d645

File tree

1 file changed

+28
-1
lines changed
  • docs/platforms/unreal/configuration/setup-crashreporter

1 file changed

+28
-1
lines changed

Diff for: docs/platforms/unreal/configuration/setup-crashreporter/index.mdx

+28-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,34 @@ to the user:
3030

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

33-
### Include the UE Crash Reporter
33+
## Sentry SDK and UE Crash Reporter feature comparison
34+
35+
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:
36+
37+
| Feature | Sentry SDK | Crash Reporter |
38+
|------------------------------|----------------------------|------------------------|
39+
| Supported engine versions | All UE 5 and UE 4.27 | Built-in engine tool |
40+
| Supported platforms | Desktop, mobile, consoles | Desktop |
41+
| Crash capturing * | Supported ** | Supported |
42+
| Additonal event context | Supported | Supported |
43+
| Automatic breadcrumbs | Supported | Not supported |
44+
| Screenshot attachment | Supported *** | Not supported |
45+
| Crash events filtering | Supported | Not supported |
46+
| Release health monitoring | Supported | Not supported |
47+
| Performance insights | Supported | Not supported |
48+
49+
Legend:
50+
`*`: On Windows, the underlying crash capturing mechanisms used in the Sentry SDK and the UE Crash Reporter are mutually exclusive.
51+
`**`: On Windows, crash capturing is supported out of the box starting from UE 5.2.
52+
`***`: Currently this [feature](https://github.com/getsentry/sentry-unreal/issues/567) is supported only on Windows/Linux.
53+
54+
### Using Sentry SDK and UE Crash Reporter together
55+
56+
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.
57+
58+
Features like crash events filtering, screenshot attachment and release health monitoring require the Sentry SDK to be enabled for crash capturing to work properly.
59+
60+
## Include the UE Crash Reporter
3461

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

0 commit comments

Comments
 (0)