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](https://docs.sentry.io/platforms/unreal/setup-crashreport/). ## Downloads The SDK can be downloaded from the [Releases] page, which also lists the changelog of every version, or from the [UE Marketplace] page via Epic Games launcher. [releases]: https://github.com/getsentry/sentry-unreal/releases [UE Marketplace]: https://www.unrealengine.com/marketplace/en-US/product/sentry-01 If manual download from the [Releases] page is a preferred way for plugin integration using the package with the `github` suffix in its name is recommended. ## Supported Platforms and Unreal Engine version The SDK currently supports and is tested on the following platforms: - Windows - macOS - Linux - Android - iOS The SDK compiles with three latest engine versions. Blog posts: * [Building the Sentry Unreal Engine SDK with GitHub Actions](https://blog.sentry.io/building-the-sentry-unreal-engine-sdk-with-github-actions/) ## Known Limitations - On all platforms captured crashes are uploaded to Sentry only after relaunching the crashed app since the in-process handler cannot do this within the same session. The only exceptions are Windows (if using the GitHub package) and Linux for which the out-of-process crashpad handler is used and crashes are uploaded immediately. - To automatically capture crashes in Windows game builds that were made using engine versions prior to UE 5.2, the [Crash Reporter has to be configured](https://docs.sentry.io/platforms/unreal/setup-crashreport/) first. - Using UGS binaries requires tagging of files to ensure the crashpad_handler.exe is present. For inclusion in build graph, you'd want something like this: ``` ``` - In UE 5.2 or newer game log attached to crashes captured with `sentry-native` integration instead of [crash reporter](https://docs.sentry.io/platforms/unreal/setup-crashreport/) could be truncated. This is caused by current `crashpad` behavior which sends crashes to Sentry right away while UE is still about to write some bits of information to the log file. - Only crash events captured on Android contain the full callstack. Events that were captured manually won't have the native C++ part there. - `BeforeSendHandler` and `BeforeBreadcrumbHandler` hooks will not be invoked during garbage collection. - It may be required to upgrade the C++ standard library (`libstdc++`) on older Linux distributions (such as Ubuntu 18.04 and 20.04) to ensure crashpad handler proper functionality within the deployment environment. This can be achieved with something like this: ``` sudo apt-get update sudo add-apt-repository ppa:ubuntu-toolchain-r/test sudo apt-get install -y libstdc++6 ``` - Plugin supports Linux arm64 platform for UE 5.0 and newer. - Fast-fail crash capturing is currently supported only in packaged game builds when using the `github` plugin version. When a fast-fail crash occurs the `HandleBeforeSend` hook will not be invoked and any custom event pre-processing will be skipped. Also, captured fast-fail crash events will not include UE-specific tags or context. ## Development Please see the [contribution guide](https://github.com/getsentry/sentry-unreal/blob/main/CONTRIBUTING.md). ## Resources * * * [![Discord Chat](https://camo.githubusercontent.com/f05a4ef2b036755c5ae904b5fc693a0ec206a2d46c1e7c61f1ec5317f57f6ddc/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3632313737383833313630323232313036343f6c6f676f3d646973636f7264266c6f676f436f6c6f723d66666666666626636f6c6f723d373338394438)](https://discord.gg/PXa5Apfe7K) * * [![Twitter Follow](https://camo.githubusercontent.com/6940ce25dfe1f9645a4b6bd379d629d9628195bbc59a49cadec51385957b097e/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f67657473656e7472793f6c6162656c3d67657473656e747279267374796c653d736f6369616c)](https://twitter.com/intent/follow?screen_name=getsentry)