Unreal Engine
Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unreal Engine specific features. It gives developers helpful hints for where and why an error or performance issue might have occurred.
Features:
- Native support for automatic crash error tracking for
- Android by using the Android SDK to support Java, Kotlin, C and C++
- iOS by using the iOS SDK to support Objective-C, Swift, C and C++
- Windows (UE 5.2+) and Linux by using the Native SDK to support C and C++ with minidumps
- macOS by using the macOS SDK to support Objective-C, Swift, C and C++
- Compatible with Crash Reporter Client provided along with Unreal Engine
- Release health to keep track of crash free users and sessions
To automatically capture crashes on Windows with UE 5.1 or older, you have to configure the Crash Reporter Client. Starting from UE 5.2, the provided API allows you to switch between default (CRC) and third-party (Sentry) crash-handling solutions, so the CRC configuration step isn't required. The two are mutually exclusive and can't be used simultaneously.
On this page, we get you up and running with Sentry's SDK.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Sentry captures data by using an SDK within your application’s runtime.
The Unreal Engine (UE) SDK is officially supported for the three latest UE versions. However, it is likely to be compatible with older engine versions as well depending on the specific features and functionality that you need.
To install the SDK, download the most up-to-date sources from the Releases page and add them to your project's Plugins directory. On the next project launch, UE will prompt you to build the Sentry and SentryEditor modules.
Currently, this method is available only for C++ UE projects. Blueprint projects can be converted to a C++ one by adding an empty class using the editor.
The Releases page provides two plugin packages: github and marketplace. The key difference between the two is the crash capturing backend, which is used under the hood on Windows.
We recommend using the github version which uses Crashpad, an out-of-proc handler that sends the crash report right away. The marketplace version relies on Breakpad, an in-proc handler which requires the UE application or game to be relaunched in order to send the crash reports to Sentry.
Alternatively, the Sentry SDK can be downloaded via the standard installation process from its UE Marketplace page within the Epic Games Launcher.
This method is recommended only for Blueprint UE projects. If you already have a C++ UE project or don't mind converting an existing Blueprint UE project to a C++ one, consider downloading the plugin from GitHub instead.
To make sure the Sentry plugin has been enabled after installation has been completed, go to the editor and navigate to the Settings > Plugins > Code Plugins menu and check for the installation.
To access the plugin API from within C++, add Sentry support to the build script (MyProject.build.cs):
PublicDependencyModuleNames.AddRange(new string[] { ..., "Sentry" });
The minimum configuration required is the DSN of your project:
https://examplePublicKey@o0.ingest.sentry.io/0
If you are logged in, you can also go to your project settings and copy its DSN directly from there.
Sentry can be configured using the Sentry configuration window. The window can be accessed by going to editor's menu: Project Settings > Plugins > Sentry.
By default, the SDK is automatically initialized on application startup. Alternatively, the Initialize SDK automatically option can be disabled and in this case, explicit SDK initialization is required.
To override SDK settings at runtime, use the InitializeWithSettings method of the SentrySubsystem class.
This snippet includes message capturing, so you can test that everything is working as soon as you set it up:
#include "SentrySubsystem.h"
void Verify()
{
// Capture message
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();
SentrySubsystem->CaptureMessage(TEXT("Capture message"));
}
The same result can be achieved by calling corresponding function in blueprint:
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").