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
Log in to the administration console and add the following property to use Session Replay:
  1. Go to Account Settings.

    1. Click Add Property and add browser.session.replay.enabled. Set the value of this property to true.

Configure the JavaScript Agent

To report session replay in the JavaScript applications, configure the JavaScript Agent as follows:
  1. Log in to the Controller UI.
  2. Open the browser application in which you are interested.
  3. On the left navigation menu, select Configuration.
  4. Select Configure JavaScript Agent.
  5. In Configure Session Replay, select Enable Session Replay.
    configure-session-replay-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

Default:
packAssets: true | {
   fonts?: false
   images?: false
   styles?: true
} 

This parameter packs the website assets like images, CSS, and fonts in the recorded.

This parameter only bundles the styles by default. This default setting ensures the optimized usage of your bandwidth. You can modify this setting to bundle fonts and images if required.
Note: As a best practice, avoid changing the default settings.
packAssets: boolean | {
   fonts?: boolean
   images?: boolean
   styles?: boolean
} 
Note: If you set this option to false, the recording only keeps the asset URLs which will fetch the assets during replay.

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:&lt;Type&gt;, selector:&lt;Css Elements&gt;}]

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.
Example:
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

An administrator can only enable Session Replay. To enable Session Replay for the selected browser application, perform the following options:
  1. Log in to the Controller UI.
  2. Open the browser application in which you are interested.
  3. On the left navigation menu, select Configuration.
  4. Click Instrumentation.
  5. Under the Session Replay tab, select Enable Session Replay.
    Enable Session Replay for BRUM.

View Session Replay

  1. Go to User Experience > Browser Apps.
  2. Select the application for which you have enabled the Session Replay.
  3. Select Sessions.
  4. A play icon is displayed in Session Replay if the recording is available.
  5. 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.

View Session Replay for Browser RUM.

You can adjust the playback speed.