From dbe69fe2904c137a95f62c46038f35e4ca6b5a35 Mon Sep 17 00:00:00 2001 From: John La Date: Mon, 2 Feb 2026 15:41:51 -0600 Subject: [PATCH 1/4] Basic remote settings documentation --- .../sdks/javascript/javascript-replay.mdx | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx index 7e2bb18b0c..bcffcdd8ac 100644 --- a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx +++ b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx @@ -59,6 +59,28 @@ This will have no effect if replay data collection is already in progress. mixpanel.start_session_recording(); ``` +#### Pause Capturing Replay Data +Call `pause_session_recording()` to pause any active replay data collection but do not clear the active recording. + +**Example Usage** + +```javascript Javascript +// manually pause a replay capture +mixpanel.pause_session_recording(); +``` + +#### Resume Capturing Replay Data +Call `resume_session_recording()` to resume replay data collection. + +This will have no effect if there is no non-active recording that was previously paused. + +**Example Usage** + +```javascript Javascript +// Resume the paused replay capture. +mixpanel.resume_session_recording(); +``` + #### Stop Capturing Replay Data Call `stop_session_recording()` to stop any active replay data collection. @@ -117,6 +139,7 @@ mixpanel.init( | `record_canvas` | When true, Mixpanel will record snapshots of `` elements on your site at up to 15 frames per second | `false` | | `record_heatmap_data` | When true, Mixpanel will capture click events during replays to populate Heatmaps. You can learn more [here](/docs/session-replay/heatmaps). | `false` | | `record_console` | When true, Mixpanel will record console logs, warnings, and errors as part of the replay. | `true` | +| `remote_settings_mode` | Setting for handling remote configuration during SDK initialization. Can be `disabled`, `fallback`, `strict`. | `disabled` | Note: Canvas recording (record_canvas) utilizes [rrweb's](https://github.com/rrweb-io/rrweb) UNSAFE_replayCanvas option, which is experimental and not fully supported. We recommend testing thoroughly before deploying to production. @@ -141,6 +164,17 @@ mixpanel.init('YOUR_PROJECT_TOKEN', { record_mask_input_selector: '.sensitive-input' }); ``` +## Remote Configuration + +By setting remote_settings_mode 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 `mixpanel.init` +- `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 the remote configuration was successfully retrieved. + +Can use this setting to quickly update and adjust configurations to your liking. ## Replay ID From d043ae2bd2b4f5032e9bd02af9924174ba3b1634 Mon Sep 17 00:00:00 2001 From: John La Date: Tue, 3 Feb 2026 09:25:59 -0600 Subject: [PATCH 2/4] Add list of supported remote settings --- .../tracking-methods/sdks/javascript/javascript-replay.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx index bcffcdd8ac..36b87721b1 100644 --- a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx +++ b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx @@ -176,6 +176,12 @@ Three modes are available: 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` + ## 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. From b6c3f7d7b3032192782ef33646b6be2b4e8c5299 Mon Sep 17 00:00:00 2001 From: John La Date: Thu, 5 Feb 2026 13:34:02 -0600 Subject: [PATCH 3/4] Specify non support options for remote configs --- .../tracking-methods/sdks/javascript/javascript-replay.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx index 36b87721b1..055ebd3228 100644 --- a/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx +++ b/pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx @@ -166,13 +166,13 @@ mixpanel.init('YOUR_PROJECT_TOKEN', { ``` ## Remote Configuration -By setting remote_settings_mode you can quickly set SDK options for your project in mixpanel under `Settings > Project > Session Replay`. +By setting `remote_settings_mode` 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 `mixpanel.init` - `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 the remote configuration was successfully retrieved. +- `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. @@ -182,6 +182,8 @@ List of currently supported remote settings: - `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. + ## 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. From 9dacfde40733dc123fe4a295370c73ffe7247cbe Mon Sep 17 00:00:00 2001 From: John La Date: Mon, 23 Feb 2026 14:36:08 -0600 Subject: [PATCH 4/4] Update documents for android and swift --- .../sdks/android/android-replay.mdx | 18 ++++++++++++++++++ .../sdks/javascript/javascript-replay.mdx | 3 --- .../sdks/swift/swift-replay.mdx | 18 ++++++++++++++++++ 3 files changed, 36 insertions(+), 3 deletions(-) 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.