Skip to content

docs(rust): document panic autocapture#18016

Merged
cat-ph merged 2 commits into
masterfrom
docs/rust-panic-autocapture
Jun 30, 2026
Merged

docs(rust): document panic autocapture#18016
cat-ph merged 2 commits into
masterfrom
docs/rust-panic-autocapture

Conversation

@cat-ph

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

Copy link
Copy Markdown
Contributor

Problem

Panic autocapture shipped in the Rust SDK in v0.15.0 (PostHog/posthog-rs#157), but the Rust error tracking docs only cover manual exception capture. The merged API differs from the earlier proposal — it is opt-in through ErrorTrackingOptions::capture_panics and global-only (no standalone install_panic_hook), so this documents the API as it actually shipped.

Changes

  • New "Capture panics" step in the Rust error tracking installation guide: enable capture_panics on ErrorTrackingOptionsBuilder and initialize the global client with init_global, which installs the process-wide std::panic hook
  • Notes the captured properties ($exception_panic_file / _line / _column), that panics are personless, that the previous hook is chained, and the best-effort delivery bound (2s flush, no async runtime needed)
  • One-line pointer to the panic step from the Rust library page

Tests

  • node-free MDX: YAML frontmatter parsed, <Steps>/<Step> tags balanced (6/6)
  • Every API reference verified against the merged SDK source (posthog-rs 4294c51, v0.15.0): capture_panics in the public API, init_global is async under the default feature, exact panic property names

Panic autocapture shipped in posthog-rs v0.15.0 (PostHog/posthog-rs#157).
Add the Capture panics step to the Rust error tracking installation
guide and a pointer from the library page: opt in with
ErrorTrackingOptions::capture_panics and initialize the global client
with init_global, which installs the process-wide panic hook.
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Jun 30, 2026 12:25PM

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Vale prose linter → found 3 errors, 19 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 — 3 errors, 9 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
110:29 warning 'personless' is a possible misspelling. PostHogBase.Spelling
112:88 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:366 warning 'backpressure' is a possible misspelling. PostHogBase.Spelling
141:218 warning 'vendored' is a possible misspelling. PostHogBase.Spelling
147: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
43:4 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
43:4 warning 'Feature flags' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
55:44 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
77:4 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
77:4 warning 'Error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
98:161 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
102:136 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
118:115 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

6.24 MiB (+11.1 KiB / +0.2%)

Largest changed named chunks
Chunk Gzip Δ vs master
component---src-pages-self-driving-index-tsx.js 9.3 KiB new
app.js 1977.3 KiB +1.5 KiB / +0.1%

Eager graph (static-import closure per entrypoint)

Entrypoint Eager size Budget Modules
app 24.19 MiB (+6.0 KiB / +0.0%) report-only 5516
Largest modules in the app closure
Module Size
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 713.6 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules 556.3 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/@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 353.9 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/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js 281.9 KiB
./src/components/ProductComparisonTable/index.tsx + 116 modules 267.6 KiB
./node_modules/.pnpm/@codesandbox+sandpack-react@2.20.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@codesandbox/sandpack-react/dist/index.mjs 266.6 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 239.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 marked this pull request as ready for review June 29, 2026 22:51
@cat-ph cat-ph requested review from a team, ablaszkiewicz, hpouillot and marandaneto June 29, 2026 22:51
@cat-ph cat-ph merged commit 062fff0 into master Jun 30, 2026
18 checks passed
@cat-ph cat-ph deleted the docs/rust-panic-autocapture branch June 30, 2026 12:15
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