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).