Live (retail) build crash reporting

Last updated on January 6, 2025

Overview​

You can integrate AccelByte Developmental Toolkit (ADT) with your Unreal project to handle crashes from the early development stages through production (live/retail builds).

ADT captures data by using an SDK within your Unreal projects. ADT imposes a limit of up to 1,000 live crashes per day in a namespace. Your quota limit refreshes at 00:00 AM UTC; if your namespace reaches the limit in one day, you must wait for the next day to get your quota back.

The live/retail crash reporting can be configured for Windows and Linux platforms.

This article walks you through how to set and monitor live builds in ADT's Crash Reporter.

Prerequisite​

To start the steps in this guide, you must have first:

Register a build as a release candidate (RC)​

  1. Open the ADT CLI and run this command to add the RC flag.

    .\BlackBoxCLI.exe build register --namespace <Namespace> --apikey <APIKey> --game-project <GameProjectPath> --platform-name <Platform> --platform-arch x64 --game-engine <UE4GameEnginePath> --release-candidate --base-url <BaseURL>

  2. (Optional) Register your build with your preferred name by running this command.

    .\BlackBoxCLI.exe build find-or-register --name <name> --platform-name <platform> --platform-arch x64

    The build will show in ADT Hub as RC.

Update crash reporter URL​

Check the RC flag when you set the Crash URL command. For a live crash, update the crash URL.

.\BlackBoxCLI.exe crash-url set --game-engine <UE4GameEnginePath> --namespace <Namespace> --apikey <APIKey>

Prepare live build​

Open the ADT CLI and run this command:

.\BlackBoxCLI.exe build prepare --namespace <Namespace> --apikey <APIKey> --game-project <GameProjectPath>

At this stage, the system disables the ADT SDK and it is ready to set as Live.

Set the build to live​

important

Once you set the build to live, you can't revert it. Repeat these steps to set another build to live.

You can set your RC build to a live environment in two ways:

Set live build on the Versions page​

  1. Log in to ADT Hub, then go to the Versions page.
  2. Click on the version with your RC build in it.
  3. Click the ellipsis on the build with the RC flag, then click Set this build to Live.
  4. Once the build is set to Live, the flag changes from RC to Live.

Set live build on Crash Reporter page​

  1. Log in to ADT Hub.
  2. Go to the Versions page.
  3. Click on the version with your RC build in it.
  4. Click the build name to open your build page.
  5. At the top of the page, click Set to Live. The build flag changes to Live.

Monitor live crashes on the Crashes page​

  1. Log in to ADT Hub.
  2. Go to the Crashes page.
  3. Filter the crashes based on type.

Monitor live crashes in a build​

  1. Log in to the ADT Hub.
  2. Go to the Version page.
  3. Click on the version containing your live build.
  4. Click on the build name to open its build page.
  5. In the Crash Reporter section, you can see a list of a build's crashes. Click on the filter and select Live to show only the live crashes.
Last updated on

On this page