docs: add sampleRate config for Android and iOS session replay#15365
docs: add sampleRate config for Android and iOS session replay#15365marandaneto wants to merge 1 commit intomasterfrom
Conversation
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)
Deploy preview
|
|
Vale prose linter → found 0 errors, 9 warnings, 0 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 11:3 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 55:24 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 66:3 | warning | 'Jetpack' is a possible misspelling. | PostHogBase.Spelling |
| 74:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 76:7 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
contents/docs/session-replay/_snippets/ios-installation.mdx — 0 errors, 4 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 11:5 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 77:56 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 100:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 102:7 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
|
Would be good to also add docs here as well https://posthog.com/docs/session-replay/how-to-control-which-sessions-you-record#sampling with tabs, similar to how we did for https://posthog.com/docs/session-replay/how-to-control-which-sessions-you-record#programmatically-start-and-stop-recordings? |
yep, although there's no code snippets at all so it feels either all or nothing is supported |
2 participants
Changes
Add documentation for the
sampleRatesession replay configuration option for mobile SDKs.sessionReplayConfig.sampleRate— requires SDK v3.34.0+, defaultnullconfig.sessionReplayConfig.sampleRate— requires SDK v3.42.0+, defaultnilThe value is a
Doublebetween 0.0 and 1.0 that determines the percentage of sessions to record (e.g., 0.5 = 50%). When not set, no client-side sampling is applied and server-side settings apply.Related PRs