Sentry SDK for Unreal Engine
This project is an SDK for Unreal Engine that wraps different Sentry's SDKs for both desktop and mobile. Also, it has a stable support for the Unreal Engine crash reporter.
Downloads
The SDK can be downloaded from the Releases page, which also lists the changelog of every version.
Supported Platforms and Unreal Engine version
The SDK currently supports and is tested on the following platforms:
- Windows
- macOS
- Linux
- Android
- iOS
The SDK complies with three latest engine versions.
Known Limitations
-
Currently automatic crash capturing works only for mobile platforms. In order to capture crashes on Windows and Mac, Crash Reporter has to be configured
-
Using UGS binaries requires tagging of files to ensure the crashpad_handler.exe and sentry.dll is present. For inclusion in build graph, you'd want something like this:
<Tag Files="#EditorBinaries$(EditorPlatform)" Filter="*.target" With="#TargetReceipts"/>
<TagReceipt Files="#TargetReceipts" RuntimeDependencies="true" With="#RuntimeDependencies"/>
<Tag Files="#RuntimeDependencies" Filter="sentry.dll;crashpad_handler.exe" With="#BinariesToArchive$(EditorPlatform)"/>
-
In order to fix errors during the Android debug symbols upload in UE 5.0 or newer (Windows) the default
Android File Serverplugin has to be disabled first. -
To avoid issues with running certain plugin scripts on Windows using PowerShell 7 is recommended.
Development
Please see the contribution guide.
