mastern2k3 / sentry-unity

Sentry SDK for Unity3d

Home Page:https://sentry.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Using Sentry in Unity

Usage

In order to make Sentry work, you need to add SentrySdk component to any GameObject that is in the first loaded scene of the game.

You can also add it programatically. There can only be one SentrySdk in your whole project. To add it programatically do:

var sentry = myGameObject.AddComponent(typeof(SentrySdk)) as SentrySdk;
sentry.dsn = "__YOUR_DSN__";

The SDK needs to know which project within Sentry your errors should go to. That's defined via the DSN. DSN is the only obligatory parameter on SentrySdk object.

This is enough to capture automatic traceback events from the game. They will be sent to your DSN and you can find them at sentry.io

Example

There is an example scene in the Sentry asset. It has two components - SentrySdk and SentryTest. SentryTest is a component that handles button presses to crash or fail assert. SentrySdk is the main component that you have to use in your own project.

API

The basic API is automatic collection of test failures, so it should mostly run headless. There are two important APIs that are worth considering.

  • collecting breadcrumbs

    SentrySdk.AddBreadcrumb(string)

    will collect a breadcrumb.

  • sending messages

    SentrySdk.CaptureMessage(string)

    would send a message to Sentry.

Unity version

The lowest required version is Unity 5.6. Previous versions might work but were not tested and will not be supported.

Resources

About

Sentry SDK for Unity3d

https://sentry.io

License:MIT License


Languages

Language:C# 100.0%