You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Right click on empty space in Unity workspace and select from the menu box `Backtrace > Configuration`. This option generate new empty asset file in your solution. You can drag and drop generated asset file into Backtrace Client configuration window.
40
+
* Download the backtrace-unity zip file. Unzip it and keep the folder in a known location. It can be downloaded from https://github.com/backtrace-labs/backtrace-unity/releases
41
+
* Open your Unity project and ensure it is configured to build with .NET 4.5+ runtime and a mono or il2cpp backend.
42
+
* Copy the unzipped folder to your project's asset folder in the Windows File Explorer. The Unity editor will refresh and the Backtrace Plugin should become available in the editor.
43
+
44
+
## Integrating into your project
45
+
46
+
* Under the Assets Menu, there is now a Backtrace -> Configuration option. Choose that option (or Right click on empty space and select from the menu box) to have a Backtrace Configuration is generated in the Assets folder. You can drag and drop generated asset file into Backtrace Client configuration window.
50
47
48
+
* Next, select an object from the Scene Hierarchy to associate the Backtrace reporting client to. In the example below, we use the Manager object., Using the Inspector panel, click the Add Component button and search for the Backtrace Client object.
49
+
* Within the Backtrace Client panel, there is a Backtrace Configuration field. Drag and drop the Backtrace Configuration from the Assets folder to that field. More fields will appear for you to fill in to configure the Backtrace Client and Offline Database options.
**Server url*: the url to Backtrace server instance. The user can start
56
-
typing only their instance name (for example "my-bt-server"), and the plugin will guess
57
-
the rest of the server url (for example "https://my-bt-server.sp.backtrace.io").
58
-
59
-
60
-
**Token*: Token to the Backtrace project instance. This field requires
61
-
that the provided string has exactly **64** characters. If the developer doesn't
62
-
know or doesn't have the access token, the plugin allows the user to browse
63
-
tokens if the project name is available.
64
-
65
-
**ReportsPerMinute*: Determine how many reports `Backtrace Unity` library should send per minute.
66
-
67
-
**Handle unhandle exceptions*: Determine if library by default should handle unhandled exceptions.
54
+
Watch this 1 minute silent video to see the Integration and Configuration in action. The first 20 seconds of the video shows the above Integrating steps, and the second part shows details of the below Client and Database Settings - https://player.vimeo.com/video/300051476
68
55
56
+
## Backtrace Client and Offline Database Settings
69
57
70
-
## Database support configuration
71
-
Backtrace Unity integration allows to store on hard drive offline reports. `BacktraceDatabase` provide methods to save reports when you lost a connection.
58
+
The following is a reference guide to the Backtrace Client fields:
72
59
73
-
To setup `BacktraceDatabase` configuraiton:
74
-
* Select `Enable Database` checkbox in `Backtrace Client` configuration window,
75
-
* Provide valid Backtrace database configuration and store offline reports in your game!
* Server Address and Token: These fields are required to submit exceptions from your Unity project to your Backtrace instance. More information about how to retrieve these values for your instance is our docs at What is a submission URL and What is a submission token? NOTE: the backtrace-unity plugin will attempt to autofill the Server Address field for you based on your instance name (if you enter killerwhales and leave the field, it will autofill with https://killerwhales.sp.backtrace.io:6098)
61
+
* Reports per minute: Limits the number of reports the client will send per minutes. If set to 0, there is no limit. If set to a higher value and the value is reached, the client will not send any reports until the next minute. Further, the BacktraceClient.Send/BacktraceClient.SendAsync method will return false.
62
+
* Handle unhandle exceptions: Toggle this on or off to set the library to handle unhandled exceptions that are not captured by try-catch blocks.
63
+
* Enable Database: When this setting is toggled, the backtrace-unity plugin will configure an offline database that will store reports if they can't be submitted do to being offline or not finding a network. When toggled on, there are a number of Database settings to configure.
64
+
* Backtrace Database path: This is the path to directory where the Backtrace database will store reports on your game. NOTE: Backtrace database will remove all existing files on database start
65
+
* Create database directory toggle: If toggled, the library will create the offline database directory if the provided path doesn't exists,
66
+
* Auto Send Mode: When toggled on, the database will send automatically reports to Backtrace server based on the Retry Settings below. When toggled off, the developer will need to use the Flush method to attempt to send and clear. Recommend that this is toggled on.
67
+
* Maximum number of records: This is one of two limits you can impose for controlling the growth of the offline store. This setting is the maximum number of stored reports in database. If value is equal to zero, then limit not exists, When the limit is reached, the database will remove the oldest entries.
68
+
* Maximum database size: This is the second limit you can impose for controlling the growth of the offline store. This setting is the maximum database size in MB. If value is equal to zero, then size is unlimited, When the limit is reached, the database will remove the oldest entries.
69
+
* Retry interval: If the database is unable to send its record, this setting specifies how many seconds the library should wait between retries.
70
+
* Maximum retries: If the database is unable to send its record, this setting specifies the maximum number of retries before the system gives up.
71
+
* Retry order: This specifies in which order records are sent to the Backtrace server.
77
72
78
-
79
-
80
-
81
-
**Field overview**
82
-
*`BacktraceDatabase` can use diffrent *Server url**Token**Reports per minute* and *Handle unhandled exceptions* values. These values are necessary if user want to send an offline reports to any `Backtrace` server,
83
-
**Backtrace Database path*: Path to directory where Backtrace database will store reports. Be aware! `Backtrace database` will remove all existing files on database start,
84
-
**Automatically send*: Determine if database should send automatically reports to `Backtrace` server,
85
-
**Create database directory*: Determine if library should create offline database directory if provided path doesn't exists,
86
-
**Maximum number of records*: Maximum number of stored reports in database. If value is equal to zero, then limit not exists,
87
-
**Maximum database size*: Maximum database size in MB. If value is equal to zero, then size is unlimited,
88
-
**Retry interval*: How much seconds library should wait before next retry,
89
-
**Maximum retries*: Maximum number of retries,
90
-
**RetryOrder*: Record order in database.
91
-
92
-
93
-
## Web debugger result:
94
-
95
-
96
-
# Api overview
73
+
# API Overview
74
+
You can further configure your game to submit crashes by making further changes in the C# code for your game.
97
75
98
76
## Basic configuration
99
77
If you setup `Backtrace client` and `Backtrace database` configuration you can retrieve database and client instances by using `GameObject`. When you retrieve client instance you can start sending reports from try/catch blok in your game!
@@ -253,6 +231,15 @@ If you want to clear your database or remove all reports after send method you c
**`ReportWatcher`** is a class that validate send requests to the Backtrace endpoint. If `reportPerMin` is set in the `BacktraceClient` constructor call, `ReportWatcher` will drop error reports that go over the limit. `BacktraceClient` check rate limit before `BacktraceApi` generate diagnostic json.
255
233
234
+
# Investigating an Error in Backtrace
235
+
Once errors are being reported to your Backtrace instance, you should see them in your Triage and Web Debugger view. See below for a screenshot of the Triage view with some Unity exceptions reported.
The developer who is debugging the error may find it useful to view more details of Exception. They choose the 'View Latest Trace' action to see more details in the Backtrace Web Debugger. Below we can see a list of all attributes submitted with a report. (Note the yield signs are just an indicator that this value is not indexed in Backtrace). We can also see the call stack and details of the selected frame.
0 commit comments