Skip to content

docs(crons): Add rufus-scheduler setup for Ruby - #19789

Open
wedamija wants to merge 4 commits into
masterfrom
danf/ruby-rufus-crons-docs
Open

wedamija wants to merge 4 commits into
masterfrom
danf/ruby-rufus-crons-docs

Conversation

@wedamija

@wedamija wedamija commented Oct 3, 2026 •

Copy link
Copy Markdown
Member

Adds a rufus-scheduler section to the Ruby Crons setup page: how to enable the :rufus_scheduler patch, how slugs are picked, which jobs get a monitor config, and how to skip a job.

The integration ships in the next sentry-ruby release.

SDK PR: getsentry/sentry-ruby#3110

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 3, 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 16, 2026 11:55pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 16, 2026 11:55pm UTC

Request Review

wedamija and others added 2 commits October 5, 2026 12:17
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
The SDK now converts `L` and `#` cron fields, so they no longer belong
in the list of schedules sent without a monitor config.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

@cursor

cursor Bot commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

This change adds a scheduler setup section to the Ruby job-monitoring docs pages. The plan checks page reachability, request failure rate, 404s, and client errors on those pages. An issue escalates when request failures, 404s, or client errors rise on that path.

Services: sentry-docs.

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

Plan

What changed

The Ruby Crons setup pages now document rufus-scheduler setup. Readers see how to enable the rufus-scheduler patch. They also see slug rules, which jobs get a monitor config, and how to skip a job. The change is live after sentry-docs deploys to production. The include drives /platforms/ruby/crons/ and each Ruby guide Crons page.

Risk

A bad MDX parse can fail the static build. It can also break render on every Ruby Crons page. New code samples and the Alert can cause client errors on those pages. All Ruby guide Crons pages share this include. Wrong copy cannot change SDK runtime. The patch ships in the next sentry-ruby release, not this deploy.

Intended effect

This is a docs edit. No telemetry counts the new rufus-scheduler heading or samples. The executor cannot confirm intended effect from metrics. Record intended effect as unknown unless a live page fetch shows the new section. Client page loads only show that someone opened the page.

docs.page.load on paths that match *ruby* and *crons* was 1 in 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z, on /platforms/ruby/crons/. It was 6 in 2026-10-15T00:00:00Z to 2026-10-17T00:00:00Z across four Ruby Crons paths. That volume is reachability only. It does not prove the new section is present. Absent still cannot be told from this counter.

Regression watch

A failed include can 404 or error every Ruby Crons URL. Watch failures on that path, not site-wide search noise. Weekday request volume may not hold on a weekend.

Signal Baseline Window Rule Source
http.client failure rate on Ruby Crons URLs 0% last 24h. 1.55% last 48h. Prior 24h about 2.4%. Band 0-2.5%. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z and 2026-10-15T00:00:00Z to 2026-10-17T00:00:00Z Hold inside 0-2.5%. Escalate if the rate rises above the band. Sentry org sentry project docs. Spans environment:production http.url:*platforms/ruby*crons*. Group by span.op. Use failure_rate() on http.client. Last 24h: 67 spans, p95 500ms, failure rate 0. Last 48h: 193 spans, p95 633ms, failure rate 1.55%.
Error spans on Ruby Crons URLs 0 of 467 spans last 24h. 3 of 1196 spans last 48h. Share band 0-0.25%. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z and 2026-10-15T00:00:00Z to 2026-10-17T00:00:00Z Hold error-span share at 0-0.25%. Escalate if the share rises above the band. Same span query. Group by span.status and http.status_code. Last 24h: 400 middleware ok, 67 http.client 200. Last 48h: 1003 ok, 190 200, 3 error.
Client error events on Ruby Crons pages 0 events last 24h. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z Hold at 0. Escalate if any error event matches this path. Sentry org sentry project docs. Errors environment:production and url:*platforms/ruby* or http.url:*platforms/ruby*crons*. Site-wide docs errors in the same window are mostly Algolia and kapa fetch noise. Do not use those as this watch.
404s for platforms/ruby 0 last 24h. Other first-two-segment paths had 1-16. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z Hold at 0. Escalate if this counter rises. Sentry metric docs.page.not_found. Query metric.name:docs.page.not_found environment:production requested_path:platforms/ruby. This metric stores only the first two path segments.
Middleware span count on Ruby Crons URLs 400 last 24h. 600 in the prior 24h. Band 400-600 on weekdays. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z vs 2026-10-15T00:00:00Z to 2026-10-16T00:00:00Z Hold inside 400-600 on a weekday. Weekend volume may fall below 400. Escalate when volume collapses with 404s or error spans. Same span query. span.op:middleware. Last 24h p95 1.5ms. Failure rate 0 in both sampled days.

If the error-span share rises, inspect client errors and code-tab render on /platforms/ruby/crons/ and the Rails, Sidekiq, and Resque Crons pages.

Not observable

The HTML of the new rufus-scheduler heading and samples. No connected source reads page body after deploy. Client pageload, navigation, and LCP on these URLs. Last 24h had 0 pageload spans. Traces sample at 30%, and many loads are soft navigations. Code snippet copies on Ruby paths. docs.snippet_copy was 0 last 24h. 404s below platforms/ruby. The 404 metric truncates the path. SDK check-in behavior for the rufus-scheduler patch. That ships in sentry-ruby, not this change.

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

This branch was successfully deployed

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

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant