Skip to content

docs(dotnet): Add 6.x to 7.x migration guide for 7.0.0-rc.2 - #20143

Open
ric-oliv wants to merge 7 commits into
masterfrom
docs/dotnet-7-migration-guide
Open

ric-oliv wants to merge 7 commits into
masterfrom
docs/dotnet-7-migration-guide

Conversation

@ric-oliv

@ric-oliv ric-oliv commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

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 says docs "MUST NOT go live before the SDK ships". The breaking changes playbook 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:

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:

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.

  • 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

Version 7 of the .NET SDK moves initialization out of the logging integrations, removes SentryOptions.EnableLogs, adds Sentry.Extensions.Hosting and raises the mobile and MAUI minimum to .NET 10. Upgraders need a guide with before and after code for each change while 7.0 is in release candidate.

Follows the Flutter v10 pattern: a full guide and an interactive checklist built from one include per change, plus an agent prompt. An alert at the top names the current release candidate and comes out at GA. The dotnet-v7 collection is registered in the MigrationGuide component and the migration item validator.

Refs NET-860

Refs getsentry/sentry-dotnet#5710

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the Priority: Urgent Docs review is needed immediately for an urgent deadline label Oct 21, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 21, 2026 16:32
@vercel

vercel Bot commented Oct 21, 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 28, 2026 10:51pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 28, 2026 10:51pm UTC

Request Review

@linear-code

linear-code Bot commented Oct 21, 2026

Copy link
Copy Markdown

NET-860

Comment thread includes/dotnet-v7-migration-overview.mdx Outdated
Comment thread includes/migration/dotnet-v7/supported-net-versions-and-platforms.mdx Outdated
Comment thread includes/dotnet-v7-migration-overview.mdx Outdated
Comment thread includes/dotnet-v7-migration-overview.mdx Outdated
Comment thread includes/dotnet-v7-migration-overview.mdx Outdated
Comment thread includes/migration/dotnet-v7/logging-integrations-no-longer-initialize-sentry.mdx Outdated
Comment thread includes/migration/dotnet-v7/ihub-is-registered-only-by-usesentry.mdx Outdated
Comment thread includes/migration/dotnet-v7/enablelogs-moves-to-host-options.mdx Outdated
Reword the overview, the supported .NET versions, the CS0619 errors and the IHub registration as suggested in review. The overview now says the Sentry.OpenTelemetry package as a whole is obsolete and will be removed, not only the span processor setup.

The suggestions go in with a typo fix, US spelling and one run-on sentence split in two. The OpenTelemetry paragraph keeps the AddSentry() and UseOpenTelemetry() names so readers can match it to the warning they get. The EnableLogs section is unchanged until the discussion on getsentry/sentry-dotnet#5755 settles where EnableLogs lives.

Refs NET-860

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getsentry/sentry-dotnet#5755 closed without moving the ILogger
integration out of UseSentry, so EnableLogs stays on the host options.
Logging.AddSentry() can now add Sentry's logger providers back after
ClearProviders(), and DecompressionMethods no longer includes Brotli.

Rewrite the EnableLogs section around what turns logs on in each kind
of app, update the ClearProviders and redundant AddSentry advice, and
add an item for the Brotli default. Sum up the Serilog, NLog and log4net
setups in the guide, so it doesn't depend on #19925 merging first. The
release candidate note lists the two places where rc.2 still differs.

Refs NET-860

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ric-oliv ric-oliv changed the title docs(dotnet): Add 6.x to 7.x migration guide docs(dotnet): Add 6.x to 7.x migration guide for 7.0.0-rc.2 Oct 28, 2026
@ric-oliv
ric-oliv marked this pull request as ready for review October 28, 2026 13:33
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 28, 2026 13:33
@cursor

cursor Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks new migration guide page loads, the JavaScript interactive checklist, the Flutter interactive checklist, and client TypeErrors. An issue escalates when the new pages stay empty while the current migration index still loads. An issue also escalates when a sibling interactive checklist shows errors or slower loads.

Services: sentry-docs.

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

Plan

What changed

Requests to the 6.x-to-7.x migration URLs now return a full guide and an interactive checklist. Those pages also render for every .NET guide except Xamarin. The shared checklist component now loads the dotnet-v7 collection. sentry-docs must deploy before this change is live. The shared component also compiles into develop-docs, but the new pages do not render there. The Vercel project name and docs.sentry.io path both match sentry-docs.

Risk

A wrong collection map or item filter can drop steps from the JavaScript or Flutter interactive checklist. A load failure in that shared component can throw client errors on MDX pages that share the component map. A bad include can fail static generation or serve a broken new page. The current .NET migration index can break if the new intro section is invalid.

Intended effect

The new HTML pages must record loads. Pre-deploy volume is zero because the routes do not exist yet. That zero is the baseline. absent means those paths stay at zero while /platforms/dotnet/migration/ still records loads. If the parent index also stays at zero, leave intended effect unknown. Guide URLs such as /platforms/dotnet/guides/aspnetcore/migration/v6-to-v7/ count as confirmed. /platforms/dotnet/guides/xamarin/migration/v6-to-v7/ must stay at zero.

