Skip to content

docs(rust): add Rust error tracking installation guide#17583

Merged
cat-ph merged 3 commits into
masterfrom
docs/rust-error-tracking
Jun 17, 2026
Merged

docs(rust): add Rust error tracking installation guide#17583
cat-ph merged 3 commits into
masterfrom
docs/rust-error-tracking

Conversation

@cat-ph

@cat-ph cat-ph commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Problem

The Rust SDK shipped manual error tracking in v0.12.0 (PostHog/posthog-rs#129), but there are no error tracking docs for Rust. Per review on PostHog/posthog-rs#130, usage docs belong here as the canonical reference, not in the SDK README.

Changes

  • New /docs/error-tracking/installation/rust page following the Go/Elixir page structure: install (default error-tracking feature), client init, manual capture (capture_exception / capture_exception_with with options), stack trace configuration (ErrorTrackingOptionsBuilder), and a verify step
  • Rust entry in the error tracking installation nav
  • ## Error tracking section + errorTracking: true feature flag on the Rust library page

Notes

  • Covers manual exception capture only (released in v0.12.0). Panic autocapture is still in review (feat: add panic autocapture posthog-rs#130); its docs will be added once it ships.
  • Stack traces resolve in-process (no symbol uploads); the page carries a "source context not yet supported" callout like Go's.

Tests

  • node --check on src/navs/index.js, YAML frontmatter parsed on both MDX files, <Steps>/<Step> tags balanced
  • Code snippets mirror compiling examples from the SDK's tests/doctests

cat-ph added 2 commits June 12, 2026 19:13
Documents manual exception capture (capture_exception /
capture_exception_with), panic autocapture via install_panic_hook, and
stack trace configuration for the Rust SDK, moving the usage docs out of
the posthog-rs README per PostHog/posthog-rs#130 review. Adds the
installation page, the error tracking nav entry, and an error tracking
section on the Rust library page.
EU Cloud and self-hosted projects would otherwise send captures to the
default US endpoint; sibling installation pages all pass the host.
@github-actions

github-actions Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Jun 16, 2026 05:06PM

@github-actions

github-actions Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Vale prose linter → found 2 errors, 17 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!

contents/docs/error-tracking/installation/rust.mdx — 2 errors, 7 warnings, 0 suggestions
Line Severity Message Rule
2:13 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
20:1 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
29:212 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
44:30 warning 'Tokio' is a possible misspelling. PostHogBase.Spelling
44:115 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
50:72 warning 'personlessly' is a possible misspelling. PostHogBase.Spelling
50:85 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
112:218 warning 'vendored' is a possible misspelling. PostHogBase.Spelling
118:104 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
contents/docs/libraries/rust/index.mdx — 0 errors, 10 warnings, 0 suggestions
Line Severity Message Rule
3:18 warning Use 'GitHub' instead of 'github'. Vale.Terms
3:37 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
33:4 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
33:4 warning 'Feature flags' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
45:44 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
67:4 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
67:4 warning 'Error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
88:41 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
92:136 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
108:115 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames

@LuuOW LuuOW left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technical audit: code implementation verified for system consistency.

Panic autocapture is still in review (PostHog/posthog-rs#130) and
unreleased. Ship the manual error tracking docs now; the panic hook
section returns once it lands in a release.
@cat-ph cat-ph marked this pull request as ready for review June 16, 2026 16:54
@cat-ph cat-ph requested review from a team, ablaszkiewicz and hpouillot June 16, 2026 16:58
@github-actions

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

6.25 MiB (+0.0 KiB / +0.0%)

Eager graph (static-import closure per entrypoint)

Entrypoint Eager size Budget Modules
app 29.16 MiB (+0.1 KiB / +0.0%) report-only 5728
Largest modules in the app closure
Module Size
./node_modules/.pnpm/mapbox-gl@3.16.0/node_modules/mapbox-gl/dist/mapbox-gl.js 1619.1 KiB
./src/mdxGlobalComponents.js + 138 modules 868.2 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 710.1 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/lottie-web@5.13.0/node_modules/lottie-web/build/player/lottie.js 610.8 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
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules 474.6 KiB
./node_modules/.pnpm/@codemirror+view@6.38.2/node_modules/@codemirror/view/dist/index.js 458.1 KiB
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules 395.1 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.cjs.js 364.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
./src/hooks/useCustomers.tsx + 54 modules 352.3 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
./node_modules/.pnpm/jspdf@3.0.2/node_modules/jspdf/dist/jspdf.es.min.js 334.1 KiB
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js 281.9 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.

@cat-ph cat-ph merged commit e54da2d into master Jun 17, 2026
20 checks passed
@cat-ph cat-ph deleted the docs/rust-error-tracking branch June 17, 2026 10:53
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.

4 participants