Skip to content

feat(docs): Apply new quick start template to .NET quick start guides - #19990

Merged
ric-oliv merged 7 commits into
masterfrom
docs/quickstart-template-dotnet
Oct 21, 2026
Merged

ric-oliv merged 7 commits into
masterfrom
docs/quickstart-template-dotnet

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the .NET landing page and 15 .NET guides: ASP.NET, ASP.NET Core, AWS Lambda, Azure Functions Worker, Blazor Server, Blazor WebAssembly, Entity Framework, MAUI, WinForms, WinUI, WPF, Xamarin, .NET for Android, .NET for Apple (iOS/Mac Catalyst), and Google Cloud Functions. All pages keep their single-column layout. The Serilog, NLog, log4net and Microsoft.Extensions.Logging pages are logging integration guides and are unchanged.

  • Removes the onboarding option checkboxes and ___PRODUCT_OPTION___ markers.
  • Configure names the features each guide sets up. The init snippets include all options by default, and a note explains that unwanted options can be removed.
  • Logs: SentrySdk.Logger works without an extra option. Guides whose logging integrations need it (ASP.NET Core, AWS Lambda, Azure Functions Worker, Blazor WebAssembly, MAUI) include EnableLogs = true. Xamarin and Google Cloud Functions have no Send Logs step because the Logs docs mark them as unsupported.
  • Application Metrics: enabled by default (SDK 6.1.0+); every guide except Xamarin has a Send Application Metrics step. Sentry.Xamarin depends on Sentry 4.x, which doesn't have the current metrics API, so the Metrics page now lists Xamarin as not supported.
  • Profiling: on the .NET for Apple guide, and as an optional step for .NET 8 and later on the .NET landing page, outside the default install and snippet. The docs mark it unsupported on Android and Google Cloud Functions.
  • Session Replay: named on .NET for Android and .NET for Apple, where it's documented.
  • Simplifies Verify. The shared getting-started-verify/dotnet*.mdx snippets are unchanged because other .NET guides (Serilog, NLog, log4net, etc.) also render them.
  • Fixes along the way: the AWS Lambda snippet used o.TracesSampleRate inside an options => lambda (also broken on master); a few stale links and anchors on the Android and Apple guides; Google Cloud Functions' DiagnosticsLevel typo (now DiagnosticLevel) with the JSON wrapped in {}; metric attributes use Dictionary<string, object> initializers so the snippets compile on .NET Framework (C# 7.3); every ASP.NET Core setup tab sets the DSN; and the Android guide keeps Session Replay text and image masking on.

IS YOUR CHANGE URGENT?

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

PRE-MERGE CHECKLIST

  • 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

via Junior system actor event.

--

View Junior Session [Sentry]

sentry-junior Bot and others added 2 commits October 14, 2026 22:11
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Unthrown exceptions passed to CaptureException carry no stack trace, and
these includes also render on .NET guides outside this change.

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 15, 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 21, 2026 7:34am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 21, 2026 7:34am UTC

Request Review

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 15, 2026 00:13
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 15, 2026
@cursor

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks page loads on the rewritten quick start URLs and the metrics page. It also checks 404s, client errors on those URLs, and server 5xx. An issue escalates when those page loads collapse or when 404s, client errors, or 5xx rise.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

Requests to the .NET landing page and fifteen framework guides now render a single-column quick start. The pages no longer show onboarding option checkboxes. Tracing, logs, metrics, profiling, and session replay snippets stay visible when that guide supports them. The .NET metrics page now lists Xamarin as not supported. Logging integration guides are unchanged. sentry-docs must deploy before this change is live. The deploy workflow maps the Vercel project sentry-docs to this catalog id.

Risk

A bad MDX compile can 404 or 500 these guides. Readers then cannot follow install steps. A client render failure on code tabs or new headings can throw on the same URLs. The Xamarin not-supported flag can hide metrics for the wrong platform. Child pages under those guides can lose traffic if the landing page fails.

Intended effect

The rewrite adds no new success counter. Reachability of the new template is the check. Confirm docs.page.load on the rewritten paths stays in the measured band. Absent: those paths fall toward zero while other platform pages still load. Twelve other rewritten guides had too few loads to set a band. Treat them as part of the 404 watch.

