Skip to content

Commit aed7f18

Browse files
author
jasoncdavis0
authored
TOC Update for Breadcrumbs and Crash Free Metrics
1 parent dc3e596 commit aed7f18

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Create your Backtrace instance at https://backtrace.io/create-unity today and th
1717
- [iOS Specific information](#ios-specific-information)
1818
- [Data Privacy](#data-privacy)
1919
- [API Overview](#api-overview)
20+
- [Breadcrumbs](#breadcrumbs)
21+
- [Crash Free Metrics](#crash-free-metrics)
2022
- [Architecture description](#architecture-description)
2123
- [Investigating an Error in Backtrace](#investigating-an-error-in-backtrace)
2224

@@ -444,7 +446,7 @@ backtraceClient.BeforeSend =
444446

445447
`BacktraceClient` supports reporting of unhandled application exceptions not captured by your try-catch blocks. To enable reporting of unhandled exceptions please use Backtrace configuration UI available in the Unity IDE.
446448

447-
## Breadcrumbs
449+
## Breadcrumbs <a name="breadcrumbs"></a>
448450

449451
Once enabled, various "breadcrumb" events (such as application going to background, logging message, network connectivity lost and many more) will be submitted with all types of Backtrace reports and viewable in the web console. It is possible to configure client-side which events to include and from which log level severity. By default the breadcrumbs are limited to 64kB and older events will automatically be cleaned up. This functionality is supported on all Unity supported platforms.
450452

@@ -461,7 +463,7 @@ GetComponent<BacktraceClient>().Breadcrumbs.Info("Player Base Upgraded", new Dic
461463
});
462464
```
463465

464-
## Crash Free Metrics
466+
## Crash Free Metrics <a name="crash-free-metrics"></a>
465467

466468
Once enabled, unique application launches and unique player identifiers (default: guid) will be submitted to Backtrace so you will be able to get an overview in our web console of how many errors, hangs, crashes and memory problems occur compared to all active users for a given platform, version, etcetera. See the README for more info on functionality and configuration options.
467469

0 commit comments

Comments
 (0)