Session Replay for Browser RUM

Session Replay enables you to track the user activity on web applications by recording interactions such as clicks, scrolls, and navigation. You can watch the session replay to:

  • Optimise the user experience.
  • Debug the errors for application crashes.
  • Diagnose the reasons for application slowness.
Attention: This documentation mentions a product that is currently only available as an early preview ("Beta"). Splunk AppDynamics reserves the right to change the Beta and its documentation including the content herein, at any time, for any reason, and without notice or compensation to you before making it generally available as well as never making it generally available. This documentation is not a guarantee of future product features and should not be relied upon in making any purchasing decisions. Actual product results may vary from forward-looking statements due to factors including but not limited to: changes in Splunk AppDynamics and third-party technologies, factors related to the economy and target markets, acquisitions of other companies, the hiring and termination of personnel, and other factors. Please refer to the full terms at https://www.splunk.com/en_us/legal/appdynamics-limited-license-agreement.html for details.

Prerequisites

Ensure that the following conditions are met to use Session Replay:

  • Controller >= 25.3
  • JavaScript Agent = 25.5

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"] = {}));
OptionTypeDefaultDescription
enabledboolean

sessionReplayUrlHttpsstring(Required) Endpoint where you want to send the captured session data (EUM cloud URL).
packAssetsbooleantrue

Packs the website assets like images, CSS, and fonts in the recorded. If this option is disabled, the recording only keeps the asset URLs which will fetch the assets at the time of replay.

iframesbooleantrueRecords the same-origin iframes.
imageB itmapbooleanfalseEnable this option to capture the canvas and video content for richer session replay.
maskAllInputsbooleantrueMasks all <input> fields to protect user-entered sensitive data.
maskAllTextbooleanfalseMasks all textual content across the page.
sensitivityRulesArray[]

Fine-tunes element-level privacy masking. Follow the syntax to include sensitivityRules:

sensitvityRules:
[
    {rule: <Type>, selector: <Css Elements>}
]

There are three rule types that applies to the information within specified CSS object in the recording:

  • exclude: Skips the information.
  • mask: Masks the information.
  • unmask: Unmasks the information.

There are three rule types that applies 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" }
]
sessionReplayScriptUrlstring(auto-derived)

Overrides the default replay script location.

Generally: adrumExtUrlHttps + "adrum/session-replay/" + agentVersion

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