Unity

🏗 Installation

BugSplat's com.bugsplat.unity package can be added to your project via or a URL to our git .

OpenUPM

Information on installing OpenUPM can be found . After installing OpenUPM, run the following command to add BugSplat to your project.

openupm add com.bugsplat.unity

Git

Information on adding a Unity package via a git URL can be found .

https://github.com/BugSplat-Git/bugsplat-unity.git

🧑‍🏫 Sample

After installing com.bugsplat.unity, you can import a sample project to help you get started with BugSplat. Click here if you'd like to skip the sample project and get straight to the instructions.

To import the sample, click the carrot next to Samples to reveal the my-unity-crasher sample. Click Import to add the sample to your project

In the Project Assets browser, open the Sample scene from Samples > BugSplat > Version > my-unity-crasher > Scenes.

Next, select Samples > BugSplat > Version > my-unity-crasher to reveal the BugSplatOptions object. Click BugSplatOptions and replace the database value with your BugSplat database.

⚙️ Configuration

BugSplat's Unity integration is flexible and can be used in various ways. The easiest way to get started is to attach the BugSplatManager Monobehaviour to a GameObject.

BugSplatManager needs to be initialized with a BugSplatOptions serialized object. A new instance of BugSplatOptions can be created through the Asset Create menu.

Configure fields as appropriate. Note that if Application or Version are left empty, BugSplat will default these values to Application.productName and Application.version, respectively

Finally, provide a valid BugSplatOptions to BugSplatManager

⌨️ Usage

Adding Metadata

First, find your instance of BugSplat. The following is an example of how to find an instance of BugSplat via BugSplatManager:

var bugsplat = FindObjectOfType<BugSplatManager>().BugSplat;

You can extend BugSplat by setting the following properties:

bugsplat.Attachments.Add(new FileInfo("/path/to/attachment.txt"));
bugsplat.Description = "description!";
bugsplat.Email = "fred@bugsplat.com";
bugsplat.Key = "key!";
bugsplat.Notes = "notes!";
bugsplat.User = "Fred";
bugsplat.CaptureEditorLog = true;
bugsplat.CapturePlayerLog = false;
bugsplat.CaptureScreenshots = true;

You can use the Notes field to capture arbitrary data such as system information:

void Start()
{
    bugsplat = FindObjectOfType<BugSplatManager>().BugSplat;
    bugsplat.Notes = GetSystemInfo();
}

private string GetSystemInfo()
{
    var info = new Dictionary<string, string>();
    info.Add("OS", SystemInfo.operatingSystem);
    info.Add("CPU", SystemInfo.processorType);
    info.Add("MEMORY", $"{SystemInfo.systemMemorySize} MB");
    info.Add("GPU", SystemInfo.graphicsDeviceName);
    info.Add("GPU MEMORY", $"{SystemInfo.graphicsMemorySize} MB");

    var sections = info.Select(section => $"{section.Key}: {section.Value}");
    return string.Join(Environment.NewLine, sections);
}

Try/Catch Reporting

Exceptions can be sent to BugSplat in a try/catch block by calling Post.

try
{
    throw new Exception("BugSplat rocks!");
}
catch (Exception ex)
{
    StartCoroutine(bugsplat.Post(ex));
}

The default values specified on the instance of BugSplat can be overridden in the call to Post. Additionally, you can provide a callback to Post that will be invoked with the result once the upload is complete.

var options = new ReportPostOptions()
{
    Description = "a new description",
    Email = "barney@bugsplat.com",
    Key = "a new key!",
    Notes = "some new notes!",
    User = "Barney"
};

options.AdditionalAttachments.Add(new FileInfo("/path/to/additional.txt"));

static void callback()
{
    Debug.Log($"Exception post callback!");
};

StartCoroutine(bugsplat.Post(ex, options, callback));

Preventing Repeated Reports

By default, BugSplat prevents reports from being sent at a rate greater than 1 per every 60 seconds. You can override the default crash report throttling implementation by setting ShouldPostException on your BugSplat instance. To override ShouldPostException, assign the property a new Func<Exception, bool> value. Be sure your new implementation can handle a null value for Exception!

The following example demonstrates how you could implement your own time-based report throttling mechanism:

var lastPost = new DateTime(0);

bugsplat.ShouldPostException = (ex) =>
{
    var now = DateTime.Now;

    if (now - lastPost < TimeSpan.FromSeconds(3))
    {
        Debug.LogWarning("ShouldPostException returns false. Skipping BugSplat report...");
        return false;
    }

    Debug.Log("ShouldPostException returns true. Posting BugSplat report...");
    lastPost = now;

    return true;
};

