Skip to content

docs(js): Add the pi-durable integration and Durable Object SQL span filtering - #19875

Closed
JPeer264 wants to merge 1 commit into
masterfrom
jp/pi-durable-integration
Closed

JPeer264 wants to merge 1 commit into
masterfrom
jp/pi-durable-integration

Conversation

@JPeer264

@JPeer264 JPeer264 commented Oct 9, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

This adds a page for piDurableIntegration (getsentry/sentry-javascript#24993, SDK 11.6.0), which is on by default, and lists it in the agent tracing grid and the runtime integration tables. It also documents which internal Durable Object SQL tables create no spans (cf_, and pi_ since getsentry/sentry-javascript#25028) and the durableObjectSqlSpanAllowlist option that brings them back.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • 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.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • 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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@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 9:40am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 9, 2026 9:40am UTC

Request Review

…filtering

Add a page for piDurableIntegration (SDK 11.6.0), list it in the agent
tracing grid and the runtime integration tables, and document which
internal Durable Object SQL tables get no spans and the
durableObjectSqlSpanAllowlist option.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@JPeer264
JPeer264 force-pushed the jp/pi-durable-integration branch from b3daa11 to 1df43df Compare October 9, 2026 09:33
@JPeer264
JPeer264 marked this pull request as ready for review October 9, 2026 12:38
@JPeer264 JPeer264 self-assigned this Oct 9, 2026
@JPeer264
JPeer264 requested a review from andreiborza October 9, 2026 12:38
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 9, 2026 12:38
@cursor

cursor Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

The change publishes a new integration page and updates nearby JavaScript docs. The plan checks that the new page is reachable. An issue escalates when JavaScript docs return server errors or missing-file logs appear.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Readers of JavaScript docs can now open a pi-durable integration page. Cloudflare Durable Object docs now describe SQL span filtering and durableObjectSqlSpanAllowlist. The sentry-docs service must deploy before this change is live. Deploy config maps the Vercel production project sentry-docs to this catalog id. The change lives under product docs. It does not ship in develop-docs.

Risk

Broken MDX can 404 the new page after deploy. The same break can take down JavaScript integration index pages that include the new table row. Cloudflare Durable Object and agent-tracing pages can fail to render. Readers then lose setup steps or hit missing pages.

Intended effect

The new pi-durable docs pages start to receive HTTP requests. Absent looks like those URLs stay at zero while sibling integration pages still receive traffic. Traces sample at 30 percent. A quiet page may stay at zero in sampled spans.

Signal Baseline Rule Source
HTTP spans whose URL contains pi-durable 0 spans Rise above 0 after deploy. Absent: stays 0 while sibling integration pages still have traffic Sentry project docs, environment production, 2026-10-08T12:38:50Z to 2026-10-09T12:38:50Z. Query: has:http.url http.url:*pi-durable* environment:production. Fields: count()
HTTP spans for JavaScript integration pages 9494 spans Hold traffic near this band so a zero on pi-durable is not a site-wide drop Sentry project docs, environment production, same window. Query: has:http.method AND http.url:*platforms/javascript/configuration/integrations* AND environment:production. Fields: count()

Regression watch

This change can break JavaScript docs pages that include the new MDX. Watch server failures and missing-file logs on that path. Also watch error events on JavaScript docs pages.

Signal Baseline Rule Source
HTTP 5xx share on JavaScript docs 0 / 884046 spans, 0% Hold at 0% Sentry project docs, environment production, 2026-10-08T12:38:50Z to 2026-10-09T12:38:50Z. 5xx query: HTTP requests with status 5xx and URL containing /platforms/javascript/. Denominator query: HTTP requests whose URL contains /platforms/javascript/
Error events on JavaScript docs pages 0-7 events per hour. 36 events in 24h Hold in 0-7 events per hour. Escalate when the hourly count stays above 7 for more than one hour Sentry project docs, errors dataset, environment production, 2026-10-08T12:00:00Z to 2026-10-09T12:00:00Z. Query: environment:production AND (transaction:*platforms/javascript* OR url:*platforms/javascript*). Peak 7 at 2026-10-08T16:00Z
Logs for missing MDX at runtime 0 logs Hold at 0 Sentry project docs, environment production, 2026-10-08T12:38:50Z to 2026-10-09T12:38:50Z. Query: environment:production AND message:"*MDX file not found at runtime*". Fields: count()

If the 5xx share or the missing-file logs rise, inspect JavaScript integration pages and the Cloudflare Durable Object page first.

Not observable

Whether the new prose and code samples are correct. Search index coverage for the new page. Whether each JavaScript guide variant of the common page renders. CDN hit counts. Unsampled page views. Path-level 404s. The docs.page.not_found metric only stores the first two path segments.

Get Slack DMs about this change: cursor.com/automations/rollouts


</SdkOption>

<SdkOption name="durableObjectSqlSpanAllowlist" type='Array<string | RegExp>' defaultValue='[]' availableSince='10.67.0'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Bug: durableObjectSqlSpanAllowlist is documented with availableSince='10.67.0', but it likely became available in SDK version 11.6.0 alongside pi_ prefix filtering.
Severity: LOW

Suggested Fix

Verify the SDK release version for durableObjectSqlSpanAllowlist and update availableSince to '11.6.0' if the option was introduced in that version.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/javascript/common/configuration/options.mdx#L579

Potential issue: The `durableObjectSqlSpanAllowlist` option documentation specifies
`availableSince='10.67.0'`, but its description covers both `cf_` and `pi_` prefix
filtering. The `pi_` prefix filtering and associated integration were introduced in SDK
version 11.6.0. Users running versions between 10.67.0 and 11.5.x who attempt to
configure this option according to the docs will find it non-functional.

Did we get this right? 👍 / 👎 to inform future reviews.

@JPeer264

JPeer264 commented Oct 9, 2026

Copy link
Copy Markdown
Member Author

closing in favor of #19873

@JPeer264 JPeer264 closed this Oct 9, 2026
@JPeer264
JPeer264 deleted the jp/pi-durable-integration branch October 9, 2026 13:20

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 1df43dfc 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.

1 participant