Skip to content

docs(dotnet): Document sending the Hangfire recurring job schedule - #19781

Open
wedamija wants to merge 6 commits into
masterfrom
danf/hangfire-cron-config-docs
Open

wedamija wants to merge 6 commits into
masterfrom
danf/hangfire-cron-config-docs

Conversation

@wedamija

@wedamija wedamija commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

The .NET Hangfire crons page documents the new SendMonitorConfig option, which sends a recurring job's cron and time zone as the monitor config.

SDK PR: getsentry/sentry-dotnet#5665

Merge after the SDK release that includes it.

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 <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 23, 2026 9:32pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 23, 2026 9:32pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 2, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 2, 2026 19:45
@github-actions github-actions Bot added Priority: Normal Docs review has no urgent deadline and removed Priority: Needs Triage The PR description is missing valid priority information labels Oct 2, 2026
Co-Authored-By: Claude <noreply@anthropic.com>
Hangfire matches both day fields while Sentry matches either, so the
SDK doesn't send those schedules.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
…e deleted monitors

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

cursor Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks that the new Hangfire schedule section is on the live page. It also checks client errors and failed pageloads on that path. An issue escalates when Hangfire page errors rise or pageloads fail more often.

Services: sentry-docs.

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

Plan

What changed

The Hangfire crons pages now document SendMonitorConfig. Readers learn that the SDK can send a recurring job cron and time zone as monitor config.

sentry-docs must deploy before this text is live. The page lives at docs/platforms/dotnet/common/crons/hangfire/index.mdx. Common MDX also clones onto .NET guide Hangfire URLs. Catalog id sentry-docs matches the Vercel production project and the rollout report workflow. develop-docs does not ship this file.

Risk

Broken MDX or a new code sample can fail the Hangfire pages for users. Guide clones share that content, so they share the failure. A client exception or an error-status pageload on a Hangfire URL is the user-visible break. This deploy does not ship the .NET SDK change. Do not treat product cron check-ins as this rollout.

Intended effect

This change is documentation. No Sentry metric counts the new heading. Confirm the live page body instead.

absent means the live Hangfire pages still omit the heading Send the Recurring Job Schedule and omit SendMonitorConfig.

Signal Baseline Rule Source
Hangfire page body SendMonitorConfig absent on production GET Must appear after deploy GET https://docs.sentry.io/platforms/dotnet/crons/hangfire/ and GET https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/crons/hangfire/ at 2026-10-19T17:09:44Z

Regression watch

Watch Hangfire URLs only. Transaction name is /:path*?. Filter with url.full or http.url, not transaction path. User traces sample at 30%. Volume is low, so p95 is noisy. Most sampled pageloads were guide clones. aspnetcore was the busiest slice.

Signal Baseline Rule Source
Hangfire client errors 19 events in 2d. All titled Event: Event Event (type=error) captured as promise rejection. 23 sampled pageloads in the same window Hold near 19 events per 2d while pageloads stay near 23. Escalate if events rise at similar volume, or if a new title appears Sentry org sentry project docs. environment:production http.url:*hangfire* with title and count(). Window 2026-10-17T17:09:44Z to 2026-10-19T17:09:44Z
Hangfire pageload error share 13 error / 10 ok. Share 0.57 of 23 sampled pageloads Hold near 0.57. Escalate if error share rises while pageload count holds Sentry org sentry project docs. span.op:pageload environment:production url.full:*hangfire* grouped by span.status. Window 2026-10-17T17:09:44Z to 2026-10-19T17:09:44Z
Hangfire pageload p95 6845ms over 2d with 23 pageloads. 2616ms over 24h with 3 pageloads Hold in 2600-6900ms. Escalate if p95 stays above 6900ms while volume holds or rises Sentry org sentry project docs. span.op:pageload environment:production url.full:*hangfire* with count() and p95(span.duration). Windows 2026-10-17T17:09:44Z to 2026-10-19T17:09:44Z and 2026-10-18T17:09:44Z to 2026-10-19T17:09:44Z

If the error share rises, inspect Hangfire client errors first. Then inspect code tab failures on those URLs.

Not observable

No Sentry metric records that the new heading shipped. Use the live GET in Intended effect.
docs.page.load by Hangfire path did not accept a valid metric query.
HTTP 5xx from the host for this path was not measured. Pageload span.status is the proxy.
.NET SDK SendMonitorConfig behavior is not in this deploy. That ships in sentry-dotnet.

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

@linear-code

linear-code Bot commented Oct 21, 2026

Copy link
Copy Markdown

NET-879

ric-oliv added a commit that referenced this pull request Oct 29, 2026
<!-- Keep the urgency section so automation can prioritize this PR. You
may delete other sections you don't need. -->

## DESCRIBE YOUR PR

This PR adds the migration guide for version 7 of the Sentry SDK for
.NET, ready for the public release candidate, `7.0.0-rc.2`. It follows
the pattern of the Flutter v10 guide from #19390:

- A full guide at `/platforms/dotnet/migration/v6-to-v7/`, built from
one include per change in `includes/migration/dotnet-v7/`.
- An interactive checklist at
`/platforms/dotnet/migration/v6-to-v7/interactive/` that renders the
same includes through `<MigrationGuide migration="dotnet-v7" />`.
- An agent prompt callout that points at the guide's `.md` URL.
- A "Migrating to 7.x" section at the top of the existing .NET migration
page, which links to both.

