Skip to content

docs(crons): Lead Go check-ins with sentry.WithMonitor - #19778

Open
wedamija wants to merge 3 commits into
masterfrom
danf/go-with-monitor-docs
Open

wedamija wants to merge 3 commits into
masterfrom
danf/go-with-monitor-docs

Conversation

@wedamija

@wedamija wedamija commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

The Go crons setup page now leads with sentry.WithMonitor. Manual CaptureCheckIn calls stay below as the alternative.

SDK PR: getsentry/sentry-go#1443

Merge after the SDK release that includes it, and replace "newer than 0.49.0" with that version.

IS YOUR CHANGE URGENT?

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

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

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

Request Review

@cursor

cursor Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

The Go crons setup page now leads with a job wrapper that sends check-ins. Manual check-in calls remain as the other path. The plan checks client errors, not-found counts, and MDX warnings on that page. An issue escalates when those errors rise or the page returns not found.

Services: sentry-docs.

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

Plan

What changed

The Go crons page now leads with sentry.WithMonitor. That helper sends an in-progress check-in with the monitor config. It then runs the job and sends ok or error with duration. Manual CaptureCheckIn examples stay under Manual Check-Ins.

This copy is live after a production docs deploy of this commit. The same include also renders on inherited Go guide crons pages.

Risk

A broken MDX fence can fail the static build or return not found at runtime. A new Go code block can throw in the browser highlighter. All inherited Go guide crons pages share this include. They fail together if the include is wrong. Readers who copy the new helper need sentry-go newer than 0.49.0. Docs telemetry cannot see customer compile failures.

Intended effect

This change rewrites docs copy. Sentry has no metric for the new snippet text. Do not mark intended_effect confirmed from telemetry. Absent would mean the live Go crons page still leads with CaptureCheckIn. That HTML check is not in Sentry. Record unknown unless the live page HTML is inspected outside this plan.

Regression watch

This include can 404 the Go crons page or throw in the client highlighter. Inherited guide crons pages share that blast radius. Sampled pageload volume on this URL is too low for a stable rate. Use error and not-found counts. Recaptcha and widget titles already fire on this URL. Do not treat those as new.

Traces store the Next.js route /:path*?, not the docs path. Filter errors and pageloads by url. Do not filter by transaction.

The url:*platforms/go* wildcard also matches Godot. Use url:*platforms/go/crons* for this page. Use url:*platforms/go/* only for sibling Go SDK pages.

Signal Baseline Compare Window Source
Client errors on Go crons URLs 0-2 events Hold this band. Escalate above 2 in 24h or on a new title 2026-09-25T20:01:15Z to 2026-10-02T20:01:15Z Sentry project docs. Query environment:production url:*platforms/go/crons*
docs.page.not_found for requested_path platforms/go 0-2 counts Hold this band. Escalate if the count rises above 2 2026-10-01T20:01:15Z to 2026-10-02T20:01:15Z Sentry project docs. Counter docs.page.not_found grouped by requested_path
MDX missing-file warning logs 0 events Hold at zero. Any rise is a regression 2026-10-01T20:01:15Z to 2026-10-02T20:01:15Z Sentry project docs. Query environment:production with message MDX file not found at runtime

The 7d crons error titles were recaptcha h6 (DOCS-B8Y) and an Event promise rejection (DOCS-9E9). Those are existing noise. Escalate when a new title mentions MDX, prism, or code blocks.

Sampled pageloads for https://docs.sentry.io/platforms/go/crons/ were 3 in both 24h and 7d. A 24h zero can be traffic noise. Flag a 7d zero only if sibling Go pageloads on url:*platforms/go/* continue. The 7d sibling sample included 97 loads on /platforms/go/ and 30 on /platforms/go/guides/http/.

Traces also showed 3 loads of https://docs.sentry.io/platforms/go/crons/). in 7d. That trailing ). is an existing bad link. Do not treat it as this change.

If the error count rises, check client logs for highlighter or MDX failures on the new Go fence.

Not observable

Live HTML that contains sentry.WithMonitor is not in Sentry. Inherited guide crons copy is the same gap. Customer sentry-go compile failures are not in docs telemetry. docs.snippet_copy had no go language row in 24h, so copy counts cannot confirm the new snippet. Pageload p95 on this URL is not stable. The sample is 3 events and one hit the 30s cap.

Comment thread platform-includes/crons/setup/go.mdx
Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread platform-includes/crons/setup/go.mdx Outdated
Co-Authored-By: Claude <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — b33aabff Deployed Oct 5, 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