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

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 build the SDK, download the latest sources from the Releases page and place it in the

After the successful build, in the editor navigate to the Settings > Plugins > Code Plugins menu and check whether the Sentry plugin is enabled:

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

https://examplePublicKey@o0.ingest.sentry.io/0

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()
{
    // Obtain reference to GameInstance
    UGameInstance* GameInstance = ...;

    // Capture message
    USentrySubsystem* SentrySubsystem = GameInstance->GetSubsystem<USentrySubsystem>();
    SentrySubsystem->CaptureMessage(TEXT("Capture message"));
}

The same result can be achieved by calling corresponding function in blueprint: