Android SESSION REPLAY¶

Prerequisites¶

• Ensure you have set up and initialized the FTSdk RUM configuration and enabled View monitoring collection.
• Android Session Replay requires ft-sdk:1.7.0 or higher.
• ft-session-replay and ft-session-replay-material must use the same version number.
• Starting from ft-sdk version 1.7.2, there is no longer a strong dependency on ft-session-replay. ft-session-replay and related extension dependencies are only required when Session Replay needs to be enabled.

• It is recommended to prioritize using the stable officially released version displayed in the badges at the top of the document. Using pre-release versions like alpha or beta is no longer recommended.

• If you wish to access advanced capabilities early, follow the latest features, or track changes not yet officially released, you can visit GitHub to follow the Android SDK repository and related changelogs: GuanceCloud/datakit-android

Configuration¶

//Add SDK dependencies
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:[latest_version]'
//Required to enable session replay functionality
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay:[session_replay_version]'
//Required for session replay to support material components
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-material:[session_replay_version]'
//Required for session replay to support compose components
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-compose:[session_replay_version]'

Flutter RUM Context Compatibility¶

ft-session-replay version 0.1.5 and above is compatible with the RUM context fields used when uploading Flutter Session Replay data. When Flutter pages or Flutter SDK collection paths coexist in an Android native project, after upgrading to ft-session-replay:0.1.5 or higher, no additional configuration is needed to correctly map Flutter Replay data to the corresponding Replay Segment.

In hybrid scenarios, it is still recommended to complete RUM initialization first, then initialize Session Replay, to ensure contexts like app_id, session_id, view_id are established.

Code Sample¶

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSampleRate(1f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(new MaterialExtensionSupport()), context);

FTSdk.initSessionReplayConfig(FTSessionReplayConfig().setSampleRate(1f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(MaterialExtensionSupport()), context)

Privacy Override¶

Supported in ft-session-replay 0.1.1-alpha01 and above.

In addition to supporting global masking level configuration via FTSessionReplayConfig, the SDK also supports overriding these settings at the view level.

View-level privacy override:

• Supports overriding image masking level.
• Supports overriding text and input masking level and touch masking level.
• Supports setting specific views to be completely hidden.

Note:

• To ensure override settings are correctly identified, they should be applied as early as possible in the view lifecycle. This prevents cases where Session Replay processes the view before the applied override settings.
• Privacy overrides affect the view and its child views. This means that even if an override is applied to a view where it might not take effect immediately (e.g., applying an image override to a text input), the override will still apply to all child views.
• Privacy override priority: child view > parent view > global settings.

Image Override¶

Requires ft-sdk >= 1.7.0-alpha40, ft-session-replay >= 0.1.3-alpha14.

To override image privacy, use PrivacyOverrideExtensions.setSessionReplayImagePrivacy(View,ImagePrivacy) on the view instance, setting it to one of the values in the ImagePrivacy enum. To remove an existing override rule, simply set this property to null.

// Mark image privacy override for the specified view
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, ImagePrivacy.MASK_ALL);
// Remove image privacy override settings for the view
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, null);

// Mark image privacy override for the specified view
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, ImagePrivacy.MASK_ALL)
// Remove image privacy override settings for the view
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, null)

Text and Input Override¶

To override text and input privacy, use PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(View,TextAndInputPrivacy) on the view instance, setting it to one of the values in the TextAndInputPrivacy enum. To remove an existing override rule, simply set this property to null.

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, TextAndInputPrivacy.MASK_ALL);
// Remove hidden element override settings for the view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, null);

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, TextAndInputPrivacy.MASK_ALL)
// Remove hidden element override settings for the view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, null)

Touch Override¶

To override touch privacy, use PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(View,TouchPrivacy) on the view instance, setting it to one of the values in the TouchPrivacy enum. To remove an existing override rule, simply set this property to null.

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, TouchPrivacy.HIDE);
// Remove hidden element override settings for the view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, null);

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, TouchPrivacy.HIDE)
// Remove hidden element override settings for the view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, null)

Hidden Element Override¶

For sensitive elements that need to be completely hidden, use PrivacyOverrideExtensions.setSessionReplayHidden(View,Boolean).

When an element is set to hidden, it will be replaced by a placeholder marked as "Hidden" in the replay, and its child views will not be recorded.

Note: Marking a view as hidden does not prevent touch interactions from being recorded on that element. To hide touch interactions, in addition to marking the element as hidden, also use Touch Override.

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayHidden(view, true)
// Remove hidden element override settings for the view
PrivacyOverrideExtensions.setSessionReplayHidden(view, false)

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayHidden(view, true)
// Remove hidden element override settings for the view
PrivacyOverrideExtensions.setSessionReplayHidden(view, false)

Webview Session Replay¶

Supported in ft-session-replay 0.1.3-alpha11, ft-sdk 1.7.0-alpha36 and above.

For WebView Session Replay, the Web Monitoring SDK needs to be integrated into the WebView-accessed page, and Session Replay needs to be enabled in the Webview.

//In addition to webview RUM settings
window.DATAFLUX_RUM.startSessionReplayRecording();

Tencent Webivew X5 Support¶

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig()
    //...
    // Additionally set CustomExtensionSupport
    .addExtensionSupport(new CustomExtensionSupport()
            .addMapper(new MapperTypeWrapper<>(com.tencent.smtt.sdk.WebView.class,
                    new WebViewXWireframeMapper())))
)

FTSdk.initSessionReplayConfig(FTSessionReplayConfig()
    //...
    // Additionally set CustomExtensionSupport
    .addExtensionSupport(
        CustomExtensionSupport()
            .addMapper(
                MapperTypeWrapper(
                    com.tencent.smtt.sdk.WebView::class.java,
                    WebViewXWireframeMapper()
                )
            )
    )
)

Jetpack Compose Support¶

ft-session-replay-compose must use the same version number as ft-session-replay.

Android Session Replay now supports collection and replay of Jetpack Compose interfaces. When using Compose pages, you need to additionally introduce the Compose extension dependency and add ComposeExtensionSupport to FTSessionReplayConfig.

Add Dependency¶

implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-compose:[session_replay_version]'

Initialization Configuration¶

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSampleRate(1f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(new ComposeExtensionSupport())
                .addExtensionSupport(new MaterialExtensionSupport()), context);

FTSdk.initSessionReplayConfig(FTSessionReplayConfig().setSampleRate(1f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(ComposeExtensionSupport())
                .addExtensionSupport(MaterialExtensionSupport()), context)

Compose Privacy Override¶

Compose pages support overriding Session Replay privacy configurations via Modifier:

• sessionReplayHide(Boolean): Hides the specified Compose node.
• sessionReplayImagePrivacy(ImagePrivacy): Overrides the image privacy level.
• sessionReplayTextAndInputPrivacy(TextAndInputPrivacy): Overrides the text and input privacy level.
• sessionReplayTouchPrivacy(TouchPrivacy): Overrides the touch privacy level.

Current Limitations¶

• Compose replay relies on semantic nodes and component mapping, pixel-perfect restoration is not guaranteed.
• Currently supports replay of common components like text, input fields, images, buttons, switches, sliders, radio buttons, checkboxes, Tabs, and container components.
• Brush backgrounds are not yet supported. For example, linear gradients, radial gradients, etc., will not be restored with their original gradient effects. It is recommended to use solid color backgrounds for key demonstration areas.

Code and Configuration Reference¶

• Android Demo Gradle Configuration
• Android Demo Code Sample