Signal Baseline Window Rule Source
docs.page.load with path containing /platforms/dotnet/migration/v6-to-v7 0 loads 2026-10-21T13:34:00Z to 2026-10-28T13:34:00Z Rise above 0 Sentry project docs, environment production
Pageload and navigation spans with url.full containing /platforms/dotnet/migration/v6-to-v7 0 spans 2026-10-21T13:34:00Z to 2026-10-28T13:34:00Z Rise above 0 Sentry project docs, span.op:[pageload,navigation], environment production
docs.page.load for /platforms/dotnet/migration/ 4 loads in 24h. UTC days in the 7d window ranged 1-5 24h 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z. Daily buckets 2026-10-21 to 2026-10-28 Parent traffic must continue. Use it to decide unknown versus absent Sentry project docs, environment production

Regression watch

Watch the shared checklist on the JavaScript and Flutter guides. Watch the current .NET migration index. Watch client TypeErrors as the symptom-class signal. HTTP 5xx spans were 0 in the 24h window.

Signal Baseline Window Rule Source
docs.page.load for /platforms/javascript/migration/v10-to-v11/interactive/ 18 loads in 24h. UTC days in the 7d window ranged 2-13 24h 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z. Daily buckets 2026-10-21 to 2026-10-28 Hold in 2-13 loads per UTC day Sentry project docs, environment production
Pageload p95 on /platforms/javascript/migration/v10-to-v11/interactive/ 5873ms over 20 spans in 24h. 8383ms over 40 spans in 7d 24h 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z. 7d 2026-10-21T13:34:00Z to 2026-10-28T13:34:00Z Hold in 5500-8500ms Sentry project docs, span.op:[pageload,navigation], environment production
Errors on /platforms/javascript/migration/v10-to-v11/interactive 0 events 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z Hold at 0 Sentry project docs, environment production
Pageload p95 on /platforms/dart/guides/flutter/migration/v9-to-v10/ 4250ms over 20 spans in 24h. 6438ms over 100 spans in 7d 24h 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z. 7d 2026-10-21T13:34:00Z to 2026-10-28T13:34:00Z Hold in 4000-7000ms Sentry project docs, span.op:[pageload,navigation], environment production
Errors on /platforms/dart/guides/flutter/migration/ 0 events 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z Hold at 0 Sentry project docs, environment production
docs.page.load for /platforms/dotnet/migration/ 4 loads in 24h. UTC days ranged 1-5 24h 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z. Daily buckets 2026-10-21 to 2026-10-28 Hold in 1-5 loads per UTC day Sentry project docs, environment production
TypeError share of docs.page.load 75 TypeErrors over 19094 page loads, 0.39%. UTC day counts ranged 26-96 24h 2026-10-27T13:34:00Z to 2026-10-28T13:34:00Z. Daily counts 2026-10-21 to 2026-10-28 Hold the 24h share in 0.14-0.50%. Do not rise above 96 TypeErrors per UTC day Sentry project docs, environment production

These interactive pages are already slow. A p95 in the measured band is not a new fault. If the JavaScript or Flutter error count rises, inspect MigrationGuide and getMDXComponent frames.

Not observable

docs.md_export.not_found returned no values, so agent .md misses are not checkable. Checklist localStorage and the MAUI-only step have no telemetry. There is no pre-ship hit rate for the new URLs. The closest population is /platforms/dotnet/migration/, which was 4 of 19094 page loads in 24h.

An independent review against 7.0.0-rc.2 found that a 6.x Serilog or NLog
package left next to Sentry 7 usually fails silently. It adds fine, then
throws MissingMethodException on every entry, which the logging framework
swallows. The guide said the Serilog sink fails as soon as the app adds
it, which only happens with WriteTo.Sentry() and no arguments. A dsn in
Serilog's JSON configuration surfaces as a TargetInvocationException,
with the explanation in its inner exception.

rc.2 still accepts Brotli by default, so the release candidate note says
how to leave it out until the next release. The overview's logs bullet
also names Logging.AddSentry() after SentrySdk.Init, and says the
Sentry.OpenTelemetry setup has been obsolete since 6.12.0.

Refs NET-860

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

Copy link
Copy Markdown
Member Author

@jamescrosswell I've updated the guide, and the PR is now specific to rc.2. The note at the top lists where rc.2 still behaves differently from what the guide describes.

Since option 4 was dropped in getsentry/sentry-dotnet#5755, the EnableLogs section now follows your three points. There's also a new item for the Brotli default from getsentry/sentry-dotnet#5816, and the guide sums up the Serilog, NLog and log4net setups itself, so it can merge before #19925.

Mind taking another look?

Comment thread includes/dotnet-v7-migration-overview.mdx Outdated

<Include name="migration/dotnet-v7/hangfire-sends-recurring-job-schedules" />

## Removed and Internal APIs

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.

Are there going to be more subsections added here anytime soon? If not, I feel like the 'Removed and Internal APIs' header with the only subsection being 'Other Removed and Internal APIs' feels redundant.

@coolguyzone coolguyzone left a comment

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.

Looks good!

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>

This branch was successfully deployed

2 active (1 outdated) deployments
Preview – sentry-docs — 5a5e7e2f Deployed Oct 28, 2026 by vercel[bot]
Preview – develop-docs — 606b23ba Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Urgent Docs review is needed immediately for an urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants