Skip to content

docs(javascript): Add Pi Durable guide - #19873

Merged
andreiborza merged 3 commits into
masterfrom
docs/pi-durable-guide
Oct 9, 2026
Merged

andreiborza merged 3 commits into
masterfrom
docs/pi-durable-guide

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Adds a dedicated javascript.pi-durable platform guide for the Pi Durable integration added in getsentry/sentry-javascript#24993 (see also the Pi Durable announcement). It follows the same structure as the Flue, Eve, and Mastra guides.

  • docs/platforms/javascript/guides/pi-durable/index.mdx: Node.js setup (preload instrument.mjs with --import, or use the bundler plugin)
  • docs/platforms/javascript/guides/pi-durable/cloudflare.mdx: Cloudflare setup (sentryCloudflareVitePlugin() + instrument.server.ts, with an Agents SDK PiHarness example)
  • includes/pi-durable/: shared sections covering experimental status, captured telemetry (gen_ai.invoke_agent / gen_ai.chat / gen_ai.execute_tool), conversation IDs across restarts, crash recovery, captured errors, which provider integrations get skipped, current gaps, verification, and next steps
  • Adds javascript.pi-durable to common-page platform lists wherever Mastra appears (install-method pages stay visible, since a Pi Durable app controls its own startup)
  • Adds a Pi icon (src/icons/pi-durable.svg), plus entries on the Agent Tracing index and the Agents getting-started page

Bun and Deno are left out for now because their setup couldn't be verified. Only Node and Cloudflare are documented.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

via Andrei Borza.

--

View Junior Session [Sentry]

sentry-junior Bot and others added 3 commits October 9, 2026 08:20
Co-Authored-By: Andrei Borza <andrei.borza@sentry.io>
Co-Authored-By: Andrei Borza <andrei.borza@sentry.io>
Co-Authored-By: Andrei Borza <andrei.borza@sentry.io>
@vercel

vercel Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 9, 2026 8:44am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Oct 9, 2026 8:44am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 9, 2026
@andreiborza
andreiborza marked this pull request as draft October 9, 2026 08:39
@cursor

cursor Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

The change publishes a new platform guide and links it from agent tracing pages. The plan checks 200s on the new guide URL, JavaScript guide 404s, and client errors. An issue escalates when guide 404s rise or server 5xx appear.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

Requests to /platforms/javascript/guides/pi-durable/ now serve the Pi Durable setup guide. The JavaScript agent-tracing index and the Agents getting-started page list that guide. A Cloudflare subpage is also live under that guide.

sentry-docs must deploy before those pages are live. develop-docs also ships the shared PlatformIcon map in src/. The Vercel production deploy map names both ids. Shared src/ is why develop-docs is included.

Risk

If static path generation misses the new slug, the guide URL returns 404. A bad icon import can fail the shared bundle on both sites. Sibling JavaScript guide pages can 404 if the new platform frontmatter breaks page generation. Client render of the platform selector can throw if the new icon map is wrong.

Intended effect

The new guide is live when http.server spans for http.url:*pi-durable* return 200. That counter is 0 today. Zero is the baseline, not a gap. absent looks like the counter staying at 0, or the URL returning 404. Traces sample at 30%, so a few 200s may not appear at once.

Signal Baseline Rule Source
http.server count for http.url:*pi-durable* 0 in 2026-10-08T08:39Z to 2026-10-09T08:39Z Rise above 0 with status 200. Stay at 0 is absent. Sentry org sentry project docs

Regression watch

This diff can 404 sibling JavaScript guides if static paths fail. It can also throw in the shared page and icon code. Watch 404s on that guide family, 5xx on the docs catch-all, and client errors on that catch-all. Algolia fetch failures already dominate client errors. Treat a new title from PlatformIcon or MDX as a regression even if the total stays near the sample.

Signal Baseline Rule Source
JavaScript guides http.server 404 rate 0.7% (3 of 445) in 2026-10-08T08:39Z to 2026-10-09T08:39Z Hold in 0-1.5%. Rise above that band is a regression. Sentry org sentry project docs, span.op:http.server http.url:*platforms/javascript/guides/*
JavaScript guides http.server p95 123ms on 445 spans in the same window Hold near 123ms. A large rise with 404s is a regression. Same query, p95(span.duration)
Docs catch-all http.server 5xx 0 in the same window Hold at 0. Any 5xx is a regression. Sentry org sentry project docs, transaction:/:path* and http.status_code:>=500
Client errors on /:path*? 160 events in the same window Hold near 160. A clear rise, or a new PlatformIcon or MDX title, is a regression. Sentry org sentry project docs, environment:production transaction:"/:path*"
develop-docs production errors 46 events in the same window Hold near 46 after the shared icon ships. Sentry org sentry project develop-docs

Sibling Eve and Mastra guide http.server counts were 7 and 27 in that window. If those counts fall to 0 while 404s rise, treat it as the same generation failure.

Not observable

Client pageload transaction names are Next.js routes, not the page URL. Soft navigations are sampled at 30%. Whether the new MDX body is correct is not in traces. The JavaScript agent-tracing page had 0 http.server spans on the URL used here, so that page is not a usable watch.

@andreiborza
andreiborza merged commit 27d3d4c into master Oct 9, 2026
32 checks passed
@andreiborza
andreiborza deleted the docs/pi-durable-guide branch October 9, 2026 13:09
@cursor

cursor Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Verified in production

  • The new guide returned 200s in production, and sibling JavaScript guide errors stayed normal.
  • The new Pi Durable guide is serving 200s, and sibling 404s and develop-docs errors stayed normal.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 2e53c5da Deployed Oct 9, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants