Skip to content

Update configuration.md - Add Android SDK new ANR detection method - ApplicationExit #3160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update configuration.md - Add Android SDK new ANR detection method - ApplicationExit #3160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/error-reporting/platform-integrations/android/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,17 +167,24 @@ If you create any new files in the same directory as your `BacktraceDatabase` di

## Application Not Responding (ANRs)

The `BacktraceClient` allows you to detect Application Not Responding (ANR) errors that occur when the main thread is blocked for more than 5 seconds. You can enable ANR reporting as follows:
The `BacktraceClient` enables detection of Application Not Responding (ANR) errors that occur when the main thread is blocked for longer than 5 seconds. The library provides two methods for ANR detection:

```java
backtraceClient.enableAnr(timeout, event, debug);
```
- **Threshold-based detection (`AnrType.Threshold`)** - this method starts a separate monitoring thread that continuously checks the responsiveness of the main thread. If the main thread remains unresponsive for a specified duration (default: 5 seconds), an ANR is reported. This is the default detection method.

Configuration options include:
- `timeout`: Time (in milliseconds) the main thread must be blocked before triggering an ANR report.
- `event`: A custom callback to be invoked instead of the default ANR handling.
- `debug`: Prevents ANR reporting while the app is running in debug mode.

You can also provide the following parameters as an argument:
- **ApplicationExitInfo-based detection (`AnrType.ApplicationExit`)** - available on Android 12 (API level 31) and above. This method retrieves a list of historical process exit reasons using `ActivityManager.getHistoricalProcessExitReasons()` and reports any exits classified as ANRs.

- `timeout`: Specifies how long (in milliseconds) the thread should be blocked before the ANR is reported.
- `event`: Specifies an event, which will be executed instead of handling the ANR error by default.
- `debug`: Does not report ANRs if the app is in debug mode.
You can enable ANR detection with:

```java
backtraceClient.enableAnr(AnrType.Threshold);
// or
backtraceClient.enableAnr(AnrType.ApplicationExit);
```

## Offline Database Settings

Expand Down