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

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.

Install

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.

There are three common ways to install an SDK to use with Unreal Engine:

1. Install from the Epic Games Fab (formerly known as the marketplace)
2. Download a pre-built SDK that you install (for example, from a GitHub Releases page)
3. Clone and build the SDK yourself and install

While you can use any of the three methods to install Sentry, each has its own limitations, as described below.

Overview of SDK Versions

The table below highlights some key differences between different versions of the SDK:

Legend:
*: Recommended version of the SDK
**: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion.

Installing from GitHub Releases (Recommended)

The GitHub 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, because it 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 before any crash reports can be sent to Sentry.

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.

Installing from Fab

Sentry SDK can be downloaded via the standard installation process from its Epic Games Fab page.

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.

Build Yourself

To get started, we recommend cloning the Unreal SDK repository and running the initialization script:

• ./scripts/init.sh on macOS/Linux
• ./scripts/init-win.ps1 on Windows

This script links the checked out version of the plugin (the plugin-dev directory) to the sample app and downloads the latest builds of native SDKs from our GitHub CI.

After successful initialization, copy the contents of the plugin-dev directory to <your_project_root>/Plugins/Sentry. This will allow you to use Sentry in your Unreal Engine project.

Confirm Installation

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" });

Configure

The minimum configuration required is the DSN of your project:

{
  "public-dsn": "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.

Verify

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:

To view and resolve the recorded error, log into sentry.io and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.