Skip to content

Commit 694d1eb

Browse files
authored
fix: flutter replay variable names (#11777)
1 parent a3a017d commit 694d1eb

File tree

1 file changed

+6
-9
lines changed
  • docs/platforms/flutter/session-replay

1 file changed

+6
-9
lines changed

docs/platforms/flutter/session-replay/index.mdx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,19 @@ await SentryFlutter.init(
4444

4545
## Verify
4646

47-
While you're testing, we recommend that you set <PlatformIdentifier name="replays-session-sample-rate" /> to `1.0`. This ensures that every user session will be sent to Sentry.
47+
While you're testing, we recommend that you set `sessionSampleRate` to `1.0`. This ensures that every user session will be sent to Sentry.
4848

49-
Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping <PlatformIdentifier name="replays-on-error-sample-rate" /> set to `1.0`.
49+
Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping `onErrorSampleRate` set to `1.0`.
5050

5151
## Sampling
5252

5353
Sampling allows you to control how much of your website's traffic will result in a Session Replay. There are two sample rates you can adjust to get the replays relevant to you:
5454

55-
1. <PlatformIdentifier name="replays-session-sample-rate" /> - The sample rate for
56-
replays that begin recording immediately and last the entirety of a user's session.
57-
2. <PlatformIdentifier name="replays-on-error-sample-rate" /> - The sample rate for
58-
replays that are recorded when an error happens. This type of replay will record
59-
up to a minute of events prior to the error and continue recording until the session
60-
ends.
55+
1. `sessionSampleRate` - The sample rate for replays that begin recording immediately and last the entirety of a user's session.
56+
2. `onErrorSampleRate` - The sample rate for replays that are recorded when an error happens. This type of replay will record
57+
up to a minute of events prior to the error and continue recording until the session ends.
6158

62-
Sampling starts as soon as a session begins. The <PlatformIdentifier name="replays-session-sample-rate" /> is then evaluated. If the session is sampled, replay recording will start immediately. If not, <PlatformIdentifier name="replays-on-error-sample-rate" /> will be evaluated. If the session is sampled at this point, the replay will be buffered and will only be uploaded to Sentry if an error occurs.
59+
Sampling starts as soon as a session begins. The `sessionSampleRate` is then evaluated. If the session is sampled, replay recording will start immediately. If not, `onErrorSampleRate` will be evaluated. If the session is sampled at this point, the replay will be buffered and will only be uploaded to Sentry if an error occurs.
6360

6461
## Privacy
6562

0 commit comments

Comments
 (0)