Skip to content

Commit

Permalink
[RUM-7047] Update the doc about the force session replay recording (#…
Browse files Browse the repository at this point in the history
…26745)

* update force session replay

* update force session replay

* title
  • Loading branch information
RomanGaignault authored Dec 14, 2024
1 parent 3eeafd0 commit bb72e3b
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ To stop the Session Replay recording, call `stopSessionReplayRecording()`.

<div class="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>

## Force Session Replay

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.

To force Session Replay recording for the rest of the current session, call `startSessionReplayRecording({ force: true })`

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.

## Disable Session Replay

To stop session recordings, set `sessionReplaySampleRate` to `0`. This stops collecting data for the [Browser RUM & Session Replay plan][6].
Expand Down

0 comments on commit bb72e3b

Please sign in to comment.