Skip to content

Commit 6af20c1

Browse files
authored
docs(replay): Clarify beforeErrorSampling (#12819)
1 parent 6ece63f commit 6af20c1

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-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
@@ -46,7 +46,7 @@ The following can be configured as integration options in `replayIntegration({})
4646
| networkRequestHeaders | `string[]` | `[]` | Additional request headers to capture for URLs defined in `networkDetailAllowUrls`. See [Network Details](#network-details) to learn more. |
4747
| networkResponseHeaders | `string[]` | `[]` | Additional response headers to capture for URLs defined in `networkDetailAllowUrls`. See [Network Details](#network-details) to learn more. |
4848
| beforeAddRecordingEvent | <code>(event) => event\|null</code> | `i => i` | Filter additional recording events that include console logs and network requests/responses. |
49-
| beforeErrorSampling | `(event) => boolean` | `i => true` | Filter error events which should be skipped for error sampling. Return `false` if error sampling should be skipped for this error event, or `true` to sample for this error. |
49+
| beforeErrorSampling | `(event) => boolean` | `i => true` | Filter error events which should be skipped for error sampling. Return `false` if error sampling should be skipped for this error event, or `true` to sample for this error. Will only be called in `buffer` mode. |
5050
| slowClickIgnoreSelectors | `string[]` | `[]` | Ignore slow/rage click detection on elements matching the given CSS selector(s). |
5151

5252
## Privacy Configuration

docs/platforms/javascript/common/session-replay/understanding-sessions.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ replayIntegration({
199199
200200
If you return `false` from this method for a given error, we will not check the error sample rate for this error.
201201
If you return `true`, we will continue to check the error sample rate as normal.
202+
Note that this hook only runs in `buffer` mode, as `session` mode records continuously regardless of errors.
202203
203204
### Connect Replays with Support Software
204205

0 commit comments

Comments
 (0)