Skip to content

docs(crons): Add Solid Queue setup for Ruby - #20047

Open
wedamija wants to merge 3 commits into
danf/ruby-rufus-crons-docsfrom
danf/ruby-solid-queue-crons-docs
Open

wedamija wants to merge 3 commits into
danf/ruby-rufus-crons-docsfrom
danf/ruby-solid-queue-crons-docs

Conversation

@wedamija

Copy link
Copy Markdown
Member

Adds a Solid Queue section to the Ruby Crons setup page: how to enable the :solid_queue_recurring patch, how slugs come from task keys, which schedules get a monitor config, and an example config/recurring.yml.

The integration ships in the next sentry-ruby release.

SDK PR: getsentry/sentry-ruby#3140

Stacked on #19789

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

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

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 16, 2026
Co-Authored-By: Claude <noreply@anthropic.com>
Matches the other enabled_patches examples on the page.

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

The plan checks page-load failures on Ruby Crons docs and on other Ruby docs pages. It also checks client errors from hydration and code blocks. An issue escalates when those failure rates rise or those client errors appear.

Services: sentry-docs.

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

Plan

What changed

Ruby Crons setup pages now document Solid Queue recurring tasks.
Readers enable the :solid_queue_recurring patch.
Monitor slugs come from task keys in config/recurring.yml.
This change is live after sentry-docs deploys to production.
Deploy config maps the Vercel production project to that service.
The include is platform-includes/crons/setup/ruby.mdx.
It renders at /platforms/ruby/crons/ and at each Ruby guide Crons URL.

Risk

Bad markup can break every Ruby Crons page that shares this include.
That set includes /platforms/ruby/crons/ and each Ruby guide Crons URL.
A new code block or Alert can throw in the browser after a good deploy.
This pull request does not ship the Ruby SDK.
Wrong docs cannot break Crons check-in ingest.
Other platform Crons pages do not use this include.

Intended effect

This change only adds documentation.
No production metric counts the new Solid Queue section.
Page traces already exist for these URLs.
Telemetry cannot show that the new heading is present.
Treat intended effect as not measurable from Sentry.
absent would look the same as confirmed in traces.

Regression watch

A markup or client-render fault would fail Ruby Crons pages first.
Sibling Ruby docs pages share the same layout and code-block components.
Traces are sampled at 30 percent. Counts below are sampled spans, not raw views.
If a Crons URL returns zero spans, record that row as unknown.

Signal Baseline Window Rule Source
Ruby Crons pageload and navigation failure rate Last 24h: 0 sampled spans. Prior 24h: 3 sampled navigations to /platforms/ruby/guides/sidekiq/crons/ and no failed result in the 2d pool. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z and 2026-10-15T00:00:00Z to 2026-10-17T00:00:00Z When any span exists, hold at 0%. If count is 0, mark unknown. Sentry org sentry project docs. Query span.op:[pageload,navigation] environment:production http.url:*platforms/ruby*crons* with failure_rate()
Ruby platform pageload and navigation failure rate Last 24h: 0% of 63 pageloads and 0% of 40 navigations. Prior 24h: 0% of 94 pageloads and 0% of 107 navigations. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z and 2026-10-15T00:00:00Z to 2026-10-16T00:00:00Z Hold at 0%. Sentry org sentry project docs. Query span.op:[pageload,navigation] environment:production http.url:*docs.sentry.io/platforms/ruby* with failure_rate()
Hydration and code-block client errors 0 events in the last 24h. This is a fault class. 2026-10-16T00:00:00Z to 2026-10-17T00:00:00Z Hold at 0. Sentry org sentry project docs. Query environment:production AND (Hydration OR "Minified React error" OR codeTabs OR CodeBlock)

Site-wide pageload failure rate was 3.9-4.1% in the same windows.
Do not use that fleet rate as the Ruby watch.

Not observable

Presence of the Solid Queue heading on the live HTML or markdown export.
Algolia search results for this section. The index job is separate and not connected here.
Ruby SDK check-in behavior. That ships in a later SDK release.
Path-specific client exceptions on Ruby Crons URLs. Error culprit is /:path*?. A url:*platforms/ruby* error search returned no events.

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

This branch was successfully deployed

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