Skip to content

Commit dfe66e0

Browse files
author
jasoncdavis0
authored
Adding info about debug.logerrors
Details on the 5 classes of Errors backtrace captures. Details up to Best Practices.
1 parent f6b9237 commit dfe66e0

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# Backtrace Unity support
33

4-
[Backtrace](http://backtrace.io/)'s integration with Unity allows developers to capture and report handled and unhandled Unity exceptions and crashes to their Backtrace instance, instantly offering the ability to prioritize and debug software errors.
4+
[Backtrace](http://backtrace.io/)'s integration with Unity allows developers to capture and report log errors, handled and unhandled Unity exceptions, and native crashes to their Backtrace instance, instantly offering the ability to prioritize and debug software errors.
55

66
[![openupm](https://img.shields.io/npm/v/io.backtrace.unity?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/io.backtrace.unity/)
77

@@ -37,8 +37,8 @@ catch(Exception exception){
3737

3838
# Feature Summary <a name="features-summary"></a>
3939

40-
- Lightweight library that quickly submits handled and unhandled exceptions and crashes to Backtrace
41-
- Supports wide range of Unity versions (2017.4+) and deployments (iOS, Android, Windows, Mac, WebGL, PS4, Xbox, Switch, Stadia)
40+
- Lightweight library that quickly submits log errors, handled and unhandled exceptions, and native crashes to Backtrace
41+
- Supports wide range of Unity versions (2017.4+) and deployments (iOS, Android, Windows, Mac, WebGL, PS4/5 Xbox One/S/X, Nintendo Switch, Stadia)
4242
- Install via Universal Package Manager
4343
- Collect detailed context
4444
- Callstacks, including function names and line numbers where possible
@@ -48,8 +48,9 @@ catch(Exception exception){
4848
- Android NDK Crashes; iOS Native Crashes, Windows Native Crashes
4949
- Client-side features
5050
- Deduplication options and custom client side fingerprinting
51+
- Client side filters and sampling controls
5152
- Offline crash capture/storage for future collection
52-
- Customizable event handlers and base classes, Client side filters
53+
- Customizable event handlers and base classes
5354
- Performance statistics collection option for timing observability
5455
- Unity IDE integration to configure Backtrace behaviors in your game.
5556

@@ -66,7 +67,7 @@ PC - Windows, Mac
6667
Web - WebGL
6768
Game Consoles - PlayStation4, Xbox One, Nintendo Switch
6869
There are some differences in capabilities that backtrace-unity provides based on the platform. Major capabilities are summarized as follows:
69-
* All Platforms - Unhandled Exceptions, Handled Exceptions, Custom Indexable Metadata, File Attachments*, Last N Log Lines, Automatic attachment of Screenshots, Client Side Deduplication Rules*, Client Side Submission Filtering, Client Side Submission Limits, Performance Diagnostics, Offline Database*(Except Nintendo Switch)
70+
* All Platforms - Errors, Unhandled Exceptions, Handled Exceptions, Custom Indexable Metadata, File Attachments*, Last N Log Lines, Automatic attachment of Screenshots, Client Side Deduplication Rules*, Client Side Submission Filtering, Client Side Submission Limits, Performance Diagnostics, Offline Database*(Except Nintendo Switch)
7071
* Android -Identified by attribute uname.sysname = Android; ANRs (Hangs), Native Process and Memory Information, Java Exception Handler (Plugins, Exported Game in Android Studio), NDK crashes.
7172
* iOS - Identified by attribute uname.sysname = IOS; Native Engine and Plugin Crashes.
7273
* WebGL - Identified by attribute uname.sysname = WebGL. The attribute device.model is currently used to share the browser information. Note that stacktraces for WebGL errors are only available if you choose to enable them in the Publishing Settings / Enable Exceptions drop down. More details in https://docs.unity3d.com/Manual/webgl-building.html
@@ -125,7 +126,16 @@ If you need to use more advanced configuration, `Initialize` method accepts a `B
125126

126127
## Plugin best practices
127128

128-
Plugin allows you to define maximum depth of game objects. By default its disabled (Game object depth is equal to -1). If you will use 0 as maximum depth of game object we will use default game object limit - 16. If you would like to specify game object depth size to n, please insert n in Backtrace configuration text box. If you require game obejct depth to be above 30, please contact support.
129+
The plugin will report on 5 'classes' or errors:
130+
1) Log Errors - Programmers use Debug.LogError(https://docs.unity3d.com/ScriptReference/Debug.LogError.html), a variant of Debug.Log, to log error messages to the console.
131+
2) Unhandled Exceptions - Unhandled Exceptions are exceptions in a game that occur outside of an explicit try / catch statement.
132+
3) Handled Exceptions - Exceptions that are explicitly caught and handled.
133+
4) Crashes - An end to the game play experience. The game crashes or restarts.
134+
5) Hangs - A game is non responsive. Some platforms will tell the user “This app has stopped responding
135+
136+
The plugin provide 2 controls for manaing what the client will report. [SkipReports](#filtering_a_report) allows you to tell the client to only report on specific classes of these errors, and and LogSampling will allow you to tell the client to sample the Debug Log errors so programmers don't 'shoot themselves in the foot' by releasing the plugin to a many users and report on hundreds of low priority and recoerable errors that they may not be intending to capture.
137+
138+
The plugin allows you to collect game objects if you like by specifying a depth of hierarchy to inspect to for game objects. By default its disabled (Game object depth is equal to -1). If you will use 0 as maximum depth of game object we will use default game object limit - 16. If you would like to specify game object depth size to n, please insert n in Backtrace configuration text box. If you require game obejct depth to be above 30, please contact support.
129139

130140
## Backtrace Client and Offline Database Settings
131141

0 commit comments

Comments
 (0)