Skip to content

fix(dotnet): Document EnableMetrics as obsolete and ignored - #19818

Merged
ric-oliv merged 1 commit into
masterfrom
fix/dotnet-enablemetrics-obsolete
Oct 6, 2026
Merged

ric-oliv merged 1 commit into
masterfrom
fix/dotnet-enablemetrics-obsolete

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The .NET metrics options say that setting EnableMetrics to false disables the SentrySdk.Metrics APIs. That stopped being true in 6.10.0 (getsentry/sentry-dotnet#5509). The option is now [Obsolete], its getter always returns true, and its setter does nothing (SentryOptions.cs L640–657 @ 6.12.0). Users who follow the current docs to opt out still send every metric.

This updates the description to say the option is ignored and points to SetBeforeSendMetric (returning null) as the way to drop metrics. That matches the SDK's own obsolete message.

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 Ivana Kellyer.

--

View Junior Session [Sentry]

Co-Authored-By: Ivana Kellyer <ivana.kellyer@sentry.io>
@vercel

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

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 6, 2026
@sentrivana
sentrivana marked this pull request as ready for review October 6, 2026 07:36
@sentrivana
sentrivana requested a review from ric-oliv October 6, 2026 07:36
@cursor

cursor Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

The change updates one docs page. The plan cannot confirm the new wording from telemetry.
The plan checks client errors on the changed page and on sibling pages.
An issue escalates when new client errors appear on the changed page.

Rollout complete

Services: sentry-docs.

Plan

What changed

The .NET metrics options page now says EnableMetrics is obsolete and ignored since 6.10.0.
Metrics sent through SentrySdk.Metrics still send when EnableMetrics is false.
Use SetBeforeSendMetric and return null to drop metrics.
This change is live after sentry-docs deploys to production.
The text ships on /platforms/dotnet/metrics/ and on each /platforms/dotnet/guides/*/metrics/ copy.

Risk

Readers may think they turned metrics off when the SDK still sends them.
A broken MDX include can fail render of the .NET metrics docs page.
The same include also feeds the .NET guide metrics pages.
Other platform option files did not change.

Intended effect

This is a docs wording change. Connected telemetry has no signal for the new sentence.
confirmed would mean the live page shows that EnableMetrics is obsolete and ignored.
absent would mean the live page still says to set EnableMetrics to false to disable the APIs.
Sentry does not store page copy, so the executor cannot fill this axis from telemetry.

Regression watch

A bad render of this include would show first as client errors on the .NET metrics URLs.
Sibling .NET docs URLs already emit a small known error set. Watch that set so a shared page-render break is not missed.

Signal Baseline Window Source Rule
Client errors on URLs that contain /platforms/dotnet/metrics 0 events 2026-10-05T07:37:00Z to 2026-10-06T07:37:22Z Sentry org sentry, project docs, environment production. Query: environment:production AND (transaction:*platforms/dotnet/metrics* OR url:*platforms/dotnet/metrics*) Hold at 0. Escalate if any error event appears.
Client errors on URLs that contain /platforms/dotnet 7 events 2026-10-05T07:37:00Z to 2026-10-06T07:37:22Z Sentry org sentry, project docs, environment production. Query: environment:production AND (transaction:"*/platforms/dotnet*" OR url:"*/platforms/dotnet*") The 24h count was 7. Known titles are DOCS-9E9 and DOCS-B5T. A small move of those two titles may be noise. Treat a new title or a clear rise above 7 as a regression.

Not observable

Whether the live HTML contains the new EnableMetrics sentence. Sentry does not store page copy.
Pageload count, p95 duration, and HTTP failure rate for /platforms/dotnet/metrics/. A traces query for those spans returned 0 in the same window. Client traces sample at 0.3, so volume on this path may stay hidden.

@ric-oliv
ric-oliv merged commit 5e28dad into master Oct 6, 2026
27 checks passed
@ric-oliv
ric-oliv deleted the fix/dotnet-enablemetrics-obsolete branch October 6, 2026 08:02
@cursor

cursor Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The live .NET metrics pages show the new EnableMetrics obsolete text.

solnic pushed a commit that referenced this pull request Oct 8, 2026
## DESCRIBE YOUR PR

The .NET metrics options say that setting `EnableMetrics` to `false`
disables the `SentrySdk.Metrics` APIs. That stopped being true in 6.10.0
([getsentry/sentry-dotnet#5509](getsentry/sentry-dotnet#5509)).
The option is now `[Obsolete]`, its getter always returns `true`, and
its setter does nothing ([`SentryOptions.cs` L640–657 @
6.12.0](https://github.com/getsentry/sentry-dotnet/blob/6.12.0/src/Sentry/SentryOptions.cs#L640-L657)).
Users who follow the current docs to opt out still send every metric.

This updates the description to say the option is ignored and points to
`SetBeforeSendMetric` (returning `null`) as the way to drop metrics.
That matches the SDK's own obsolete message.

## 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 **Ivana Kellyer**.
<!-- junior-request-attribution:end -->

<!-- junior-session-footer:start -->
<!--
junior-conversation-id:agent-dispatch%3Adispatch_629c1689a0364da29b4e432b70cfeadb
-->

--

[View Junior
Session](https://junior-prod.sentry.dev/conversations/agent-dispatch%3Adispatch_629c1689a0364da29b4e432b70cfeadb)
[[Sentry]](https://sentry.sentry.io/explore/conversations/agent-dispatch%3Adispatch_629c1689a0364da29b4e432b70cfeadb/?project=4510944073809921)

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

Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
Co-authored-by: Ivana Kellyer <ivana.kellyer@sentry.io>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — c956488c 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.

1 participant