Skip to content

docs(crons): Lead .NET check-ins with SentrySdk.WithMonitor - #19779

Open
wedamija wants to merge 4 commits into
masterfrom
danf/dotnet-with-monitor-docs
Open

wedamija wants to merge 4 commits into
masterfrom
danf/dotnet-with-monitor-docs

Conversation

@wedamija

@wedamija wedamija commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

The .NET crons setup page now leads with SentrySdk.WithMonitor (async and sync examples). Manual CaptureCheckIn calls move to a "Manual Check-Ins" subsection below it.

SDK PR: getsentry/sentry-dotnet#5664

Merge after the SDK release that includes it, and replace "newer than 6.12.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 6, 2026 12:51am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 6, 2026 12:51am UTC

Request Review

@cursor

cursor Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks page loads of the changed setup page, client errors on that page, and platform 404s. An issue escalates when client errors appear on that page or 404s rise.

Services: sentry-docs.

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

Plan

What changed

The .NET Crons setup page now leads with WithMonitor wrap examples. Manual CaptureCheckIn calls move to a Manual Check-Ins subsection. sentry-docs must deploy before this copy is live. The page path is /platforms/dotnet/crons/.

Risk

Readers may copy WithMonitor on an SDK older than the documented version. A broken include can raise client errors on that page. The blast radius is that one setup page. Other platform Crons pages do not ship this include.

Intended effect

This change rewrites page copy. Telemetry cannot show that WithMonitor now leads the page. absent means the live page still leads with CaptureCheckIn after deploy. There is no queryable success metric for this wording change.

Regression watch

A bad include can 404 the page or throw in the new code blocks. Hold the bands below. A drop of page loads to zero with a rise in 404s is a regression. New client errors on this path are a regression.

Signal Baseline Window Rule Source
Client errors on /platforms/dotnet/crons 0 errors 2026-10-01T20:11:59.739Z to 2026-10-02T20:11:59.739Z Hold at zero. Escalate if the 24h count rises above zero. Sentry sentry/docs. Query: url:*/platforms/dotnet/crons* OR transaction:*/platforms/dotnet/crons*
Client errors on /platforms/dotnet/crons 2 errors 2026-09-25T20:11:59.739Z to 2026-10-02T20:11:59.739Z Hold at 0-2 per 7d. Escalate if the 7d count rises above 2. Same query as the 24h error row
docs.page.load for path /platforms/dotnet/crons/ 3 loads in 24h. 33 loads in 7d. About 3-5 loads per 24h 24h: 2026-10-01T20:11:59.739Z to 2026-10-02T20:11:59.739Z. 7d: 2026-09-25T20:11:59.739Z to 2026-10-02T20:11:59.739Z Hold 3-5 loads per 24h. Escalate if 24h loads fall to zero and 404s rise. Sentry sentry/docs. Query: metric.name:docs.page.load AND metric.type:counter AND path:/platforms/dotnet/crons/
docs.page.not_found for requested_path:platforms/dotnet 2 in 24h. 18 in 7d. About 2-3 per 24h 24h: 2026-10-01T20:11:59.739Z to 2026-10-02T20:11:59.739Z. 7d: 2026-09-25T20:11:59.739Z to 2026-10-02T20:11:59.739Z Hold 2-3 per 24h. Escalate if 24h 404s rise above 3. Sentry sentry/docs. Query: metric.name:docs.page.not_found AND requested_path:platforms/dotnet

The 404 metric stores only the first two path segments. It covers all .NET platform 404s, not this page alone. Pair it with page loads on /platforms/dotnet/crons/.

Not observable

The new heading and WithMonitor samples are not in telemetry. Pageload spans for this path returned zero. Navigation spans were 3 in 7 days, so p95 latency is not a usable band.

}, options => options.Interval("0 * * * *"));
```

Exceptions thrown by the job are rethrown, and the job's return value is passed through. `SentrySdk.WithMonitor` requires a Sentry .NET SDK version newer than `6.12.0`. If the monitor already exists in Sentry, you can leave out the monitor options.

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: The documentation for SentrySdk.WithMonitor uses a placeholder SDK version, newer than 6.12.0, which needs to be updated before merging.
Severity: MEDIUM

Suggested Fix

Before merging the pull request, replace the placeholder version string "newer than 6.12.0" with the actual minimum required SDK version that includes the SentrySdk.WithMonitor feature, as indicated in the PR description.

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: platform-includes/crons/setup/dotnet.mdx#L23

Potential issue: The documentation file `platform-includes/crons/setup/dotnet.mdx`
specifies that using `SentrySdk.WithMonitor` requires a Sentry .NET SDK version "newer
than `6.12.0`". However, the pull request description explicitly states this is a
placeholder value. Merging the pull request in its current state will result in
publishing incorrect information about the minimum required SDK version, which could
lead to user confusion and setup issues.

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

@ric-oliv

ric-oliv commented Oct 5, 2026

Copy link
Copy Markdown
Member

Hi @wedamija, thanks for all the work on this topic! :)

We should probably also edit the getting started page to mention .NET when this goes in, right?

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

This branch was successfully deployed

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

2 participants