Skip to content

fix: flutter replay variable names #11777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 11, 2024
Merged

fix: flutter replay variable names #11777

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51c4c82
fix: flutter replay variable names
vaind Nov 9, 2024
5d1cc8f
Merge branch 'master' into fix/flutter-replay
vaind Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions docs/platforms/flutter/session-replay/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,22 +44,19 @@ await SentryFlutter.init(

## Verify

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.
While you're testing, we recommend that you set `sessionSampleRate` to `1.0`. This ensures that every user session will be sent to Sentry.

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`.
Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping `onErrorSampleRate` set to `1.0`.

## Sampling

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:

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

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.
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.

## Privacy

Expand Down
Loading