Skip to content

Commit c88d821

Browse files
author
jasoncdavis0
authored
Android section
Added new section on Android support.
1 parent ddd0c3a commit c88d821

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,6 @@ List of steps necessary to setup full Backtrace Unity integration.
5757

5858
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
5959

60-
## Plugin best practices
61-
62-
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.
63-
6460
## Backtrace Client and Offline Database Settings
6561

6662
The following is a reference guide to the Backtrace Client fields:
@@ -84,6 +80,10 @@ The following is a reference guide to the Backtrace Client fields:
8480
- Maximum retries: If the database is unable to send its record, this setting specifies the maximum number of retries before the system gives up.
8581
- Retry order: This specifies in which order records are sent to the Backtrace server.
8682

83+
## Best Practices
84+
85+
The backtrace-unity library allows you to define maximum depth of collected game object information. You can set game object depth to *n*, where *n* is an integer between -1 and 30. -1 is the default and disables collection. An integer between 1 and 30 can be specified to collect game objects *n* levels deep. If you set to 0, the system will collect the game object limit (typically 16).
86+
8787
# API Overview
8888

8989
You can further configure your game to submit crashes by making further changes in the C# code for your game.
@@ -249,6 +249,15 @@ Notes:
249249
- `BacktraceDatabase` `Count` method will return number of all records stored in database (included deduplicated records),
250250
- `BacktarceDatabase` `Delete` method will remove record (with multiple deduplicated records) at the same time.
251251

252+
# Android Specific information
253+
The backtrace-unity library includes support for capturing additional Android Native information, from underlying Android OS (Memory and process related), JNI, and NDK layers.
254+
255+
## Native process and memory related information
256+
system.memory usage related information including memfree, swapfree, and vmalloc.used is now available. Additional VM details and voluntary / nonvountary ctxt switches are included
257+
258+
## ANR
259+
When configuring the nacktrace-unity client for an Android deployment, programmers will have a toggle available in backtrace-unity GUI in the Unity Editor to enable or disable ANR reports. This will use the default of 5 seconds.
260+
252261
# Architecture description
253262

254263
## BacktraceReport <a name="architecture-BacktraceReport"></a>
@@ -307,6 +316,4 @@ The developer who is debugging the error may find it useful to view more details
307316
Below we see more details above the Environment Variables from the Web Debugger to further assist with investigation.
308317
![Backtrace attributes](https://downloads.intercomcdn.com/i/o/85088535/c84ebd2b96f1d5423b36482d/Screen+Shot+2018-11-10+at+12.22.56+PM.png)
309318

310-
# Nice to know
311319

312-
- Backtrace Unity integration use JSON.NET library to create diagnostic JSON. JSON.NET Source code is available in `src` directory. JSON.NET was modified for Backtrace-plugin purpose.

0 commit comments

Comments
 (0)