From 33c682d1aee75f01eb341132d97188628076ffe8 Mon Sep 17 00:00:00 2001 From: Jesse Wang <144086244+jxiwang@users.noreply.github.com> Date: Fri, 13 Oct 2023 10:07:13 -0700 Subject: [PATCH] Update README.md --- packages/session-replay-browser/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/session-replay-browser/README.md b/packages/session-replay-browser/README.md index aaa79dd4d..9eb73d187 100644 --- a/packages/session-replay-browser/README.md +++ b/packages/session-replay-browser/README.md @@ -75,7 +75,7 @@ sessionReplay.shutdown() |-|-|-|-|-| |`deviceId`|`string`|Yes|`undefined`|Sets an identifier for the device running your application.| |`sessionId`|`number`|Yes|`undefined`|Sets an identifier for the users current session. The value must be in milliseconds since epoch (Unix Timestamp).| -|`sampleRate`|`number`|No|`undefined`|Use this option to control how many sessions will be selected for replay collection. A selected session will be collected for replay, while sessions that are not selected will not.

The number should be a decimal between 0 and 1, ie `0.4`, representing the fraction of sessions you would like to have randomly selected for replay collection. Over a large number of sessions, `0.4` would select `40%` of those sessions.| +|`sampleRate`|`number`|No|`0`|Use this option to control how many sessions will be selected for replay collection. A selected session will be collected for replay, while sessions that are not selected will not.

The number should be a decimal between 0 and 1, ie `0.4`, representing the fraction of sessions you would like to have randomly selected for replay collection. Over a large number of sessions, `0.4` would select `40%` of those sessions.| |`optOut`|`boolean`|No|`false`|Sets permission to collect replays for sessions. Setting a value of true prevents Amplitude from collecting session replays.| |`flushMaxRetries`|`number`|No|`5`|Sets the maximum number of retries for failed upload attempts. This is only applicable to retryable errors.| |`logLevel`|`number`|No|`LogLevel.Warn`|`LogLevel.None` or `LogLevel.Error` or `LogLevel.Warn` or `LogLevel.Verbose` or `LogLevel.Debug`. Sets the log level.|