Session Replay Android Standalone SDK
Use the Session Replay Android Standalone SDK if you use a provider other than Amplitude for in-product analytics. If your app already uses the Amplitude Android SDK, use the Session Replay Android SDK Plugin instead.
Report issues
To report issues with Session Replay for Android, go to the AmplitudeSessionReplay-Android GitHub repository.
Session Replay and performance
Amplitude built Session Replay to minimize impact on the performance of the Android apps in which it's installed by:
- Asynchronously capturing and processing replay data, to avoid blocking the main user interface thread. The main thread must analyze the view hierarchy, but snapshot capture scheduling and extra processing offloads to the background.
- Using batching and lightweight compression to reduce the number of network connections and bandwidth.
- Optimizing view hierarchy processing. Contact Amplitude if you experience issues with hierarchy processing.
Prerequisites
The Session Replay Standalone SDK has these requirements:
- Your application runs on Android.
- You track sessions with a timestamp or a custom string session ID that you can pass to the SDK. Inform the SDK whenever the session identifier changes.
- You can provide a device ID to the SDK.
- The session and device IDs you pass to the standalone SDK match the IDs on analytics events you send to Amplitude.
The Standalone SDK doesn't manage sessions. Your application or a third-party integration must update the SDK when the session ID or device ID changes.
Supported Android versions
Session replay supports down to Android 5.0 with a minimum SDK of 21 minSdk = 21. This should support over 99.6% of global Android devices according to Google's distribution data in Android Studio.
Quickstart
These instructions cover Session Replay Android 1.0. If you already use Session Replay, follow Migrate to version 1.0.
Compose capture requires the Gradle plugin
Starting with Session Replay Android 1.0, Compose capture doesn't work unless you install and apply the com.amplitude.session-replay Gradle plugin in your Android app module. Adding the runtime dependency alone doesn't enable Compose capture.
Add mavenCentral() to pluginManagement.repositories at the start of your project's settings.gradle.kts. The Session Replay Gradle plugin is published to Maven Central.
// settings.gradle.kts
pluginManagement {
repositories {
mavenCentral()
gradlePluginPortal()
google()
}
}
Also include mavenCentral() in your dependency repositories so Gradle can resolve the runtime libraries.
Apply the Gradle plugin in your app module and disable automatic dependency addition. Declare only the standalone runtime at the same version as the Gradle plugin:
// app/build.gradle.kts
plugins {
id("com.amplitude.session-replay") version "1.0.0"
}
sessionReplay {
autoAddDependencies = false
}
dependencies {
implementation("com.amplitude:session-replay-android:1.0.0")
}
This setup doesn't require analytics-android or plugin-session-replay-android. The runtime includes its required Analytics Core dependency transitively. Keep the Gradle plugin's integration check enabled.
Create one SessionReplay instance in your application's startup code. Supply the same device ID and session ID that your analytics integration sends to Amplitude:
import com.amplitude.android.sessionreplay.SessionReplay
import com.example.ThirdPartyAnalytics
val sessionReplay = SessionReplay(
apiKey = "AMPLITUDE_API_KEY",
context = applicationContext,
deviceId = ThirdPartyAnalytics.getDeviceId(),
sessionId = ThirdPartyAnalytics.getSessionId(),
configuration = SessionReplay.Configuration {
sampleRate = 1.0
},
)
// Update replay before recording events for a new session or device.
sessionReplay.setSessionAndDeviceId(
sessionId = ThirdPartyAnalytics.getSessionId(),
deviceId = ThirdPartyAnalytics.getDeviceId(),
)
Replace AMPLITUDE_API_KEY with your project's API key and ThirdPartyAnalytics with your analytics integration. The numeric session ID must be a Long. For string session IDs, initialize with sessionId = -1L, then call setCustomSessionId. Refer to Custom session IDs.
Capture starts automatically by default. The example samples every session; choose a production sample rate before rollout. Remote configuration defaults to true and can override local settings. To test only your local settings, set enableRemoteConfig = false inside SessionReplay.Configuration.
Configuration
Pass apiKey, context, deviceId, and sessionId to the SessionReplay constructor. Set the remaining options inside SessionReplay.Configuration. The constructor that accepts individual capture options is deprecated.
| Option | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey | String | Yes | n/a | Your Amplitude API key. |
context | Context | Yes | n/a | The Android application context. |
deviceId | String? | Yes | n/a | Identifier for the device running your application. Pass null to suppress capture when you don't yet have a device ID. |
sessionId | Long | Yes | n/a | Identifier for the user's current session, in milliseconds since epoch (Unix timestamp). To use a string session ID instead, pass -1 and call setCustomSessionId after initialization. Refer to Custom session IDs. |
sampleRate | Double | No | 0.0 | Controls how many sessions Amplitude selects for replay collection. Use a decimal between 0 and 1, for example 0.4, which selects 40% of sessions over a large number of sessions. |
optOut | Boolean | No | false | Sets permission to collect replays. A value of true prevents Amplitude from collecting session replays. |
logger | Logger? | No | LogcatLogger | Sets a custom logger to emit log messages to a destination. Set to null to disable logging. |
enableRemoteConfig | Boolean | No | true | Enables or disables remote configuration for this instance of Session Replay. |
serverZone | ServerZone | No | ServerZone.US | ServerZone.EU or ServerZone.US. Set this to EU for Amplitude projects created in the EU data center. |
privacyConfig | PrivacyConfig | No | PrivacyConfig() | Privacy settings that control which views Session Replay masks. Set the mask level with PrivacyConfig(maskLevel = MaskLevel.MEDIUM). Refer to Mask level. |
serverUrl | String? | No | null | Advanced. Full URL that Session Replay uploads data to, for example your proxy. Overrides serverZone. |
bandwidthLimitBytes | Int? | No | null | Advanced. Daily upload limit, in bytes, on metered (for example, cellular) connections. |
storageLimitMB | Int? | No | null | Advanced. Local storage limit, in MB. |
autoStart | Boolean | No | true | Starts screen capture automatically when Session Replay initializes. |
recordLogOptions.logCountThreshold | Int | No | 1000 | Maximum number of logs per session. |
recordLogOptions.maxMessageLength | Int | No | 2000 | Maximum length of a log message. |
Custom session IDs
Session Replay for Android version 0.26.4 and later supports string session IDs, for example UUIDs, through the setCustomSessionId method. Use a custom session ID if your project defines sessions with a custom event property instead of a timestamp-based session_id.
The constructor accepts only a numeric sessionId. To use a string value, pass -1 as the sessionId, then call setCustomSessionId. Session Replay doesn't capture until you set a valid session ID.
val sessionReplay = SessionReplay(
apiKey = "AMPLITUDE_API_KEY",
context = applicationContext,
deviceId = "device-id",
sessionId = -1,
configuration = SessionReplay.Configuration {
sampleRate = 1.0
},
)
// Set a string session ID instead of the numeric sessionId
sessionReplay.setCustomSessionId("ef197fc7-a46f-4e6c-a77f-8d90c17065c0")
// Whenever your custom session changes
sessionReplay.setCustomSessionId(ThirdPartyAnalytics.getCustomSessionId())
The numeric sessionId and the custom session ID are two views of the same underlying value, which the SDK stores as a string:
- Calling
setSessionIdreplaces the current custom session ID with the numeric value. When you use custom session IDs, callsetCustomSessionIdinstead ofsetSessionIdwhenever the session changes. - When the stored value isn't numeric,
getSessionIdreturns-1. CallgetCustomSessionIdto read the current value. - Setting a different value ends the current replay and starts a new one.
For Session Replay to match custom sessions reliably, custom session IDs must follow these constraints:
- The value can't contain
/. Session Replay uses/as a delimiter in the session replay ID, which has the format<deviceId>/<sessionId>. - The value can contain only the characters
a-z A-Z 0-9 _ - . | @ : =. - The value must match the session-defining property you send on events to Amplitude. For more information, refer to Session matching.
Remote configuration
Enable remote configuration to set Sample Rate and Masking Level in Amplitude.
Remote configuration and testing
With enableRemoteConfig set to true, settings you define in Amplitude take precedence over settings you define locally in the SDK. For this reason, while testing your application, you should disable remote configuration to ensure you can set sampleRate to 1, and ensure you capture test sessions.
Mask on-screen data
The Session Replay SDK offers four ways to mask user input, text, and other view components.
Mask level
Session Replay for Android supports three levels of masking, set through the privacyConfig option with PrivacyConfig(maskLevel = MaskLevel.MEDIUM). The default level is medium.
Use this option in the Session Replay configuration.
| Mask level | Description |
|---|---|
light | Masks password, email, and phone number input fields. In SDK 0.26.2 and later, light also masks any field with sensitive autofill hints (credit card number, expiration, and security code; name; username; postal address and code); autofill-hint detection requires Android 8.0 (API 26) or higher. Earlier versions, including the middleware-session-replay-android artifact, mask only the input-field types above. |
medium (default) | Everything in light, plus all editable text fields (EditText). |
conservative | Everything in medium, plus all text views (TextView). |
Privacy tags in layout XML
Use this option in your application's layout XML.
| View | Description |
|---|---|
<EditText> | Session Replay masks all text input fields by default. When a user enters text into an input field, Session Replay captures asterisks in place of text. To unmask a text input, add the tag amp-unmask. For example: <EditText android:tag="amp-unmask" android:text="Unmask this">. |
<TextView> | To mask text within non-input elements, add the tag amp-mask. For example, <TextView android:tag="amp-mask" android:text="Mask this"/>. When masked, Session Replay captures masked text as a series of asterisks. |
| non-text elements | To block a non-text element, add the tag amp-block. For example, <ImageView android:tag="amp-block"/>. Session Replay replaces blocked elements with a placeholder of the same dimensions. |
<WebView> | To unmask a web view, add the amp-unmask tag. For example, <WebView android:tag="amp-unmask"/>. |
Privacy methods on the Session Replay SDK
Import the SessionReplay class, then call one of the methods below from your application's code.
import com.amplitude.android.sessionreplay.SessionReplay
| Method | Description |
|---|---|
unmask(view: View) | To unmask a view manually, call SessionReplay.unmask(view) where view references a masked view. |
mask(view: View) | To mask text within non-input views, call SessionReplay.mask(view) where view references the view you want to mask. When masked, Session Replay captures masked text as a series of asterisks. |
block(view: View) | To block a non-text view, call SessionReplay.block(view) where view is a reference to the View you want to block. Session Replay replaces blocked views with a placeholder of the same dimensions. |
Privacy modifiers in Jetpack Compose
For composables, use the privacy modifiers instead of layout XML tags or the SessionReplay methods. These modifiers require version 0.21.0 or higher of the Session Replay Android SDK or plugin. Starting with version 1.0, Compose capture also requires the Gradle plugin.
Import the modifier you need from com.amplitude.android.sessionreplay.compose, then add it to the composable's modifier chain.
import com.amplitude.android.sessionreplay.compose.ampMask
import com.amplitude.android.sessionreplay.compose.ampUnmask
import com.amplitude.android.sessionreplay.compose.ampBlock
| Modifier | Description |
|---|---|
Modifier.ampMask() | Masks text that Session Replay captures by default, such as the contents of a Text composable. Session Replay captures masked text as a series of asterisks. |
Modifier.ampUnmask() | Unmasks a composable that Session Replay masks by default, such as a TextField. |
Modifier.ampBlock() | Blocks a composable. Session Replay replaces blocked composables with a placeholder of the same dimensions and doesn't capture their contents. |
// Mask text that Session Replay captures by default
Text(
text = "Account number: 123456789",
modifier = Modifier.ampMask(),
)
// Unmask an input field that Session Replay masks by default
TextField(
value = username,
onValueChange = { username = it },
modifier = Modifier.ampUnmask(),
)
// Block a composable and everything it contains
Box(modifier = Modifier.ampBlock()) {
Text("Session Replay doesn't capture this content")
}
A privacy modifier applies to the composable you add it to and to everything nested inside it. A nested composable can override inherited masking with ampUnmask(). In version 1.0, a child can't override an ancestor's ampBlock().
User opt-out
Pass optOut = true during initialization to prevent Amplitude from collecting session replays:
// Pass a boolean value to indicate a users opt-out status
val sessionReplay = SessionReplay(
apiKey = "AMPLITUDE_API_KEY",
configuration = SessionReplay.Configuration {
optOut = true
},
/* other session replay options */
)
Call setOptOut at runtime to pause or resume capture without restarting the SDK:
// Pause capture
sessionReplay.setOptOut(true)
// Resume capture
sessionReplay.setOptOut(false)
// Check the current opt-out state
val isOptedOut = sessionReplay.getOptOut()
EU data residency
Session Replay is available to Amplitude Customers who use the EU data center. Set the serverZone configuration option to EU during initialization. For example:
import com.amplitude.core.ServerZone
// Set serverZone to EU
val sessionReplay = SessionReplay(
apiKey = "AMPLITUDE_API_KEY",
configuration = SessionReplay.Configuration {
serverZone = ServerZone.EU
},
/* other session replay options */
)
Sampling rate
By default, Session Replay captures 0% of sessions for replay. Use your SDK's sampleRate configuration option to set the proportion of sessions to capture.
For manual and dynamic sampling, quota planning, and quota accounting, go to Configure Session Replay sampling.
// This configuration samples 1% of all sessions
val sessionReplay = SessionReplay(
apiKey = "AMPLITUDE_API_KEY",
configuration = SessionReplay.Configuration {
sampleRate = 0.01
},
/* other session replay options */
)
Targeted Replay Capture
Session Replay Android standalone SDK 1.1.0 and later supports Targeted Replay Capture (TRC), which captures only the sessions that match conditions you set in Session Replay settings. The standalone SDK doesn't receive your analytics events, so pass events and the user's properties to Session Replay:
- Call
setUserPropertieswith the user's complete set of properties right after you create theSessionReplayinstance, and again whenever the properties change. Each call replaces the properties from the previous call. - Call
onEventfor each event, before you add thegetSessionReplayProperties()values to the event. This order lets Session Replay tag the event that matches a condition.
import com.amplitude.core.events.BaseEvent
// Right after you create the instance, and whenever the user's properties change
sessionReplay.setUserProperties(mapOf("plan" to "Pro"))
// For each event, before you add the Session Replay properties
val event = BaseEvent().apply {
eventType = "Purchase Completed"
eventProperties = mutableMapOf("price" to 19.99)
}
sessionReplay.onEvent(event)
val properties = event.eventProperties.orEmpty() + sessionReplay.getSessionReplayProperties()
ThirdPartyAnalytics.track(event.eventType, properties)
Event, event property, and user property conditions apply to Android; Page URL conditions don't.
Disable replay collection
After Session Replay starts, it runs in your app until one of these conditions occurs:
- The user leaves your app.
- You call
sessionReplay.stop(). - You call
sessionReplay.shutdown()to tear down the instance.
Before a user enters a restricted area of your app, call sessionReplay.stop() to pause replay collection. Call sessionReplay.start() to resume when the user returns. Both methods act on the same instance.
To tear down Session Replay completely, call sessionReplay.shutdown(), then create a new instance to start again.
To capture only specific screens, initialize Session Replay with autoStart = false to prevent capture on launch. Call start() and stop() as the user enters and leaves those screens:
val sessionReplay = SessionReplay(
apiKey = "AMPLITUDE_API_KEY",
context = applicationContext,
deviceId = "device-id",
sessionId = System.currentTimeMillis(),
configuration = SessionReplay.Configuration {
autoStart = false
},
)
// Start capture when the user enters a screen you want to record
sessionReplay.start()
// Stop capture when the user leaves that screen
sessionReplay.stop()
You can also use a feature flag product like Amplitude Experiment to control replay collection by criteria such as location. Evaluate the flag before initializing Session Replay, or use its value to call start() and stop() on an existing instance.
WebView and MapView support (Beta)
By default, Session Replay blocks web views and map views in a capture. To enable capture of these components, use the settings described in Mask on-screen data.
Web view session replay injects JavaScript into the rendered page. To enable this, the SDK sets javaScriptEnabled to true on the unmasked web view.
Starting in version 0.32.0, Session Replay applies the browser privacy policy to web content inside captured WebViews. Session Replay masks or blocks WebView elements according to the browser privacy rules. Sensitive fields such as password inputs remain masked even when you unmask the WebView for capture.
Log Recording
Availability
Log recording is available in Session Replay Android 0.22.0 and later.
Session Replay supports recording logs in Android applications. To enable log recording, send log messages through the recordLog(level, message, timestamp) API and configure the limits through recordLogOptions parameter while initializing Session Replay.
import com.amplitude.android.plugins.SessionReplayPlugin
import com.amplitude.android.sessionreplay.config.RecordLogLevel
import com.amplitude.android.sessionreplay.config.RecordLogOptions
val sessionReplayPlugin = SessionReplayPlugin(
recordLogOptions = RecordLogOptions(
logCountThreshold = 2000,
maxMessageLength = 4000
)
)
amplitude.add(sessionReplayPlugin)
sessionReplayPlugin.recordLog(RecordLogLevel.Error, "This is an error log")
// You can also create custom log levels
sessionReplayPlugin.recordLog(RecordLogLevel("debug"), "This is a debug log")
Session Replay supports predefined log levels (Error, Warn, Log) and custom log levels. Create custom log levels by passing any string value to RecordLogLevel(...).
If you have implemented a log system, you can make single-point modifications to integrate log recording functionality. See the following examples for more information.
Timber
If you use Timber, you can integrate it with a custom tree.
import com.amplitude.android.plugins.SessionReplayPlugin
import com.amplitude.android.sessionreplay.config.RecordLogLevel
import timber.log.Timber
class AmplitudeLogRecordTree(private val plugin: SessionReplayPlugin) : Timber.Tree() {
override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
val recordLevel = when (priority) {
android.util.Log.ERROR -> RecordLogLevel.Error
android.util.Log.WARN -> RecordLogLevel.Warn
android.util.Log.INFO -> RecordLogLevel.Log
android.util.Log.DEBUG -> RecordLogLevel("debug")
android.util.Log.VERBOSE -> RecordLogLevel("verbose")
else -> return
}
plugin.recordLog(recordLevel, message)
}
}
val sessionReplayPlugin = SessionReplayPlugin()
amplitude.add(sessionReplayPlugin)
Timber.plant(AmplitudeLogRecordTree(sessionReplayPlugin))
Data retention, deletion, and privacy
Review consent guidance when you implement capture.
Retention period
For native and Flutter SDK retention guidance and the effective date of changes, go to the Session Replay data lifecycle reference.
DSAR API
For replay metadata returned by the DSAR API, go to Session Replay DSAR metadata.
Data deletion
For user and project deletion behavior, go to Session Replay data deletion.
Bot filter
For bot filtering and property-filter restrictions, go to Session Replay bot filtering.
Session Replay storage
If a user opts out of tracking in your app, use the optOut configuration option to disable replay collection for that user.
The SDK stores replay data locally. It retries transient upload failures, subject to retry and storage limits.
Jetpack Compose support
Session Replay Android 1.0 captures Compose UI through build-time instrumentation. Install and apply the com.amplitude.session-replay Gradle plugin in the Android app module, then rebuild your app. Compose capture doesn't work without the Gradle plugin, even if the runtime SDK is installed and initialized.
Follow the Gradle setup for your integration: Analytics plugin, standalone SDK, or middleware. Declaring the plugin with apply false in the root project alone doesn't apply it to the app module.
The Gradle plugin checks Compose compatibility during the build and reports supported-version details in its errors. After changing your Compose version or BOM, rebuild and verify a replay, including a release build if you use R8.
Use the privacy modifiers in Jetpack Compose to control what Session Replay captures. Automatic text masking relies on Compose semantics. Use ampBlock() for sensitive custom drawing or components without corresponding semantics.
Known limitations
Keep the following limitations in mind as you implement Session Replay:
Session Replay doesn't stitch together replays from a single user across multiple projects. For example:
- You instrument multiple apps as separate Amplitude projects with Session Replay enabled in each.
- A known user begins on one app, and then switch to another.
- Amplitude captures both sessions.
- The replay for each session is available for view in the corresponding host project.
The User Sessions chart doesn't show session replays if your organization uses a custom session definition.
Session Replay Android 1.1.0 and later depends on
com.amplitude:evaluation-core. If your app also uses the Experiment Android SDK, use Experiment1.16.0or later. Experiment1.15.0and earlier bundle the same classes, so the build fails with duplicate classes.Session Replay can't capture the following Android views:
- Canvas Views
Troubleshooting
For more information about individual statuses and errors, see the Session Replay Ingestion Monitor. |
Replay length and session length don't match
In some scenarios, the length of a replay may exceed the time between the [Amplitude] Start Session and [Amplitude] End Session events. This happens when a user closes the [Amplitude] End Session occurs, but before the Android SDK and Session Replay plugin can process it. When the user uses the app again, the SDK and plugin process the event and send it to Amplitude, along with the replay. You can verify this scenario occurs if you see a discrepancy between the End Session Client Event Time and the Client Upload Time.
Session replays don't appear in Amplitude
Session replays may not appear in Amplitude due to:
- Lack of connectivity
- The app process ends or you shut down the SDK before pending replay data uploads.
- Sampling
Lack of connectivity
Ensure your app has access to the internet then try again.
Sampling
As mentioned above, the default sampleRate for Session Replay is 0. Update the rate to a higher number. For more information see, Sampling rate.
Session Replay processing errors
In general, replays should be available within minutes of ingestion. Delays or errors may be the result of one or more of the following:
- Mismatching API keys or Device IDs. This can happen if Session Replay and standard event instrumentation use different API keys or Device IDs.
- Session Replay references the wrong project.
- Short sessions. If a users bounces within a few seconds of initialization, the SDK may not have time to upload replay data.
- Page instrumentation. If Session Replay isn't implemented on all pages a user visits, their session may not capture properly.
- Replays older than the set retention period (defaults to 90 days).
Report an Issue
If you encounter any issues with Session Replay that aren't covered in the troubleshooting guide above, please report them on our GitHub repository.
When creating an issue, please include:
- A clear description of the problem
- Steps to reproduce the issue
- Expected vs actual behavior
- SDK version you're using
- Any relevant error messages or logs
Was this helpful?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.