From 7e11415d5c5634f734412f9d35f15fa0ea3537c0 Mon Sep 17 00:00:00 2001 From: Billy Vong Date: Wed, 8 Oct 2025 15:19:30 -0400 Subject: [PATCH] feat(replay): Add note about min replay duration Adds note about min replay duration for replay vs error sampling. --- .../javascript/common/session-replay/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/javascript/common/session-replay/configuration.mdx b/docs/platforms/javascript/common/session-replay/configuration.mdx index 89dff0cd78cae..384a432cadb4c 100644 --- a/docs/platforms/javascript/common/session-replay/configuration.mdx +++ b/docs/platforms/javascript/common/session-replay/configuration.mdx @@ -39,7 +39,7 @@ The following can be configured as integration options in `replayIntegration({}) | 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. | | mutationLimit | `number ` | 10000 | The upper bound of mutations to process before Session Replay stops recording due to performance impacts. See [Mutation Limits](#mutation-limits) | | 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) | -| minReplayDuration | `number` | 5000 | The length of the replay, **in milliseconds**, before the SDK should start sending to Sentry. Max value is 15000. | +| 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. | | maxReplayDuration | `number` | 3600000 | The maximum length of the replay, **in milliseconds**, that the SDK should send to Sentry. Max value is 3600000 (1 hour). | | 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. | | networkDetailAllowUrls | (string\|RegExp)[] | `[]` | Capture request and response details for XHR and fetch requests that match the given URLs. |