Repository navigation
feat(docs): Apply new quick start template to .NET quick start guides - #19990
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
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 Services: Mention PlanWhat changedRequests 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. RiskA 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 effectThe rewrite adds no new success counter. Reachability of the new template is the check. Confirm
Regression watchA 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.
Not observableOnboarding 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.
…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>
- 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
|
Just one last thing: The PR description still describes the earlier version. Could you update these points to match the changes?
Could you also add the other changes from this round to "Fixes along the way"? Those are the |
…#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>
#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>
|
Verified in
|
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.
___PRODUCT_OPTION___markers.SentrySdk.Loggerworks without an extra option. Guides whose logging integrations need it (ASP.NET Core, AWS Lambda, Azure Functions Worker, Blazor WebAssembly, MAUI) includeEnableLogs = true. Xamarin and Google Cloud Functions have no Send Logs step because the Logs docs mark them as unsupported.Sentry.Xamarindepends on Sentry 4.x, which doesn't have the current metrics API, so the Metrics page now lists Xamarin as not supported.getting-started-verify/dotnet*.mdxsnippets are unchanged because other .NET guides (Serilog, NLog, log4net, etc.) also render them.o.TracesSampleRateinside anoptions =>lambda (also broken onmaster); a few stale links and anchors on the Android and Apple guides; Google Cloud Functions'DiagnosticsLeveltypo (nowDiagnosticLevel) with the JSON wrapped in{}; metric attributes useDictionary<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?
PRE-MERGE CHECKLIST
via Junior system actor
event.--
View Junior Session [Sentry]