Signal Baseline Window Rule Source
docs.page.load on /platforms/dotnet/ 41-43 loads per 24h. Share of page_type:platforms loads is 0.39-0.44%. 2026-10-19T09:23:00Z to 2026-10-21T09:23:00Z. Last 24h was 41. Prior 24h was 43. Platform loads were 9315 then 11082. Hold in band. Confirmed if loads stay in band after deploy. Absent if this path falls toward zero while page_type:platforms holds. Sentry org sentry project docs. Metric docs.page.load. Query path:"/platforms/dotnet/".
docs.page.load on /platforms/dotnet/guides/aspnetcore/, /aspnet/, and /maui/ 36-46 loads per 24h across those three paths. Same 48h. Last 24h: aspnetcore 19, aspnet 17, maui 10. Prior 24h: 11, 10, 15. Hold in band. Absent if all three fall toward zero while other platform pages hold. Same metric. Query path:"/platforms/dotnet/guides/aspnetcore/" OR path:"/platforms/dotnet/guides/aspnet/" OR path:"/platforms/dotnet/guides/maui/".
docs.page.load on /platforms/dotnet/metrics/ 6-11 loads per 24h. Same 48h. Last 24h was 11. Prior 24h was 6. Hold in band. Absent if this path falls toward zero while the landing page holds. Same metric. Query path:"/platforms/dotnet/metrics/".

Regression watch

A compile miss on these files returns 404. A thrown render returns 5xx. A client exception shows on the same URLs. Watch those three symptoms. Also watch Serilog guide loads. This diff did not edit that page. Last 24h was 4. Prior 24h was 8. A drop with the rewritten pages is a shared-layout failure.

Signal Baseline Window Rule Source
docs.page.not_found for requested_path:platforms/dotnet 0-2 events per 24h against 9315-11082 platform page loads. 2026-10-19T09:23:00Z to 2026-10-21T09:23:00Z. Last 24h was 2. Prior 24h was 0. Hold at or below 2 per 24h. Detected if the count rises above 2 while rewritten page loads hold or fall. Sentry org sentry project docs. Metric docs.page.not_found. Query requested_path:platforms/dotnet.
Production errors with http.url:*platforms/dotnet* 1 event per 24h. Last 24h was one TypeError on xS. Same 48h. Last 24h was 1. Prior 24h was 1. Hold at or below 2 per 24h. Detected if the count rises above 2. If it rises, check titles for MDX or component frames. Sentry org sentry project docs. Errors query environment:production http.url:*platforms/dotnet*.
HTTP 5xx on transaction /:path*? 0 events per 24h. Same 48h. Last 24h was 0. Prior 24h was 0. Hold at 0. Detected if any 5xx appears. Then check whether the URL is a rewritten .NET guide. Sentry org sentry project docs. Spans query span.op:http.server http.response_status_code:>=500 http.response_status_code:<600 transaction:"/:path*?".

Not observable

Onboarding checkbox toggles go to Plausible, not Sentry. That drop cannot be confirmed here. Web vitals for these URLs did not return LCP values. The Apple and Google Cloud Functions guides had 0-1 loads in 48h, too sparse to use. Exact wording of the new headings has no telemetry. Session Replay masking on the Android snippet has no telemetry.

PlatformLink prefixes the current guide, so integration guide links
resolved under the wrong path, and EnableLogs lives on the Logs page
rather than a logs/options page.
sentry-junior Bot and others added 2 commits October 15, 2026 20:29
…d Google Cloud Functions quick start guides

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
…ns variable in .NET quick starts

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Resolve the Azure Functions Worker conflict with #19959 by keeping its
OTLP exporter setup (Sentry.OpenTelemetry.Exporter, AddSentryOtlpExporter,
UseOtlp) in the new quick start template.

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Comment thread docs/platforms/dotnet/guides/xamarin/index.mdx Outdated
Comment thread docs/platforms/dotnet/index.mdx Outdated
Comment thread docs/platforms/dotnet/guides/aspnet/index.mdx Outdated
Comment thread docs/platforms/dotnet/guides/entityframework/index.mdx Outdated
Comment thread docs/platforms/dotnet/guides/aspnetcore/index.mdx
Comment thread docs/platforms/dotnet/guides/android/index.mdx
Comment thread docs/platforms/dotnet/guides/aws-lambda/index.mdx Outdated
- Use Dictionary initializers for metric attributes so snippets compile on .NET Framework (C# 7.3)
- Drop metrics from the Xamarin guide and mark Metrics as not supported for Xamarin
- Make profiling an optional .NET 8+ Alpha step in the .NET quickstart
- Set the DSN in all ASP.NET Core setup tabs and remove duplicate appsettings options
- Keep Session Replay masking defaults in the Android guide
- Add Logs setup and example to the AWS Lambda guide
@ric-oliv

Copy link
Copy Markdown
Member

Just one last thing: The PR description still describes the earlier version. Could you update these points to match the changes?

  • Logs: AWS Lambda now has a Send Logs step, so it no longer belongs in the sentence about guides without one.
  • Application Metrics: Xamarin has no Send Application Metrics step anymore, and the Metrics page now lists it as not supported.
  • Profiling: The .NET landing page now has profiling as an optional step for .NET 8 and later, outside the default install and snippet.

Could you also add the other changes from this round to "Fixes along the way"? Those are the Dictionary initializers for metric attributes, the DSN in every ASP.NET Core tab, and the Android guide keeping Session Replay masking on.

@ric-oliv
ric-oliv merged commit 8654e16 into master Oct 21, 2026
27 checks passed
@ric-oliv
ric-oliv deleted the docs/quickstart-template-dotnet branch October 21, 2026 09:23
inventarSarah pushed a commit that referenced this pull request Oct 21, 2026
…#19990)

## DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the .NET landing
page and 15 .NET guides: ASP.NET, ASP.NET Core, AWS Lambda, Azure
Functions Worker, Blazor Server, Blazor WebAssembly, Entity Framework,
MAUI, WinForms, WinUI, WPF, Xamarin, .NET for Android, .NET for Apple
(iOS/Mac Catalyst), and Google Cloud Functions. All pages keep their
single-column layout. The Serilog, NLog, log4net and
Microsoft.Extensions.Logging pages are logging integration guides and
are unchanged.

- Removes the onboarding option checkboxes and `___PRODUCT_OPTION___`
markers.
- Configure names the features each guide sets up. The init snippets
include all options by default, and a note explains that unwanted
options can be removed.
- **Logs:** `SentrySdk.Logger` works without an extra option. Guides
whose logging integrations need it (ASP.NET Core, AWS Lambda, Azure
Functions Worker, Blazor WebAssembly, MAUI) include `EnableLogs = true`.
Xamarin and Google Cloud Functions have no Send Logs step because the
Logs docs mark them as unsupported.
- **Application Metrics:** enabled by default (SDK 6.1.0+); every guide
except Xamarin has a Send Application Metrics step. `Sentry.Xamarin`
depends on Sentry 4.x, which doesn't have the current metrics API, so
the Metrics page now lists Xamarin as not supported.
- **Profiling:** on the .NET for Apple guide, and as an optional step
for .NET 8 and later on the .NET landing page, outside the default
install and snippet. The docs mark it unsupported on Android and Google
Cloud Functions.
- **Session Replay:** named on .NET for Android and .NET for Apple,
where it's documented.
- Simplifies Verify. The shared `getting-started-verify/dotnet*.mdx`
snippets are unchanged because other .NET guides (Serilog, NLog,
log4net, etc.) also render them.
- Fixes along the way: the AWS Lambda snippet used `o.TracesSampleRate`
inside an `options =>` lambda (also broken on `master`); a few stale
links and anchors on the Android and Apple guides; Google Cloud
Functions' `DiagnosticsLevel` typo (now `DiagnosticLevel`) with the JSON
wrapped in `{}`; metric attributes use `Dictionary<string, object>`
initializers so the snippets compile on .NET Framework (C# 7.3); every
ASP.NET Core setup tab sets the DSN; and the Android guide keeps Session
Replay text and image masking on.

## IS YOUR CHANGE URGENT?

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

## PRE-MERGE CHECKLIST

- [ ] 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)

<!-- junior-request-attribution:start -->
via Junior system actor `event`.
<!-- junior-request-attribution:end -->

<!-- junior-session-footer:start -->
<!-- junior-conversation-id:slack%3AD0BB8KQT6MU%3A1792013336.218129 -->

--

[View Junior
Session](https://junior-prod.sentry.dev/conversations/slack%3AD0BB8KQT6MU%3A1792013336.218129)
[[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AD0BB8KQT6MU%3A1792013336.218129/?project=4510944073809921)

<!-- junior-session-footer:end -->

---------

Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
Co-authored-by: Shannon Anahata <shannon.anahata@sentry.io>
jamescrosswell added a commit that referenced this pull request Oct 21, 2026
#19990 moved the .NET guides to the new quick start template. Apply
the 7.0 changes to the new Azure Functions and Blazor WebAssembly
pages, and remove EnableLogs from SentrySdk.Init on the classic
ASP.NET page, which #19990 added. Also drop the Dsn that #19990 set on
the NLog target in the set-tag snippet: 7.0 removes it.

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

cursor Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • Rewritten .NET guides kept loading for 24 hours.

This branch was successfully deployed

2 active (1 outdated) deployments
Preview – sentry-docs — c74a6377 Deployed Oct 21, 2026 by vercel[bot]
Preview – develop-docs — 57291cb2 Deployed Oct 15, 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