Skip to content

docs(logs): add Android installation page#17037

Merged
turnipdabeets merged 3 commits into
masterfrom
docs/android-logs-installation
May 26, 2026
Merged

docs(logs): add Android installation page#17037
turnipdabeets merged 3 commits into
masterfrom
docs/android-logs-installation

Conversation

@turnipdabeets
Copy link
Copy Markdown
Contributor

Changes

Adds an Android installation walkthrough for the Logs feature shipping in posthog-android@3.46.0 (PostHog/posthog-android#525, merged).

Covers:

  • PostHogAndroidConfig.logs setup (snapshotted at PostHogAndroid.setup(...))
  • PostHog.logger.{trace,debug,info,warn,error,fatal} and PostHog.logger.log(message, severity) for runtime severities
  • All six severity levels and Kotlin/Java call sites
  • Auto-attached context (distinct id, session, screen, app state, feature flags)
  • Buffering / rate-cap / resource-attribute tuning with a full defaults table
  • addBeforeSend filter chain in both Kotlin and Java

Adds the page to the Logs > Install logging client sidebar between iOS and Datadog. Flips the Android library page frontmatter to logs: true and adds a cross-link section so the comparison table picks it up. Expands the start-here mobile-SDK callout to include iOS and Android alongside the JavaScript / React Native links it already had.

Mirror of #16797 (iOS) and #16679 (RN).

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json

Mirrors the iOS / React Native logs install pages for the Android SDK's
new logs API (posthog-android@3.46.0). Adds the page to the Logs install
sidebar, flips the Android library frontmatter to logs: true with a
cross-link section, and includes Android in the start-here mobile SDK
list alongside iOS and React Native.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview May 26, 2026 08:17PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

Vale prose linter → found 3 errors, 45 warnings, 8 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/libraries/android/index.mdx — 0 errors, 24 warnings, 8 suggestions
Line Severity Message Rule
6:18 warning Use 'GitHub' instead of 'github'. Vale.Terms
6:37 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
6:45 warning Use 'Android' instead of 'android'. Vale.Terms
7:15 warning Use 'Android' instead of 'android'. Vale.Terms
85:163 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
85:201 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
100:106 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
129:49 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
131:66 suggestion Address the reader directly. Use 'you' instead of 'the User'. PostHogDocs.DirectAddress
131:131 suggestion Address the reader directly. Use 'you' instead of 'the User'. PostHogDocs.DirectAddress
133:5 warning 'Removing stored Super Properties' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
145:69 warning Avoid trivializing words. 'simply' can sound dismissive to the reader. PostHogDocs.Trivializers
207:10 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
207:94 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
207:103 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
227:8 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
227:55 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
227:128 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
237:28 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
237:54 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
271:4 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
271:4 warning 'Error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
273:11 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
277:12 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
281:4 warning 'Session replay' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
281:4 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
283:12 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
283:74 warning Avoid trivializing words. 'all you need to do' can sound dismissive to the reader. PostHogDocs.Trivializers
296:62 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
296:100 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
298:130 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
386:3 warning 'FAQ' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
contents/docs/logs/installation/android.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:13 warning Use 'ID' instead of 'id'. Vale.Terms
4:15 warning Use 'Android' instead of 'android'. Vale.Terms
contents/docs/logs/start-here.mdx — 3 errors, 19 warnings, 0 suggestions
Line Severity Message Rule
19:98 warning 'OTel' is a possible misspelling. PostHogBase.Spelling
39:17 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
39:45 warning 'OTel's' is a possible misspelling. PostHogBase.Spelling
41:13 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
68:11 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
70:20 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
73:15 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
84:23 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
95:24 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
97:28 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
98:31 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
99:28 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
115:60 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
117:38 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
117:96 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
126:76 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
143:11 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
154:20 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
158:110 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
182:96 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
206:27 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
216:11 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames

@turnipdabeets turnipdabeets requested a review from a team May 26, 2026 19:22
@turnipdabeets turnipdabeets merged commit 564cbfd into master May 26, 2026
18 of 19 checks passed
@turnipdabeets turnipdabeets deleted the docs/android-logs-installation branch May 26, 2026 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants