---

Getting Started   •   Getting Involved   •   Security

---

Splunk Android SDK

The Splunk Android SDK provides comprehensive Real User Monitoring capabilities for Android applications. Built on OpenTelemetry, it features a modular architecture that allows you to include only the instrumentations and features that you need.

For official documentation on the Splunk OTel Instrumentation for Android, see Instrument Android applications for Splunk RUM.

Modules Overview

The agent is composed of several modules, each responsible for a specific type of instrumentation.

Module	Summary	Enabled by Default?
ANR Detection	Detects and reports Application Not Responding (ANR) events.	Yes
App Startup Tracking	Measures cold, warm, and hot application start times.	Yes
Crash Reporting	Captures and reports application crashes with full stack traces.	Yes
Custom Tracking	Manually track custom events, errors, and workflows.	Yes
Navigation Tracking	Automatically tracks Android Activity and Fragment lifecycle events and screen transitions.	No
Network Change Detection	Monitors and reports network connectivity status changes.	Yes
Network Request Instrumentation	Manually track HTTP requests made via OkHttp3 or use gradle plugins to automatically instrument and track OkHttp3 and HttpURLConnection requests	Yes (for manual OkHttp3 tracking); No (for automatic tracking, which requires adding Gradle plugins)
Session Replay	Provides a visual replay of user sessions.	No
Slow & Frozen Render Detection	Detects and reports UI frames that are slow or frozen during rendering.	Yes
User Interaction Tracking	Automatically captures user taps, focus, and other UI interactions.	Yes
WebView Instrumentation	Links native RUM sessions with Browser RUM in WebView components.	Yes

Getting Started

For complete setup instructions with code examples and advanced configuration options, please refer to the official documentation.

Requirements

• Android API Level 24+ (Android 7.0)
• Android Gradle Plugin 8.6.0+
• Java 8+ compatibility with core library desugaring

1. Enable Core Library Desugaring

API levels 24 to 25 require core library desugaring activated

See Activate desugaring in your application

2. Specify Java 8 Compatability

In your app module's build.gradle file, specify Java 8 compatibility under the android compileOptions block

sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

3. Add Maven Central Repository

In your project's root build.gradle file, inside the allprojects block, add mavenCentral() to the list of repositories:

allprojects {
    repositories {
        google()
        mavenCentral()
        ...
    }
}

4. Add SDK Dependency

Add the Splunk RUM agent library to your app module's build.gradle file dependencies:

implementation("com.splunk:splunk-otel-android:2.0.0")

Important: Remove the following line from your dependencies if present, as the upstream OpenTelemetry Android repo is already linked in our SDK:

implementation("io.opentelemetry.android:instrumentation:2.0.0")

5. Initialize the Agent

Initialize the Splunk RUM agent in your Application class onCreate() method:

import android.app.Application
import com.splunk.rum.integration.agent.api.AgentConfiguration
import com.splunk.rum.integration.agent.api.EndpointConfiguration
import com.splunk.rum.integration.agent.api.SplunkRum

class AppTest: Application() {

    override fun onCreate() {
        super.onCreate()

        val agentConfiguration = AgentConfiguration(
            endpoint = EndpointConfiguration(
                realm = SPLUNK_REALM,
                rumAccessToken = SPLUNK_RUM_ACCESS_TOKEN
            ),
            appName = "<your-app-name>",
            deploymentEnvironment = "<your-deployment-environment>",
            appVersion = "<your-app-version>"
        )

        val splunkRum = SplunkRum.install(this, agentConfiguration)
    }

    companion object {
        private const val SPLUNK_REALM = "<SPLUNK_REALM>"
        private const val SPLUNK_RUM_ACCESS_TOKEN = "<YOUR_SPLUNK_ACCESS_TOKEN>"
    }
}

6. Optional: Enable Automatic Network Request Instrumentation

Add the following Gradle Plugins for automatic network request tracking:

• com.splunk.rum-okhttp3-auto-plugin
• com.splunk.rum-httpurlconnection-auto-plugin

Sample Application

This repository includes a sample application ('app' module) that demonstrates most features of the Android RUM agent.

To use the sample app, configure the following properties in your global gradle.properties:

splunkRealm=<realm>
splunkRumAccessToken=<a valid Splunk RUM access token for the realm>

Troubleshooting

For troubleshooting issues with the Splunk OpenTelemetry instrumentation of Android, see Troubleshoot Android instrumentation for Splunk Observability Cloud in the official documentation.

License

The Splunk Android RUM Instrumentation is licensed under the terms of the Apache Software License version 2.0. See the license file for more details.