Kotlin Multiplatform Crash Reporting and Error Tracking
Overview
Error Tracking processes errors collected from the Kotlin Multiplatform SDK.
Enable Kotlin Multiplatform Crash Reporting and Error Tracking to get comprehensive crash reports and error trends. With this feature, you can access:
- Aggregated Kotlin Multiplatform crash dashboards and attributes
- Deobfuscated Kotlin Multiplatform (iOS and Android) crash reports
- Trend analysis with Kotlin Multiplatform error tracking
Your crash reports appear in Error Tracking.
Setup
If you have not set up the Kotlin Multiplatform SDK yet, follow the in-app setup instructions or see the Kotlin Multiplatform setup documentation.
For any given error, you can access the file path, line number, and a code snippet for each frame of the related stack trace.
Android
All uncaught exceptions and ANRs resulting in a crash are reported by the Kotlin Multiplatform SDK (see limitations). On top of these crashes, you can configure the SDK to report NDK crashes, and control the reporting of non-fatal ANRs.
Add NDK crash reporting
Your Android application may be running native code (C/C++) for performance or code reusability. To enable NDK crash reporting, use the Datadog NDK library.
- Add the Gradle dependency to your Android source set by declaring the library as a dependency in your
build.gradle.kts file:
kotlin {
sourceSets {
androidMain.dependencies {
implementation("com.datadoghq:dd-sdk-android-ndk:x.x.x")
}
}
}
- Enable NDK crash collection after initializing the SDK.
// in Android source set
NdkCrashReports.enable()
Add ANR reporting
An “Application Not Responding” (ANR) is an Android-specific type of error that gets triggered when the application is unresponsive for too long.
For any Android version, you can override the default setting for reporting non-fatal ANRs by setting trackNonFatalAnrs (available from Android source set only) to true or false when initializing the SDK.
ANRs are only reported through RUM (not through logs). For more information, see Android Crash Reporting and Error Tracking - Add ANR Reporting.
iOS
Note: Kotlin 2.0.20 or higher is required if crash tracking is enabled on iOS. Otherwise, due to the compatibility with PLCrashReporter, the application may hang if crash tracking is enabled. See other dependencies in the setup instructions.
All uncaught exceptions resulting in a crash are reported by the Kotlin Multiplatform SDK.
Add app hang reporting
App hangs are an iOS-specific type of error that happens when the application is unresponsive for too long.
By default, app hangs reporting is disabled, but you can enable it and set your own threshold to monitor app hangs that last more than a specified duration by using the setAppHangThreshold (available from iOS source set only) initialization method.
App hangs are only reported through RUM (not through logs). For more information, see iOS Crash Reporting and Error Tracking - Add ANR Reporting.
Get deobfuscated stack traces
Mapping files are used to deobfuscate stack traces, which helps in debugging errors. Using a unique build ID that gets generated, Datadog automatically matches the correct stack traces with the corresponding mapping files. This ensures that regardless of when the mapping file was uploaded (either during pre-production or production builds), the correct information is available for efficient QA processes when reviewing crashes and errors reported in Datadog.
Use the following guides to see how you can upload mapping files (Android) or dSYMs (iOS) to Datadog: Android, iOS.
Limitations
File sizing
Individual debug symbols (mapping files and dSYMs) are limited to 500 MB each.
Collection
The SDK handles crash reporting with the following behaviors:
- The crash can only be detected after the SDK is initialized. Because of this, Datadog recommends that you initialize the SDK as soon as possible in your application.
- RUM crashes must be attached to a RUM view. If a crash occurs before a view is visible, or after the app is sent to the background by the end-user navigating away from it, the crash is muted and isn’t reported for collection. To mitigate this, use the
trackBackgroundEvents() method in your RumConfiguration builder. - Only crashes that occur in sampled sessions are kept.
Test your implementation
To verify your Kotlin Multiplatform Crash Reporting and Error Tracking configuration, you need to trigger a crash in your application and confirm that the error appears in Datadog.
To test your implementation:
Run your application on an Kotlin Multiplatform emulator or a real device.
Execute some code containing an error or crash. For example:
fun onEvent() {
throw RuntimeException("Crash the app")
}
After the crash happens, restart your application and wait for the Kotlin Multiplatform SDK to upload the crash report in Error Tracking.
Further Reading
Additional helpful documentation, links, and articles:
