Skip to content

docs(ruby): Correct excluded_exceptions defaults - #20245

Open
sentry-junior[bot] wants to merge 1 commit into
masterfrom
docs/ruby-excluded-exceptions-defaults
Open

sentry-junior[bot] wants to merge 1 commit into
masterfrom
docs/ruby-excluded-exceptions-defaults

Conversation

@sentry-junior

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

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The Ruby excluded_exceptions docs list Sentry::Configuration::IGNORE_DEFAULT as the default. The real default also includes Sentry::Configuration::PUMA_IGNORE_DEFAULT. The example also says it suppresses the Rails 404 exceptions ActionController::RoutingError and ActiveRecord::RecordNotFound, but sentry-rails already excludes both by default. Adding them again does nothing.

Source evidence (sentry-ruby 7.1.0):

Corrected wording:

  • Default: Sentry::Configuration::IGNORE_DEFAULT + Sentry::Configuration::PUMA_IGNORE_DEFAULT
  • The example now uses a placeholder app exception, and the text names the defaults that sentry-rails and sentry-sidekiq add.

cc @sl0thentr0py @solnic

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

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

via automation sched_fe39d4dd0d4e77a4b4463de325041d04 · Run ID sched_fe39d4dd0d4e77a4b4463de325041d04:1793088000000.

--

View Junior Session [Sentry]

@vercel

vercel Bot commented Oct 27, 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 27, 2026 8:14am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Oct 27, 2026 8:14am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 27, 2026
@cursor

cursor Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks the published options page text, page-load failures, client errors, and missing-page logs. An issue escalates when those pages fail to load or those errors appear.

Services: sentry-docs.

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

Plan

What changed

The Ruby options pages now show the excluded_exceptions default as IGNORE_DEFAULT plus PUMA_IGNORE_DEFAULT. The sample suppresses MyApp::IgnorableError. It no longer lists Rails 404 exceptions.

sentry-docs must deploy before this text is live. The common MDX file also builds the Rails, Sidekiq, Rack, Resque, and Delayed Job options pages.

Risk

A bad MDX compile can drop those static pages. Readers then get a 404. A client render fault can throw on the same URLs. Wrong published text leaves readers with the old default.

Intended effect

Fetch the published HTML. The new default string must be present. Absence is a Default cell that still shows only IGNORE_DEFAULT.

Signal Baseline Window Rule Source
Published HTML default for excluded_exceptions Default cell is Sentry::Configuration::IGNORE_DEFAULT only. The page does not contain PUMA_IGNORE_DEFAULT. The sample still lists ActionController::RoutingError and ActiveRecord::RecordNotFound. Fetched 2026-10-27T08:09:39Z Rise to include Sentry::Configuration::IGNORE_DEFAULT + Sentry::Configuration::PUMA_IGNORE_DEFAULT. The sample must use MyApp::IgnorableError. Absent: the Default cell still shows only IGNORE_DEFAULT. GET https://docs.sentry.io/platforms/ruby/configuration/options/ and https://docs.sentry.io/platforms/ruby/guides/rails/configuration/options/

Regression watch

Watch the six inherited options URLs as one path. Traffic is low. A drop to zero page loads is the 404 signal. One generic client error in 48h is noise. Two or more errors in 24h is not.

Exact URL list for every trace query: /platforms/ruby/configuration/options/, /platforms/ruby/guides/rails/configuration/options/, /platforms/ruby/guides/sidekiq/configuration/options/, /platforms/ruby/guides/rack/configuration/options/, /platforms/ruby/guides/resque/configuration/options/, /platforms/ruby/guides/delayed_job/configuration/options/.

Signal Baseline Window Rule Source
Page-load and navigation failure rate on the six URLs 0 failures in 16 spans (24h) and 0 failures in 29 spans (48h). Prior 24h is 13 spans at 0. Band is 0. 2026-10-26T08:09:00Z to 2026-10-27T08:09:39Z and 2026-10-25T08:09:00Z to 2026-10-27T08:09:39Z Hold at 0. Escalate if the rate rises above 0. Sentry project docs. Query: sentry.environment:production AND span.op:[pageload,navigation] AND url.path:[/platforms/ruby/configuration/options/,/platforms/ruby/guides/rails/configuration/options/,/platforms/ruby/guides/sidekiq/configuration/options/,/platforms/ruby/guides/rack/configuration/options/,/platforms/ruby/guides/resque/configuration/options/,/platforms/ruby/guides/delayed_job/configuration/options/]. Fields: count(), failure_rate().
Client error share on those URLs 0 events and 14 page loads in 24h (0%). 1 event and 35 page loads in 48h (2.9%). The 48h event is DOCS-9E9 at 2026-10-25T12:48:27Z. Band is 0-2.9% of page loads. 2026-10-26T08:09:00Z to 2026-10-27T08:09:39Z and 2026-10-25T08:09:00Z to 2026-10-27T08:09:39Z Hold in 0-2.9% of docs.page.load volume. Escalate above 1 event per 24h at this volume. Sentry project docs errors: environment:production AND (transaction:*platforms/ruby/configuration/options* OR http.url:*platforms/ruby/configuration/options*). Pair with docs.page.load below.
docs.page.load on those paths 14 loads in 24h. 35 loads in 48h. Prior 24h is 21. Band is 14-21 loads per 24h. Primary path /platforms/ruby/configuration/options/ is 9 in 24h and 16 in 48h (7 prior). 2026-10-26T08:09:00Z to 2026-10-27T08:09:39Z and 2026-10-25T08:09:00Z to 2026-10-27T08:09:39Z Hold in 14-21 per 24h. Escalate if pooled volume falls to 0, or if the primary path falls to 0. Sentry project docs metrics: metric.name:docs.page.load AND sentry.environment:production AND path:*platforms/ruby* AND path:*configuration/options*.
MDX missing-file logs 0 matching warn or error logs in 24h and in 48h. Band is 0. 2026-10-26T08:09:00Z to 2026-10-27T08:09:39Z and 2026-10-25T08:09:00Z to 2026-10-27T08:09:39Z Hold at 0. Escalate if a log names a ruby configuration/options path. Sentry project docs logs: sentry.environment:production AND severity:[warn,error] AND message:["*MDX file not found*","*MDX_RUNTIME_ERROR*"].

If the failure rate rises, check those MDX logs for pageNode.path on the ruby options pages.

Not observable

docs.page.not_found stores only the first two path segments. It cannot isolate these options pages. Page-load traces use a 30% sample, so one failed load can miss the failure rate. Use the error events and docs.page.load drop for that gap.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 5124aedc Deployed Oct 27, 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.

0 participants