You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/product_analytics/session_replay/browser/_index.md
+11-52Lines changed: 11 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Session Replay expands your user experience monitoring by allowing you to captur
26
26
27
27
The RUM Browser SDK is [open source][1] and leverages the open source [rrweb][2] project.
28
28
29
-
## Session Replay recorder
29
+
## How the Session Replay recorder works
30
30
31
31
The Session Replay recorder is part of the RUM Browser SDK. The recorder takes a snapshot of the browser's DOM and CSS by tailing and recording events happening on a web page (such as DOM modification, mouse move, clicks, and input events) along with these events' timestamps.
32
32
@@ -38,58 +38,19 @@ To reduce Session Replay's network impact and ensure the Session Replay recorder
38
38
39
39
## Setup
40
40
41
-
Session Replay is available in the RUM Browser SDK. To start collecting data for Session Replay, set up [Datadog RUM Browser Monitoring][4] by creating a RUM application, generating a client token generation, and initializing the RUM Browser SDK. For setup in mobile environments, see [Mobile Session Replay][5].
41
+
Learn how to [set up and configure Browser Session Replay][4].
42
42
43
-
<divclass="alert alert-info">Session Replay is supported by SDK version 3.6.0 or later.</div>
43
+
## Privacy options
44
44
45
-
## Usage
45
+
See [Privacy Options][5].
46
46
47
-
Starting with v5.0.0 of the RUM Browser SDK, the Session Replay starts recording automatically when calling `init()`. To conditionally start the recording, use the `startSessionReplayRecordingManually` init parameter and call `startSessionReplayRecording()`.
47
+
## Troubleshooting
48
48
49
-
For example, to only record authenticated user sessions:
50
-
51
-
```javascript
52
-
window.DD_RUM.init({
53
-
applicationId:'<DATADOG_APPLICATION_ID>',
54
-
clientToken:'<DATADOG_CLIENT_TOKEN>',
55
-
site:'<DATADOG_SITE>',
56
-
// service: 'my-web-application',
57
-
// env: 'production',
58
-
// version: '1.0.0',
59
-
sessionSampleRate:100,
60
-
sessionReplaySampleRate:100,
61
-
startSessionReplayRecordingManually:true,
62
-
...
63
-
});
64
-
65
-
if (user.isAuthenticated) {
66
-
window.DD_RUM.startSessionReplayRecording();
67
-
}
68
-
```
69
-
70
-
To stop the Session Replay recording, call `stopSessionReplayRecording()`.
71
-
72
-
<divclass="alert alert-warning">When using a version of the RUM Browser SDK older than v5.0.0, Session Replay recording does not begin automatically. Call <code>startSessionReplayRecording()</code> to begin recording.</div>
73
-
74
-
## Disable Session Replay
75
-
76
-
To stop session recordings, set `sessionReplaySampleRate` to `0`. This stops collecting data for the [Browser RUM & Session Replay plan][6].
77
-
78
-
<divclass="alert alert-warning">If you're using a version of the RUM Browser SDK previous to v5.0.0, set <code>replaySampleRate</code> to <code>0</code>.</div>
79
-
80
-
## Playback history
81
-
82
-
You can see who has watched a given session replay by clicking the **watched** count displayed on the player page. This feature allows you to check whether someone you'd like to share the recording with has already watched it.
83
-
84
-
{{< img src="real_user_monitoring/session_replay/session-replay-playback-history.png" alt="Check who has watched a session's recording" style="width:100%;" >}}
85
-
86
-
The history includes only playbacks that occurred in the player page or in an embedded player, like in a [Notebook][8] or side panel. Included playbacks also generate an [Audit Trail][7] event. Thumbnail previews are not included in history.
87
-
88
-
To view your own playback history, check out the [My Watch History][9] playlist.
49
+
Learn how to [troubleshoot Browser Session Replay][7].
89
50
90
51
## Mobile Session Replay
91
52
92
-
Learn more about the [Session Replay for Mobile][5].
53
+
Learn more about the [Session Replay for Mobile][8].
93
54
94
55
## Further Reading
95
56
@@ -98,9 +59,7 @@ Learn more about the [Session Replay for Mobile][5].
@@ -40,84 +39,19 @@ To reduce Session Replay's network impact and ensure the Session Replay recorder
40
39
41
40
## Setup
42
41
43
-
Session Replay is available in the RUM Browser SDK. To start collecting data for Session Replay, set up [Datadog RUM Browser Monitoring][4] by creating a RUM application, generating a client token generation, and initializing the RUM Browser SDK. For setup in mobile environments, see [Mobile Session Replay][5].
42
+
Learn how to [set up and configure Browser Session Replay][4].
44
43
45
-
<divclass="alert alert-info">Session Replay is supported by SDK version 3.6.0 or later.</div>
44
+
## Privacy options
46
45
47
-
## Usage
46
+
See [Privacy Options][5].
48
47
49
-
Starting with v5.0.0 of the RUM Browser SDK, the Session Replay starts recording automatically when calling `init()`. To conditionally start the recording, use the `startSessionReplayRecordingManually` init parameter and call `startSessionReplayRecording()`.
48
+
## Troubleshooting
50
49
51
-
For example, to only record authenticated user sessions:
52
-
53
-
```javascript
54
-
window.DD_RUM.init({
55
-
applicationId:'<DATADOG_APPLICATION_ID>',
56
-
clientToken:'<DATADOG_CLIENT_TOKEN>',
57
-
site:'<DATADOG_SITE>',
58
-
// service: 'my-web-application',
59
-
// env: 'production',
60
-
// version: '1.0.0',
61
-
sessionSampleRate:100,
62
-
sessionReplaySampleRate:100,
63
-
startSessionReplayRecordingManually:true,
64
-
...
65
-
});
66
-
67
-
if (user.isAuthenticated) {
68
-
window.DD_RUM.startSessionReplayRecording();
69
-
}
70
-
```
71
-
72
-
To stop the Session Replay recording, call `stopSessionReplayRecording()`.
73
-
74
-
<divclass="alert alert-warning">When using a version of the RUM Browser SDK older than v5.0.0, Session Replay recording does not begin automatically. Call <code>startSessionReplayRecording()</code> to begin recording.</div>
75
-
76
-
## Force Session Replay
77
-
78
-
In some scenarios, you may want to begin recording a session after it has already started, even if it was initially sampled out of replay. For instance, you might want to force Session Replay on a newly deployed page for closer monitoring, or start recording after detecting an error to ensure complete replay data.
79
-
80
-
To force Session Replay recording for the rest of the current session, call `startSessionReplayRecording({ force: true })`
81
-
82
-
When using the force option, the session is upgraded to a replayed session for the remainder of its duration, regardless of its initial sampling decision.
83
-
84
-
<divclass="alert alert-warning">The force option only upgrades an existing session to a replayed one if it is already being sampled. In other words, if sampling hasn't started yet, using the force option does not initiate one, and no replay is recorded.</div>
85
-
86
-
## Disable Session Replay
87
-
88
-
To stop session recordings, set `sessionReplaySampleRate` to `0`. This stops collecting data for the [Browser RUM & Session Replay plan][6].
89
-
90
-
<divclass="alert alert-warning">If you're using a version of the RUM Browser SDK previous to v5.0.0, set <code>replaySampleRate</code> to <code>0</code>.</div>
91
-
92
-
## Retention
93
-
94
-
By default, Session Replay data is retained for 30 days.
95
-
96
-
To extend retention to 15 months, you can enable _Extended Retention_ on individual session replays. These sessions must be non-active (the user has completed their experience).
97
-
98
-
Extended Retention only applies to Session Replay and does not include associated events. The 15 months start when Extended Retention is enabled, not when the session is collected.
99
-
100
-
You can disable Extended Retention at any time. If the session replay is still within its default 30 days of retention, the replay expires at the end of the initial 30 day window. If you disable Extended Retention on a session replay that is older than 30 days, the replay immediately expires.
Refer to the below diagram to understand what data is retained with extended retention.
105
-
106
-
{{< img src="real_user_monitoring/session_replay/replay-extended-retention.png" alt="Diagram of what data is retained with extended retention" style="width:100%;" >}}
107
-
108
-
## Playback history
109
-
110
-
You can see who has watched a given session replay by clicking the **watched** count displayed on the player page. This feature allows you to check whether someone you'd like to share the recording with has already watched it.
111
-
112
-
{{< img src="real_user_monitoring/session_replay/session-replay-playback-history.png" alt="Check who has watched a session's recording" style="width:100%;" >}}
113
-
114
-
The history includes only playbacks that occurred in the player page or in an embedded player, like in a [Notebook][8] or side panel. Included playbacks also generate an [Audit Trail][7] event. Thumbnail previews are not included in history.
115
-
116
-
To view your own playback history, check out the [My Watch History][9] playlist.
50
+
Learn how to [troubleshoot Browser Session Replay][7].
117
51
118
52
## Mobile Session Replay
119
53
120
-
Learn more about the [Session Replay for Mobile][5].
54
+
Learn more about the [Session Replay for Mobile][8].
121
55
122
56
## Further Reading
123
57
@@ -126,9 +60,7 @@ Learn more about the [Session Replay for Mobile][5].
0 commit comments