Docs: Add session replay sampling support for Android and iOS SDKs#15367
Closed
inkeep[bot] wants to merge 3 commits intomasterfrom
Closed
Docs: Add session replay sampling support for Android and iOS SDKs#15367inkeep[bot] wants to merge 3 commits intomasterfrom
inkeep[bot] wants to merge 3 commits intomasterfrom
Conversation
Adds the sampleRate configuration option to the Android session replay installation snippet, reflecting the new sampling support added in Android SDK v3.34.0 (PR PostHog/posthog#49047).
…cording sampling Reflects changes from PostHog/posthog#49047 which adds sampling support for iOS SDK v3.42.0+. The sampleRate option accepts a value between 0.0 and 1.0, with nil meaning all sessions are recorded.
Documents the new `sampleRate` config option for Android SDK (v3.34.0+) and iOS SDK (v3.42.0+) in the session recording controls page, matching PR #49047 in PostHog/posthog.
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 6 errors, 19 warnings, 1 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 |
| 60:15 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 69:3 | warning | 'Jetpack' is a possible misspelling. | PostHogBase.Spelling |
| 77:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 79: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 |
| 103:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 105:7 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
contents/docs/session-replay/how-to-control-which-sessions-you-record.mdx — 6 errors, 10 warnings, 1 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 17:88 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 26:142 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 26:246 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 26:308 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 57:4 | warning | 'With Event trigger conditions' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 59:7 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 71:13 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 92:74 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 94:23 | warning | 'navigations' is a possible misspelling. | PostHogBase.Spelling |
| 96:9 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 122:142 | error | Use straight quotes and apostrophes, not curly ones. | PostHogDocs.CurlyQuotes |
| 122:177 | error | Use straight quotes and apostrophes, not curly ones. | PostHogDocs.CurlyQuotes |
| 135:125 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 157:86 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 169:82 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 237:24 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 245:87 | warning | 'navigations' is a possible misspelling. | PostHogBase.Spelling |
Member
|
done by #15365 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new session recording sampling rate feature for Android and iOS mobile SDKs, added in PostHog/posthog#49047.
Changes
1.
contents/docs/session-replay/_snippets/android-installation.mdxsessionReplayConfig.sampleRateconfiguration option to the Android code examplenull(all sessions recorded)2.
contents/docs/session-replay/_snippets/ios-installation.mdxconfig.sessionReplayConfig.sampleRateconfiguration option to the iOS code examplenil(all sessions recorded)3.
contents/docs/session-replay/how-to-control-which-sessions-you-record.mdxRelated
This PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.