Mobile RUM - Android SDK

The Mobile RUM SDK provides a customizable suite of tools to analyze and optimize the performance of Android applications. Isolate ANR and network changes, quickly detect application crashes, identify slow or frozen frames and more.

To see an example of how to deploy the Mobile RUM Android SDK, navigate to our GitHub repository here.


Android SDK Version 21 or above. Check your Android SDK version with the following command:

Install & Instrument Your Android Application

Step 1: Install Middleware Android SDK

Step 2: Add Application Instrumentation Config

To modify your configuration methods, navigate to the Configuration Methods section

Step 2a: Configuration Methods [Optional]

Understand the behavior of your RUM Android application with the following methods and set particular attributes related to telemetry ingestion, monitoring, and instrumentation.

setRumAccessToken(String)Authorizes client to send telemetry to Middleware
setTarget(String)Sets target URL to recieve telemetry
setService(String)Sets service name of your application
setDeploymentEnvironment(String)Sets environment attribute on spans generated by instrumentation. Example: PROD, DEV
disableCrashReporting()Disables crash reporting which is enabled by default
disableAnrDetection()Disables Application Not Responding (ANR) detection which is enabled by default
disableNetworkMonitor()Disables network change detection which is enabled by default
disableSlowRenderingDetection()Disables slow or frozen frame render detection which is enabled by default
setSlowRenderingDetectionPollInterval(Duration)Sets default polling for slow or frozen render detection. Default detection interval is 1000 milliseconds

Step 3: HTTP Instrumentation Config [Optional]

Integrate with OkHTTP3 to monitor HTTP events across user devices.

Custom Configurations

Set Global Attributes

Global attributes serve as metadata or contextual information that can be attached to telemetry, traces, or logs collected by the instrumentation framework or SDK. They are key-value pairs that provide additional details about the application, device, user session, or environment.

Set the following Global Attributes to instrument your application:


Step 1: Setup Your Custom Event

Send custom events and workflows using addEvent

Step 2: Start Custom Event Workflow

Start custom events and workflows using startWorkflow

Step 3: End Custom Event Workflow

End custom events and workflows using end

Error Reporting

Use addException(Throwable) to report exceptions, errors, and display messages on the Middleware dashboard


Add custom logs to display on your Middleware dashboard such as debug, error, warning, and info

Session Replay

Control how you capture and replay your users' browsing experience. To start and stop session replay, override the onResume and onPause methods.

This feature is only available for Android Version 8.0 (Android Oreo) or higher

Session Recording

The maximum session recording duration is four hours. If users are inactive for more than 15 minutes at a time, session recordings will be stopped. If users exceed more than four hours in a single session or become active again after the 15-minute inactivity timeout, a new session will be automatically created.

Session recording is enabled by default. Disable this feature with the following function:


Blur sensitive information in session recordings by embedding the following method:

User passwords are automatically masked by default. Other sensitive information like credit card data and API keys must be masked manually.

Default Attributes

The following Attributes are provided by the Android SDK by default:

NameTypeDescription , appStringDefines the project name, used as projectName(String)
service.nameStringDefines the service name, used as serviceName(String)
session.idStringRandom session identifier generated by Middleware SDK
rum.sdk.versionStringMiddleware SDK version

Resource Attributes

The following Resource Attributes are applied to all spans by default:

envStringName of deployment environment. Example: DEV, PROD
device.model.identifierStringDevice model identifier. Example: Moto-G30
device.model.nameStringName of device. Example: ONEPLUS A600
device.manufacturerStringName of device manufacturer. Example: OnePlus
os.nameStringName of operating system. Sets to Android
os.descriptionStringOperating System description. Example: Android Version 11 (Build RKQ1.201217.002 API level 30)
os.typeStringOperating System type. Sets to Linux
os.versionStringOperating System version. Example: Android version 11

Instrumentation Attributes

The following Instrumentation Attributes are additional properties the Android SDK provides:

Crash Reporting

Crash Reporting is enabled by default and adds the following Crash Reporting attributes to spans that represent uncaught exceptions:

thread.idIntegerID of the current managed thread, as opposed to the operating system thread ID
thread.nameStringName of the thread
exception.messageStringMessage of the exception
exception.typeStringType of exception
exception.stacktraceStringStack trace for the exception
exception.escapedStringSets true, denoting the uncaught exception, such as a crash occurring
componentStringSets crash
event.typeStringSets error

Network Monitoring

Network Monitoring is enabled by default and produce spans with the name network.change and the following attributes:

network.statusStringNetwork status set to lost or available
network.connection.typeStringConnection type set to wifi, cell, unavailable, or unknown
network.carrier.nameStringName of network carrier used

Application Not Responding (ANR)

Application Not Responding (ANR) event detection creates spans whenever the primary application thread remains unresponsive for over 5 seconds. ANR is enabled by default.

ANR include the following attributes:

exception.stacktraceStringStack trace for the exception
componentStringSets error
event.typeStringSets error

Slow Rendering Detection

Slow Rendering Detection produces spans whenever it identifies a slow or frozen frame render. Rendering is considered slow if its duration surpasses 16 milliseconds and frozen if it exceeds 700 milliseconds.

During each interval, slow rendering detection generates up to two spans: one named slowRenders for tallying slow frames, and another named frozenRenders for tallying frozen frames. Slow Render Detection is enabled by default.

Spans generated by Slow Rendering Detection include the following attribute:

countIntegerNumber of slow or frozen frames on a 1 second interval. Change the interval duration by passing a positive integer (in milliseconds) to the slowRenderingDetectionPollInterval(Duration) setting

HTTP Client Attributes

The Android RUM agent includes instrumentation for OkHttp. To activate this functionality, see Step 3 from the above installation here.

OKHttp includes the following attributes:

http.methodStringGET, POST, HEAD
http.status_codeInteger200, 404, 418
http.user_agentStringCERN-LineMode/2.15 libwww/2.17b3
net.peer.portInteger80, 8080, 443
componentStringSets http

Activity Lifecycle Monitoring

By default, Activity lifecycle Monitoring is enabled. It generates spans whenever an activity undergoes a state change. The name of an activity lifecycle span can vary based on its state. Below is a list of all possible states:

componentStringSets ui
activityName, activity.nameStringName of the activity class. Example: MainActivity

Fragment Lifecycle Monitoring

Fragment lifecycle monitoring involves generating spans whenever an fragment undergoes a state change. The name of a fragment lifecycle span can vary based on its state::

  • Created: Activity starts for the first time.

  • Restarted:Activity restarts after being stopped.

  • Resumed: Activity resumes after a pause.

  • Paused: Activity is paused.

  • Stopped: Activity stops.

  • Destroyed: Activity is destroyed.

componentStringSets ui
fragmentNameStringName of the fragment class Example: MainFragment

App Start Monitoring

The app start monitoring feature creates spans each time the app undergoes a cold, warm, or hot start.

  • Cold Starts: Occurs when users open the app for the first time after booting their phone or terminating the app.

  • Warm Starts: Occurs when some operations from a cold start are still in progress. Warm starts are quicker than cold starts but slower than hot starts.

  • Hot Starts: Occurs when the system brings an app to the foreground. They are faster than cold starts as the app is already loaded.

App start monitoring generates spans named AppStart with associated attributes:

componentStringSets appstart
start.typeStringType of start. Value cold, warm, or hot

Need assistance or want to learn more about Middleware? Contact our support team in Slack.