From 793a3d6c52ef4253a9be9c9f1fe2d53370e9efef Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto Date: Fri, 27 Feb 2026 10:35:51 +0100 Subject: [PATCH] docs: add sampleRate config for Android and iOS session replay Add documentation for the sampleRate session replay configuration option: - Android: requires SDK v3.34.0+, default null - iOS: requires SDK v3.42.0+, default nil - Value range: 0.0 to 1.0 (percentage of sessions to record) --- .../docs/session-replay/_snippets/android-installation.mdx | 6 ++++++ contents/docs/session-replay/_snippets/ios-installation.mdx | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/contents/docs/session-replay/_snippets/android-installation.mdx b/contents/docs/session-replay/_snippets/android-installation.mdx index 030d8b213fd6..7b265d4864ad 100644 --- a/contents/docs/session-replay/_snippets/android-installation.mdx +++ b/contents/docs/session-replay/_snippets/android-installation.mdx @@ -51,6 +51,12 @@ val config = PostHogAndroidConfig(apiKey = "").apply { // Ps: it was 500ms (0.5s) by default until version 3.8.2 // Available from version 3.10.0 (Before it was called debouncerDelayMs) sessionReplayConfig.throttleDelayMs = 1000 + + // Sample rate for session replay. A value between 0.0 and 1.0 that determines the percentage + // of sessions to record. For example, 0.5 means 50% of sessions will be recorded. + // Default is null (no client-side sampling, server-side settings apply). + // Requires SDK version 3.34.0 or higher. + sessionReplayConfig.sampleRate = null } ``` diff --git a/contents/docs/session-replay/_snippets/ios-installation.mdx b/contents/docs/session-replay/_snippets/ios-installation.mdx index 522cd2cc2a38..cc40aca2bf42 100644 --- a/contents/docs/session-replay/_snippets/ios-installation.mdx +++ b/contents/docs/session-replay/_snippets/ios-installation.mdx @@ -78,6 +78,12 @@ config.sessionReplayConfig.screenshotMode = true // A higher value reduces performance impact but decreases replay smoothness. Default is 1.0s. // Note: Previously known as `debouncerDelay` before version 3.21.0 config.sessionReplayConfig.throttleDelay = 1.0 + +// Sample rate for session replay. A value between 0.0 and 1.0 that determines the percentage +// of sessions to record. For example, 0.5 means 50% of sessions will be recorded. +// Default is nil (no client-side sampling, server-side settings apply). +// Requires SDK version 3.42.0 or higher. +config.sessionReplayConfig.sampleRate = nil ``` ## Limitations