Basic configuration#

The configuration settings for the Backtrace client and database are defined by the Backtrace Configuration file in the Assets folder of your Unity project. It's recommended to change the configuration settings for the Backtrace client and database in the Unity Inspector:

Alternatively, you can also specify the configuration settings in your C# project.

Enable Stack traces for WebGL#

1. Open your project in the Unity Editor.
2. From the Unity Editor menu, select Edit > Project Settings.
3. Under Publishing Settings, set Enable Exceptions to Full With Stacktrace.

Backtrace client settings#

Backtrace database settings#

Advanced client settings#

Crash-free metrics reporting#

Once enabled, unique application launches and unique player identifiers (default: guid) will be submitted to Backtrace so you can get an overview of how many errors, hangs, crashes, and memory problems occur compared to all active users for a given platform, version, and more.

Note: This functionality is supported on all platforms except WebGL.

Native support#

Use the Backtrace Unity SDK to capture native crashes for:

• Android
• iOS
• Windows

Android settings#

The Backtrace Unity SDK includes support for capturing native crashes, as well as memory and process information from the underlying Android OS, JNI, and NDK layers, including the following attributes:

• system.memory.free
• system.memory.swap.free
• system.memory.vmalloc.total
• sched.cs.involuntary
• sched.cs.voluntary

Uploading debug symbols#

You can configure the Backtrace client to automatically upload debug symbols in IL2CPP builds for Android apps.

1. Open your project in the Unity Editor.
2. From the Unity Editor menu, select File > Build Settings.
3. In the Build Settings, set Create symbols.zip to Debugging.

4. From the Build Settings, select Player Settings.

5. In the Player Settings, search for “Scripting Backend”.

6. Under Configuration (in Other Settings), set Scripting Backend to IL2CPP.

For more information about debug symbols, see Debug symbols.

iOS settings#

The Backtrace Unity SDK includes support for capturing native crashes, as well as memory and process information from the underlying iOS layer, including the following attributes:

• system.memory.free
• system.memory.swap.used
• system.memory.total
• system.memory.active
• system.memory.inactive

Diasble the CrashReport API#

The CrashReport API might prevent the Backtrace client from sending native crashes for iOS.

1. Open your project in the Unity Editor.
2. From the Unity Editor menu, select File > Build Settings.
3. From the Build Settings, select Player Settings.
4. In the Player Settings, search for “CrashReport API”.
5. Under Crash Reporting (in Debugging and crash reporting), make sure Enable CrashReport API Backend is disabled.

Uploading debug symbols#

When building your iOS game in Xcode, make sure to configure the build settings to generate dSYM files for any build that you want to debug. By default, Xcode may only generate DWARF files.

1. In Xcode, go to your project target's Build Settings.
2. Under Build Options, set Debug Information Format to DWARF with dSYM File.

You can find the dSYM files in the Build folder for your project (.../Build/Products/<build target folder>), which you can then compress into a .zip file and upload to Cloud Diagnostics Advanced.

For more information about debug symbols, see Debug symbols.

Windows settings#

The Backtrace Unity SDK includes support for capturing native Windows crashes.

Logging breadcrumbs#

You can also add custom breadcrumb events, with information like "player completed a level" and sub attributes:

GetComponent<BacktraceClient>().Breadcrumbs.Info("Player Base Upgraded", new Dictionary<string, string>() {
				{"base.name", "MtGox"},
				{"base.level", "15"}
			});