Skip to content

Commit

Permalink
docs(replay): Update docs on public replay api methods (#11020)
Browse files Browse the repository at this point in the history
  • Loading branch information
chargome authored Aug 8, 2024
1 parent 43aab30 commit 257988f
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ replay.start();
replay.startBuffering();
```

This can be used either if both `replaysSessionSampleRate` and `replaysOnErrorSampleRate` are `0` and thus no session has been started automatically, or if you previously stopped a session and want to start a new one (see below). `start()` and `startBuffering()` will throw an error if a session is currently running.
If both `replaysSessionSampleRate` and `replaysOnErrorSampleRate` are `0`, then you'll need to manually start a session replay, as shown above. This is also useful if you previously stopped a session and want to start a new one (see below). If a session is currently running, `start()` and `startBuffering()` are safe and have no effect. They will [log a debug message](/platforms/javascript/configuration/options/#debug) in this case.

## Manually Stopping Replay

Expand All @@ -107,7 +107,7 @@ await replay.flush();

In `session` mode, this will upload any pending recording data to Sentry. In `buffer` mode, this will upload any pending recording data to Sentry and then continue recording, the same as when an error is sampled with `replaysOnErrorSampleRate`.

Note that it's safe to call `flush()` at any time, even if Session Replay is stopped, in which case, it will do nothing.
Calling `flush()` while Session Replay is stopped will start a new session recording.

## Examples of Custom Sampling

Expand Down

0 comments on commit 257988f

Please sign in to comment.