https://github.com/getsentry/sentry-unreal
Unreal Engine
https://github.com/getsentry/sentry-unreal
crash-reporting hacktoberfest sdk tag-production team-gdx unreal-engine
Last synced: 16 days ago
JSON representation
Unreal Engine
- Host: GitHub
- URL: https://github.com/getsentry/sentry-unreal
- Owner: getsentry
- License: mit
- Created: 2022-03-03T13:41:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-29T03:14:03.000Z (24 days ago)
- Last Synced: 2025-03-30T21:32:53.756Z (22 days ago)
- Topics: crash-reporting, hacktoberfest, sdk, tag-production, team-gdx, unreal-engine
- Language: C++
- Homepage: https://docs.sentry.io/platforms/unreal/
- Size: 79.8 MB
- Stars: 115
- Watchers: 40
- Forks: 46
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
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.
- If an event was captured during the garbage collection, the `BeforeSendHandler` will not be invoked.
- 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](./CONTRIBUTING.md).
## Resources
* [](https://docs.sentry.io/platforms/unreal/)
* [](https://github.com/getsentry/sentry-unreal/discussions)
* [](https://discord.gg/PXa5Apfe7K)
* [](http://stackoverflow.com/questions/tagged/sentry)
* [](https://twitter.com/intent/follow?screen_name=getsentry)