From 51c4c82f66084912e04147420b0359a07e347509 Mon Sep 17 00:00:00 2001 From: Ivan Dlugos Date: Sat, 9 Nov 2024 13:29:11 +0100 Subject: [PATCH] fix: flutter replay variable names --- docs/platforms/flutter/session-replay/index.mdx | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/platforms/flutter/session-replay/index.mdx b/docs/platforms/flutter/session-replay/index.mdx index d350fd4a8f6094..2302aff61b230e 100644 --- a/docs/platforms/flutter/session-replay/index.mdx +++ b/docs/platforms/flutter/session-replay/index.mdx @@ -19,7 +19,7 @@ By default, our Session Replay SDK masks all text content, images, and user inpu ## Pre-requisites -Make sure your Sentry Flutter SDK version is at least 8.9.0, which is required for Session Replay. +Make sure your Sentry Flutter SDK version is at least 8.9.0, which is required for Session Replay. You can update your `pubspec.yaml` to the matching version: ```yaml @@ -44,22 +44,19 @@ await SentryFlutter.init( ## Verify -While you're testing, we recommend that you set 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 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. - The sample rate for - replays that begin recording immediately and last the entirety of a user's session. -2. - 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 is then evaluated. If the session is sampled, replay recording will start immediately. If not, 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