Support Response

BugSplat has the ability to display a support response to users who encounter a crash. You can show your users a generalized support response for all crashes, or a custom support response that corresponds to the type of crash that occurred. Defining a support response allows you to alert users that bug has been fixed in a new version, or that they need to update their graphics drivers.

private string infoUrl = "";

public void Event_CatchExceptionThenPostNewBugSplat()
{
    try
    {
        GenerateSampleStackFramesAndThrow();
    }
    catch (Exception ex)
    {
        var options = new ReportPostOptions()
        {
            Description = "a new description"
        };

        StartCoroutine(bugsplat.Post(ex, options, ExceptionCallback));
    }
}

void ExceptionCallback(ExceptionReporterPostResult result)
{
    UnityEngine.Debug.Log($"Exception post callback result: {result.Message}");

    if (result.Response == null) {
        return;
    }

    UnityEngine.Debug.Log($"BugSplat Status: {result.Response.status}");
    UnityEngine.Debug.Log($"BugSplat Crash ID: {result.Response.crashId}");
    UnityEngine.Debug.Log($"BugSplat Support URL: {result.Response.infoUrl}");

    infoUrl = result.Response.infoUrl;
}

private void OpenUrl(string url)
{
    var escaped = url.Replace("?", "\\?").Replace("&", "\\&").Replace(" ", "%20").Replace("!", "\\!");

#if UNITY_STANDALONE_WIN || UNITY_EDITOR_WIN || UNITY_WSA
    Process.Start(url);
#elif UNITY_STANDALONE_OSX || UNITY_EDITOR_OSX
    Process.Start("open", escaped);
#elif UNITY_STANDALONE_LINUX || UNITY_EDITOR_LINUX
    Process.Start("xdg-open", escaped);
#else
    UnityEngine.Debug.Log($"OpenUrl unsupported platform: {Application.platform}");
#endif
}

When an exception occurs, a page similar to the following will open in the user's browser on Windows, macOS, and Linux.

🪟 Windows

Symbols

Minidumps

The methods PostCrash, PostMostRecentCrash, and PostAllCrashes can be used to upload minidumps to BugSplat. We recommend running PostMostRecentCrash when your game launches.

StartCoroutine(bugsplat.PostCrash(new FileInfo("/path/to/crash/folder")));
StartCoroutine(bugsplat.PostMostRecentCrash());
StartCoroutine(bugsplat.PostAllCrashes());

Each of the methods that post crashes to BugSplat also accept a MinidumpPostOptions parameter and a callback. The usage of MinidumpPostOptions and callback are nearly identical to the ExceptionPostOptions example listed above.

You can generate a test crash on Windows with any of the following methods.

Utils.ForceCrash(ForcedCrashCategory.Abort);
Utils.ForceCrash(ForcedCrashCategory.AccessViolation);
Utils.ForceCrash(ForcedCrashCategory.FatalError);
Utils.ForceCrash(ForcedCrashCategory.PureVirtualFunction);

🌎 UWP

To use BugSplat in a Universal Windows Platform application, you will need to add some capabilities to the Package.appxmanifest file in the solution directory that Unity generates at build time.

Capabilities

Reporting exceptions, crashes, and uploading log files requires the Internet (Client) capability.

Minidumps

To upload minidumps from %LOCALAPPDATA%\CrashDumps you will also need to add the broadFileSystemAccess restricted capability. To add access to the file system you will need to add the following to your Package.appxmanifest:

<Package xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities" ... >

Under the Capabilities section add the broadFileSystemAccess capability:

<Capabilities>
    <rescap:Capability Name="broadFileSystemAccess" />
</Capabilities>

🤖 Android

The bugsplat-unity plugin supports crash reporting for native C++ crashes on Android via Crashpad. To configure crash reporting for Android, set the UseNativeCrashReportingForAndroid and UploadDebugSymbolsForAndroid properties to true on the BugSplatManager instance.

You'll also need to configure the scripting backend to use IL2CPP, and target ARM64 (ARMV7a is not supported)

When you build your app for Android, be sure to set Create symbols.zip to Debugging

🍎 iOS

The bugsplat-unity plugin supports crash reporting for native C++ crashes on iOS via bugsplat-ios. To configure crash reporting for iOS, set the UseNativeCrashReportingForIos and UploadDebugSymbolsForIos properties to true on the BugSplatManager instance.