Repository navigation
fix(dotnet): Document EnableMetrics as obsolete and ignored - #19818
Conversation
Co-Authored-By: Ivana Kellyer <ivana.kellyer@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
The change updates one docs page. The plan cannot confirm the new wording from telemetry. Services: PlanWhat changedThe .NET metrics options page now says EnableMetrics is obsolete and ignored since 6.10.0. RiskReaders may think they turned metrics off when the SDK still sends them. Intended effectThis is a docs wording change. Connected telemetry has no signal for the new sentence. Regression watchA bad render of this include would show first as client errors on the .NET metrics URLs.
Not observableWhether the live HTML contains the new EnableMetrics sentence. Sentry does not store page copy. |
|
Verified in
|
## 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>
DESCRIBE YOUR PR
The .NET metrics options say that setting
EnableMetricstofalsedisables theSentrySdk.MetricsAPIs. That stopped being true in 6.10.0 (getsentry/sentry-dotnet#5509). The option is now[Obsolete], its getter always returnstrue, and its setter does nothing (SentryOptions.csL640–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(returningnull) as the way to drop metrics. That matches the SDK's own obsolete message.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via Ivana Kellyer.
--
View Junior Session [Sentry]