Skip to content

Commit 743010f

Browse files
authored
feat(replay): Add note about min replay duration (#15168)
Adds note about min replay duration for replay vs error sampling.
1 parent bc7c11e commit 743010f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/platforms/javascript/common/session-replay/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The following can be configured as integration options in `replayIntegration({})
3939
| stickySession | `boolean` | `true` | Keeps track of a user regardless of a page refresh. Note that closing a tab ends a session, so a single user using multiple tabs will be recorded as multiple sessions. |
4040
| mutationLimit | `number ` | 10000 | The upper bound of mutations to process before Session Replay stops recording due to performance impacts. See [Mutation Limits](#mutation-limits) |
4141
| mutationBreadcrumbLimit | `number ` | 750 | The upper bound of mutations to process before Session Replay sends a breadcrumb to warn of large mutations. See [Mutation Limits](#mutation-limits) |
42-
| minReplayDuration | `number` | 5000 | The length of the replay, **in milliseconds**, before the SDK should start sending to Sentry. Max value is 15000. |
42+
| minReplayDuration | `number` | 5000 | The length of the replay, **in milliseconds**, before the SDK should start sending to Sentry. Max value is 15000. **Note:** This only applies to session-based sampling (`replaysSessionSampleRate`). For error/buffer-based sampling (`replaysOnErrorSampleRate`), replays are captured immediately when an error is sampled. |
4343
| maxReplayDuration | `number` | 3600000 | The maximum length of the replay, **in milliseconds**, that the SDK should send to Sentry. Max value is 3600000 (1 hour). |
4444
| workerUrl | `string` | `undefined` | A URL for a self-hosted worker for compression Replay data. See [Using a Custom Compression Worker](#using-a-custom-compression-worker) to learn more. |
4545
| networkDetailAllowUrls | <code>(string\|RegExp)[]</code> | `[]` | Capture request and response details for XHR and fetch requests that match the given URLs. |

0 commit comments

Comments
 (0)