Both pages live under `common/`, so they render for every .NET guide,
such as ASP.NET Core, MAUI, WPF and Serilog. Xamarin uses a separate
SDK, so the new pages exclude it. I didn't move the 6.x, 4.x and 3.x
sections, so every existing URL and anchor keeps working and the PR
needs no redirects.

To register the collection, the PR adds `dotnet-v7` to the `MIGRATIONS`
map in the `MigrationGuide` component and to the validator's
`COLLECTIONS` map, with specs for both. These changes in
`src/components/migrationGuide/` and `scripts/` touch code that the
JavaScript and Flutter guides share, so they need an approval from the
docs team. For reference, msonnb approved the last change to the
component in #19729, and andreiborza approved the JavaScript interactive
guide that added it in #19076.

The checklist shows one step only on the MAUI guide. Every other step
applies to every .NET guide, because .NET apps combine integrations,
such as a Serilog sink in an ASP.NET Core app.

I checked the guide against `7.0.0-rc.2` from nuget.org and against the
`version7` branch at getsentry/sentry-dotnet@a56c63455. The guide
describes 7.0.0. Where rc.2 still behaves differently, the release
candidate note at the top says so.

### Why this goes live during the release candidate

I'd like to merge this as soon as it's approved, while 7.0 is still in
release candidate. 7.0.0 GA is planned for 2026-11-30. People who try
the release candidate need the guide now, and the agent prompt needs a
published `.md` URL to point at.

Two develop-docs rules pull in different directions here. [Managing
Linear
projects](https://develop.sentry.dev/sdk/getting-started/playbooks/coordination/managing-linear-projects/#visibility-for-major-releases)
says docs "MUST NOT go live before the SDK ships". The [breaking changes
playbook](https://develop.sentry.dev/sdk/getting-started/playbooks/sdk-lifecycle/breaking-changes/#6-update-docs-and-changelog)
says to publish the migration guide "before or alongside the major
release". I read the first rule as protecting users from docs for code
they can't get. Version `7.0.0-rc.2` is public on nuget.org, and the
guide's first block says it's a release candidate and names that
version. Other SDKs made the same call:

- The Python 2.0 guide merged on 2024-02-28, while only the `2.0.0a1`
alpha was out. Its note at the top said so.
- The JavaScript v11 guide merged on 2026-09-08 with `11.0.0-beta.1`
out, and its interactive version followed on 2026-09-11.
- The Flutter v10 guide merged on 2026-10-05 with `10.0.0-rc.2` out,
four days before 10.0.0.

### The release candidate note

The guide opens with one `<Alert>`. It says there is no stable 7.0 yet,
names `7.0.0-rc.2`, and says the rest of the .NET docs describe 6.x
until 7.0.0 ships. It also covers what only the release candidate has:

- `Logging.AddSentry()` after `ClearProviders()` doesn't add Sentry's
logger providers back yet. That came with getsentry/sentry-dotnet#5776,
after rc.2.
- `DecompressionMethods` still includes Brotli, which
getsentry/sentry-dotnet#5816 takes out of the default after rc.2. The
note says how to leave it out until then.
- An ASP.NET Core app that sends `ILogger` entries through NLog crashes
with `Debug` on, tracked in getsentry/sentry-dotnet#5822. The guide's
verify step turns `Debug` on, so the note says to leave it off in those
apps.
- Its `net11.0` builds depend on the .NET 11 release candidate versions
of three `Microsoft.Extensions` packages.

The rest of the guide describes 7.0.0 as released. At GA, I'll delete
that one block from `includes/dotnet-v7-migration-overview.mdx`, and
nothing else needs to change.

### What this PR leaves to other PRs

This PR only adds the guide and what it needs. The reference pages are
in other PRs, and this one doesn't need any of them to merge first:

- Logs and the logging integrations: #19925
- `Microsoft.Extensions.Logging` and ASP.NET Core: #19961
- OpenTelemetry propagation: #19924
- Release and environment: #19960
- Hangfire monitor schedules: #19781

Three links in the guide point to the "Apps That Call UseSentry"
sections that #19925 adds to the Serilog, NLog and log4net guides. Until
#19925 merges, they open those guides at the top, and the migration
guide sums up the same setups itself.

There is no page for the new `Sentry.Extensions.Hosting` package yet.
I'll link it from the guide once that page exists.

Refs https://linear.app/getsentry/issue/NET-860
Refs getsentry/sentry-dotnet#5710

## IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
Select exactly one option. For deadlines, replace `YYYY-MM-DD` with the
due date. You can update this information later by editing the PR
description.

- [x] Urgent deadline (GA date, etc.): 2026-11-30
- [ ] Other deadline: YYYY-MM-DD
- [ ] No deadline: Not urgent, can wait up to 1 week+

## PRE-MERGE CHECKLIST

_Make sure you've checked the following before merging your changes:_

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: James Crosswell <jamescrosswell@users.noreply.github.com>
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>

This branch was successfully deployed

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

Crons: Hangfire sends recurring job schedule as monitor config

1 participant