Skip to content

Commit c0bceab

Browse files
authored
chore(android): errorSampleRate changed to onErrorSampleRate (#11602)
1 parent 5d6caaf commit c0bceab

File tree

1 file changed

+5
-5
lines changed
  • docs/platforms/android/session-replay

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,34 +63,34 @@ SentryAndroid.init(context) { options ->
6363
options.isDebug = true
6464

6565
// Currently under experimental options:
66-
options.experimental.sessionReplay.errorSampleRate = 1.0
66+
options.experimental.sessionReplay.onErrorSampleRate = 1.0
6767
options.experimental.sessionReplay.sessionSampleRate = 1.0
6868
}
6969
```
7070

7171
```XML {filename:AndroidManifest.xml}
72-
<meta-data android:name="io.sentry.session-replay.error-sample-rate" android:value="1.0" />
72+
<meta-data android:name="io.sentry.session-replay.on-error-sample-rate" android:value="1.0" />
7373
<meta-data android:name="io.sentry.session-replay.session-sample-rate" android:value="1.0" />
7474
```
7575

7676
## Verify
7777

7878
While you're testing, we recommend that you set `sessionSampleRate` to `1.0`. This ensures that every user session will be sent to Sentry.
7979

80-
Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping `errorSampleRate` set to `1.0`.
80+
Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping `onErrorSampleRate` set to `1.0`.
8181

8282
## Sampling
8383

8484
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:
8585

8686
1. `sessionSampleRate` - The sample rate for
8787
replays that begin recording immediately and last the entirety of the user's session.
88-
2. `errorSampleRate` - The sample rate for
88+
2. `onErrorSampleRate` - The sample rate for
8989
replays that are recorded when an error happens. This type of replay will record
9090
up to a minute of events prior to the error and continue recording until the session
9191
ends.
9292

93-
Sampling begins as soon as a session starts. `sessionSampleRate` is evaluated first. If it's sampled, the replay recording will begin. Otherwise, `errorSampleRate` is evaluated and if it's sampled, the integration will begin buffering the replay and will only upload it to Sentry if an error occurs. The remainder of the replay will behave similarly to a whole-session replay.
93+
Sampling begins as soon as a session starts. `sessionSampleRate` is evaluated first. If it's sampled, the replay recording will begin. Otherwise, `onErrorSampleRate` is evaluated and if it's sampled, the integration will begin buffering the replay and will only upload it to Sentry if an error occurs. The remainder of the replay will behave similarly to a whole-session replay.
9494

9595
## Privacy
9696

0 commit comments

Comments
 (0)