Skip to content

docs: add sampleRate config for Android and iOS session replay #15365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marandaneto wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −0
Open

docs: add sampleRate config for Android and iOS session replay #15365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions contents/docs/session-replay/_snippets/android-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ val config = PostHogAndroidConfig(apiKey = "<ph_project_token>").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
}
```

Expand Down
6 changes: 6 additions & 0 deletions contents/docs/session-replay/_snippets/ios-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down