diff --git a/pages/docs/tracking-methods/sdks/android/android-replay.mdx b/pages/docs/tracking-methods/sdks/android/android-replay.mdx index e3b7dcac1e..f06e80da54 100644 --- a/pages/docs/tracking-methods/sdks/android/android-replay.mdx +++ b/pages/docs/tracking-methods/sdks/android/android-replay.mdx @@ -148,6 +148,7 @@ The current configuration options are: | `recordingSessionsPercent` | This is a value between `0.0` and `100.0` that controls the sampling rate for recording session replays.
At `0.0` no sessions will be recorded. At `100.0` all sessions will be recorded. | `100.0` | | `flushInterval` | Specifies the flush interval (in seconds) at which session replay events are sent to the Mixpanel server. | `10` | | `enableLogging` | This is a boolean value that determines whether or not debugging logs are printed to the console. | `false` | +| `remoteSettingsMode` | Setting for handling remote configuration during SDK initialization. Can be `disabled`, `fallback`, `strict`. | `disabled` | **autoMaskedViews Example Usage** @@ -195,6 +196,23 @@ You can flush any currently queued session replay events at any time by calling MPSessionReplay.getInstance()?.flush() ``` +## Remote Configuration + +By setting `remoteSettingsMode` you can quickly set SDK options for your project in mixpanel under `Settings > Project > Session Replay`. + +Three modes are available: + +- `disabled`: Do not use remote configuration and proceed to use the hardcoded initial options provided in `MPSessionReplay.initialize` +- `fallback`: Attempt to retrieve remote configuration and proceed with those settings. If there is failure or timeout (500 ms), will use initial provided options. +- `strict`: Will prevent session replay from auto-starting unless a remote configuration was successfully retrieved. + +Can use this setting to quickly update and adjust configurations to your liking. + +List of currently supported remote settings: +- `recordingSessionsPercent` + +Settings that are not yet supported, will not appear in the remote configuration. These non-included options will use the value that was initially set by the user for all `remoteSettingsMode` options. + ## Replay ID When a replay capture begins, a Replay ID is generated by the SDK and is attached as an event property (`$mp_replay_id`) to events tracked by the SDK during the capture session. Events containing the same `$mp_replay_id` will appear in the same Replay. diff --git a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx index 055ebd3228..1897d5ac4b 100644 --- a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx +++ b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx @@ -178,9 +178,6 @@ Can use this setting to quickly update and adjust configurations to your liking. List of currently supported remote settings: - `record_sessions_percent` -- `record_max_ms` -- `record_min_ms` -- `record_idle_timeout_ms` Settings that are not yet supported, will not appear in the remote configuration. These non-included options will use the value that was initially set by the user for all `remote_settings_mode` options. diff --git a/pages/docs/tracking-methods/sdks/swift/swift-replay.mdx b/pages/docs/tracking-methods/sdks/swift/swift-replay.mdx index 6153608621..c55378ef09 100644 --- a/pages/docs/tracking-methods/sdks/swift/swift-replay.mdx +++ b/pages/docs/tracking-methods/sdks/swift/swift-replay.mdx @@ -194,6 +194,7 @@ Currently, there are seven config options: | `recordingSessionsPercent` | This is a value between `0.0` and `100.0` (default) that controls the sampling rate for automatically triggered session replays.
At `0.0` no sessions will be recorded. At `100.0` all sessions will be recorded. | `100.0` | | `flushInterval` | Specifies the flush interval (in seconds) at which session replay events are sent to the Mixpanel server. | `10` | | `enableLogging` | This is a boolean value that determines whether or not debugging logs are printed to the console. | `false` | +| `remoteSettingsMode` | Setting for handling remote configuration during SDK initialization. Can be `disabled`, `fallback`, `strict`. | `disabled` | | `enableSessionReplayOniOS26AndLater` | Forces Session Replay to be enabled on iOS 26+, bypassing compatibility checks. Session Replay is disabled by default for apps built with Xcode 26+ running on iOS 26+ due to SwiftUI automasking issues. See the warning callout above for details. | `false` | **autoMaskedViews Example Usage** @@ -267,6 +268,23 @@ You can flush any currently queued session replay events at any time by calling MPSessionReplay.getInstance()?.flush() ``` +## Remote Configuration + +By setting `remoteSettingsMode` you can quickly set SDK options for your project in mixpanel under `Settings > Project > Session Replay`. + +Three modes are available: + +- `disabled`: Do not use remote configuration and proceed to use the hardcoded initial options provided in `MPSessionReplay.initialize` +- `fallback`: Attempt to retrieve remote configuration and proceed with those settings. If there is failure or timeout (500 ms), will use initial provided options. +- `strict`: Will prevent session replay from auto-starting unless a remote configuration was successfully retrieved. + +Can use this setting to quickly update and adjust configurations to your liking. + +List of currently supported remote settings: +- `recordingSessionsPercent` + +Settings that are not yet supported, will not appear in the remote configuration. These non-included options will use the value that was initially set by the user for all `remoteSettingsMode` options. + ## Replay ID When a replay capture begins, a Replay ID is generated by the SDK and is attached as an event property (`$mp_replay_id`) to events tracked by the Mixpanel SDK during the capture session. Events containing the same `$mp_replay_id` will appear in the same Replay.