docs: add Java error tracking installation and library docs - #19206
Draft
cat-ph wants to merge 1 commit into
Draft
docs: add Java error tracking installation and library docs#19206cat-ph wants to merge 1 commit into
cat-ph wants to merge 1 commit into
Conversation
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 6 errors, 44 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 |
|---|---|---|---|
| 2:13 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 10:130 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 40:176 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 40:196 | warning | 'Symbolication' is a possible misspelling. | PostHogBase.Spelling |
| 40:273 | 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 |
| 40:280 | warning | 'Deobfuscate' is a possible misspelling. | PostHogBase.Spelling |
| 80:37 | warning | 'personlessly' is a possible misspelling. | PostHogBase.Spelling |
| 113:32 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 133:252 | 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 |
| 133:331 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 189:145 | warning | 'enqueued' is a possible misspelling. | PostHogBase.Spelling |
| 189:578 | 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 |
| 197:27 | warning | 'Logback' is a possible misspelling. | PostHogBase.Spelling |
| 197:137 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 199:9 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 217:14 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 231:44 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 238:24 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 247:37 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 249:123 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 252:87 | warning | Use 'ID' instead of 'id'. | Vale.Terms |
| 259:110 | warning | 'deobfuscated' is a possible misspelling. | PostHogBase.Spelling |
| 259:130 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 277:130 | 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 |
| 283:104 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 303:124 | warning | 'Logback' is a possible misspelling. | PostHogBase.Spelling |
| 303:132 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/libraries/java/index.mdx — 2 errors, 21 warnings, 0 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 |
| 123:192 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 123:208 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 164:219 | warning | 'personless' is a possible misspelling. | PostHogBase.Spelling |
| 180:4 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 180:4 | warning | 'Feature flags' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 328:8 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 328:55 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 328:128 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 340:28 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 340:54 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 342:4 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 342:4 | warning | 'Error tracking' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 358:213 | warning | 'Logback' is a possible misspelling. | PostHogBase.Spelling |
| 358:221 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 360:26 | 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 |
| 360:87 | warning | 'Logback' is a possible misspelling. | PostHogBase.Spelling |
| 360:95 | warning | 'appender' is a possible misspelling. | PostHogBase.Spelling |
| 360:137 | warning | 'deobfuscating' is a possible misspelling. | PostHogBase.Spelling |
| 360:170 | 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 |
| 360:186 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
Contributor
Bundle reportTotal JS (gzip)8.09 MiB (-0.2 KiB / -0.0%) Eager graph (modules shipped in each entrypoint's initial chunks)
Largest modules in the
|
| Module | Size |
|---|---|
./src/data/mcp-tools.json |
1038.8 KiB |
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css |
757.5 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js |
481.4 KiB |
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules |
395.1 KiB |
./src/hooks/useCustomers.tsx + 55 modules |
369.8 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js |
354.8 KiB |
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules |
351.4 KiB |
./src/components/ProductComparisonTable/index.tsx + 126 modules |
301.5 KiB |
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
./src/components/SearchUI/index.tsx + 87 modules |
273.0 KiB |
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/magnifying-glass.mjs |
254.7 KiB |
./node_modules/.pnpm/framer-motion@10.18.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/framer-motion/dist/es/render/dom/motion.mjs + 109 modules |
253.9 KiB |
./node_modules/.pnpm/d3@7.9.0/node_modules/d3/src/index.js + 208 modules |
247.4 KiB |
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules |
240.1 KiB |
Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes for the modules actually shipped in the entrypoint's initial chunks (post-tree-shake).
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
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.
Warning
DO NOT MERGE until the corresponding
posthog-serverrelease ships.Most of this page documents API surface that is not released yet. Merging early would publish docs for methods users cannot call.
Gating features and the PRs that ship them:
inAppIncludes/inAppExcludes)releaseIdentifier(map_id for ProGuard symbolication)captureUncaughtExceptions)posthog-server-logback,PostHogAppender)Both stacks are stacked drafts. Before merging: confirm the
posthog-serverandposthog-server-logbackreleases are out, then replace the two<!-- TODO: set minimum version on release -->placeholders with the real minimum versions.Problem
There were no error tracking docs for the server-side Java SDK (
posthog-server). The error tracking installation section covered other platforms but had no Java page, so JVM server users had no documented path to capturing exceptions, configuring in-app frames, or deobfuscating ProGuard/R8 builds.Changes
contents/docs/error-tracking/installation/java.mdx— full installation guide, structured as steps:PostHogCaptureOptionsfor groups / flags / timestampinAppExcludeslistreleaseIdentifierplus a PostHog CLI ProGuard uploadcontents/docs/libraries/java/index.mdx, pluserrorTracking: truein the page'sfeaturesfrontmatter so the library page advertises the capability. Links out to the full guide.src/navs/index.js.Verification
inAppIncludes,inAppExcludes,releaseIdentifier,captureUncaughtExceptions), the documentedcaptureExceptionoverloads,PostHogCaptureOptionsbuilder methods, andPostHogAppender(setPostHog,minimumCaptureLeveldefaulting toERROR,apiKey/hostself-config) all match.inAppExcludeslist matchesDEFAULT_IN_APP_EXCLUDESentry for entry.flushAtdefault100and a 5 second flush interval, and explains that the real risk on the crash path is the asynchronous enqueue racing the synchronousflush(), withflushAt(1)as the mitigation.posthog-cli proguard uploadconfirmed as a top-level CLI command againstcontents/docs/cli.mdx./docs/...link target resolves to an existing file on current master, and the#request-contextanchor exists in the Java library page.node --check src/navs/index.jspasses; exactly one Java error tracking nav entry.Checklist
vercel.json— n/a, no pages moved