Session Replay for Browser RUM
Session Replay allows you to monitor user activity within mobile applications by recording interactions such as clicks, scrolls, and navigation. It captures these interactions as dynamic, video-like journeys, along with detailed session metadata. This provides teams with clear insight into the user experience, especially when issues arise. You can watch the session replay to:
- Optimise the user experience.
- Debug the errors for application crashes.
- Diagnose the reasons for application slowness.
Session Replay Licenses
Session Replay is an add-on license available for the packages: RUM Peak, Browser RUM-Pro, Browser RUM-Peak, Mobile RUM-Pro, and Mobile RUM-Peak. For more information, see Session Replay.
Prerequisites
Ensure that the following conditions are met to use Session Replay:
- Controller >= 25.10
- JavaScript Agent >= 25.9
-
Go to Account Settings.
-
Click Add Property and add
browser.session.replay.enabled. Set the value of this property totrue.
-
Configure the JavaScript Agent
Configure Session Replay Using API Parameters
After this configuration, copy the instrumentation script and inject it in the JavaScript Agent.
(function(config){
// ... other JSAgent configs
config.sessionReplay = {
enabled: true,
sessionReplayUrlHttps: ""
// ... other optional configs
};
})(window["adrum-config"] || (window["adrum-config"] = {}));
enabled
Set this parameter to true to enable Session Replay.
sessionReplayUrlHttps
(Required)
Type: String
Enter the endpoint where you want to send the captured session data (EUM cloud URL).
packAssets
Type: boolean
packAssets: true | {
fonts?: false
images?: false
styles?: true
} This parameter packs the website assets like images, CSS, and fonts in the recorded.
fonts and images if required.packAssets: boolean | {
fonts?: boolean
images?: boolean
styles?: boolean
} iframes
Type: boolean
Default: true
Records the same-origin iFrames.
imageBitmap
Type: boolean
Default: false
Enable this option to capture the canvas and video content for richer session replay.
maskAllText
Type: boolean
Default: false
Masks all textual content across the page.
maskAllInputs
Type: boolean
Default: true
Masks all <input> fields to protect user-entered sensitive data.
persistence
Type: boolean
Default: false
During frequent site refreshes or navigation, Session Replay data may be lost. To prevent this, set it to true to enable local storage persistence for your Session Replay data.
sensitivityRules
Type: Array
Fine-tunes element-level privacy masking. Follow the syntax to include sensitivityRules:
sensitivityRules:[{rule:<Type>, selector:<Css Elements>}]There are three rule types that apply to the information within specified CSS object in the recording:
- exclude: Skips the information.
- mask: Masks the information.
- unmask: Unmasks the information.
sensitivityRules: [{ rule: "exclude", selector: "img" },{ rule: "mask", selector: ".sensitive-field" },{ rule: "unmask", selector: ".public-info" }]sessionReplayScriptUrl
Type: string
Overrides the default replay script location.
Generally: adrumExtUrlHttps + "adrum/session-replay/" + agentVersion
enableReplayFolderVersioning
Type: boolean
Uses agent version folders for compatibility. Set to false to serve from a flat structure (e.g., https://your-cdn.com/replay).
Enable Session Replay
View Session Replay
- Go to .
- Select the application for which you have enabled the Session Replay.
- Select Sessions.
- A play icon is displayed in Session Replay if the recording is available.
- Expand the Session Replay tab.
Session Replay highlights active segments of the sessions. A blank screen appears if there are no recordings or user activity.
You can adjust the playback speed.