Skip to content

Commit 8d3354a

Browse files
authored
feat(android): document tombstone support (#16301)
1 parent 483afe5 commit 8d3354a

File tree

3 files changed

+94
-1
lines changed

3 files changed

+94
-1
lines changed
326 KB
Loading
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Android Native Crash Reporting (Tombstones)
3+
sidebar_order: 2
4+
description: Learn how to configure Tombstone support.
5+
---
6+
7+
The Tombstone Integration generates events for native crashes based on data ("tombstones") that Android attaches to [`ApplicationExitInfo.REASON_CRASH_NATIVE`](https://developer.android.com/reference/android/app/ApplicationExitInfo#REASON_CRASH_NATIVE) starting with [Android 12+](https://developer.android.com/reference/android/app/ApplicationExitInfo#getTraceInputStream()).
8+
9+
This crash context is collected by the operating system during the app’s shutdown after a crash. Because part of the collection runs out of process, it can capture richer crash details than the [NDK integration](/platforms/android/configuration/using-ndk/) and also is safer.
10+
11+
In particular, you will get:
12+
13+
* stack-traces for each of the threads in your process (which on Android is often key to understanding crashes)
14+
* improved stack traces through Android Runtime stack frames
15+
* client-side symbolication of all system libraries (while still allowing for server-side symbolication of your binaries to keep app size small)
16+
* safer crash context collection reduces crashes during crash handling
17+
* potentially smaller artifacts since the Tombstone Integration is part of `android-core` (if you [don't need the NDK integration](/platforms/android/configuration/using-ndk/#using-the-sdk-without-the-ndk) as a fallback)
18+
19+
Keep in mind that the Tombstone Integration is not a full replacement for the NDK integration:
20+
21+
* it only works on devices running Android 12+
22+
* if you instrument your native code with the NDK integration already, then Tombstones will only improve native crash reports, you still need the NDK integration for capturing native context
23+
24+
However, if you don't develop native code for your apps, but use packages that have native code and a significant portion of your users runs on Android 12+, then the Tombstone Integration can be a replacement.
25+
26+
![Tombstone Thread Stack Trace](./img/tombstone_stacktrace.png)
27+
28+
#### Enabling the Tombstone Integration
29+
30+
The Tombstone Integration is disabled by default. You can enable the tombstone integration using:
31+
32+
```xml {filename:AndroidManifest.xml}
33+
<application>
34+
<meta-data android:name="io.sentry.tombstone.enable" android:value="true" />
35+
</application>
36+
```
37+
38+
#### Merging Tombstone and NDK Crash Events
39+
40+
It generally makes sense run the [NDK integration](/platforms/android/configuration/using-ndk/) (`io.sentry.ndk.enable`) and the Tombstone integration at the same time:
41+
42+
* if you have users on devices < Android 12 (in which case the NDK integration will solely be reporting native crashes)
43+
* if you use functions of the Native SDK from your native code and want your collected context to be reflected in the crash reports
44+
45+
The reports from both integrations will be merged on the client into a single report, which will later be enriched. This means that whenever the Android version allows it, you will get improved crash reporting from tombstones; otherwise, the SDK falls back to the best-effort implementation from the NDK integration. In both cases, the Native SDK context is preserved in the final report.
46+
47+
#### Tombstone Mechanisms
48+
49+
We introduced two new mechanisms to help identify the integration from which reports originate:
50+
51+
* A report originating only from a tombstone will be called `Tombstone`
52+
* A report being a merged result from a tombstone and a Native SDK event will be called `TombstoneMerged`
53+
* A report originating solely from the NDK integration (Native SDK) will continue to be called `signalhandler`
54+
55+
#### Symbolication
56+
57+
As mentioned above, Android infrastructure will try to symbolicate as much as possible on the client side. This is particularly important for system and framework symbols, since they can differ considerably across devices. If symbols cannot be resolved on the client - for instance, for your supplied binaries - the [backend symbolication](/platforms/android/configuration/using-ndk/#symbolicate-stack-traces) process follows the same rules as with the NDK integration.
58+
59+
#### Debug Images
60+
61+
In contrast to NDK integration, Tombstones retrieve module memory mappings at the time of the crash and are thus always up-to-date. If you use the NDK integration as a fallback for older Android versions, you still need to clear the module cache when dynamically loading libraries after app initialization.
62+
63+
#### Historical Tombstones
64+
65+
By default, the SDK only reports and enriches the latest Tombstones. However, there's also a `setReportHistoricalTombstones` option available in `SentryOptions`, which enables the SDK to report all Tombstones from the [getHistoricalExitReasons](<https://developer.android.com/reference/android/app/ActivityManager?hl=en#getHistoricalProcessExitReasons(java.lang.String,%20int,%20int)>) list:
66+
67+
```kotlin
68+
SentryAndroid.init(context) { options ->
69+
options.isReportHistoricalTombstones = true
70+
}
71+
```
72+
73+
```java
74+
SentryAndroid.init(context) { options ->
75+
options.setReportHistoricalTombstones(true)
76+
}
77+
```
78+
79+
This option is useful after upgrading to an SDK version that introduces the Tombstone integration, as it allows you to report any tombstones that occurred before the update.
80+
81+
It can also make sense if you get recurring reports of native crashes early during app start, or if your app regularly runs and restarts during longer offline periods.
82+
83+
Other than that, the SDK will always pick up the latest Tombstone from the historical exit reasons list on the next app restart, and there won’t be any historical Tombstones to report. Also keep in mind that historical Tombstones will receive only minimal updates, as the available data is likely out of sync.
84+
85+
#### Interaction with other Options
86+
87+
Similar to ANR, for Tombstone derived events the options `attachThreads` and `attachStacktrace` are currently without effect.

docs/platforms/android/configuration/using-ndk.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ NDK integration is packed with the SDK. The package `sentry-android-ndk` works b
1010

1111
You can [disable the NDK integration](#disable-ndk-integration), or use our Sentry Android SDK [without the NDK](#using-the-sdk-without-the-ndk).
1212

13+
<Alert>
14+
15+
Starting with Sentry Android SDK version 8.32.0 you can enable the [Tombstone Integration](/platforms/android/configuration/tombstones/) as a replacement or extension to the NDK integration.
16+
17+
</Alert>
18+
1319
## Symbolicate Stack Traces
1420

1521
To symbolicate the stack trace from native code, we need to have access to the debug symbols of your application.
@@ -123,7 +129,7 @@ sentry_clear_modulecache();
123129
```
124130

125131
```kotlin
126-
// 1. Manually initialize the SDK,
132+
// 1. Manually initialize the SDK,
127133
// in order to keep a reference to the SDK options
128134
var optionsRef: SentryAndroidOptions? = null
129135
SentryAndroid.init(this) { options ->

0 commit comments

Comments
 (0)