docs(dotnet): Add metrics documentation for .NET by Flash0ver · Pull Request #16054 · getsentry/sentry-docs

Flash0ver · 2026-01-16T18:10:53Z

DESCRIBE YOUR PR

Add initial metrics documentation for the .NET SDK.
Based on the user docs for Python and JavaScript.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

Urgent deadline (GA date, etc.):
Other deadline: Release of Sentry for .NET 6.1.0. See also feat(metrics): Trace-connected Metrics (Implementation) sentry-dotnet#4834.
None: Not urgent, can wait up to 1 week+

SLA

Teamwork makes the dream work, so please add a reviewer to your PRs.
Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
Thanks in advance for your help!

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

Add comprehensive metrics documentation for .NET SDK including: - Main metrics page with overview and beta notice - Requirements section with SDK version and installation - Usage examples for Counter, Gauge, and Distribution metrics - Configuration options (EnableMetrics, SetBeforeSendMetric) - Default attributes documentation Based on Python and JavaScript metrics documentation structure. Co-Authored-By: Claude <[email protected]>

vercel · 2026-01-16T18:10:59Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
sentry-docs	Ready	Preview, Comment	Feb 4, 2026 6:52pm

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
develop-docs	Ignored	Preview	Feb 4, 2026 6:52pm

jamescrosswell · 2026-01-20T01:54:34Z

platform-includes/metrics/options/dotnet.mdx

+
+#### SetBeforeSendMetric<T>
+
+To filter metrics, or update them before they are sent to Sentry, you can use the `SetBeforeSendMetric<T>(Func<SentryMetric<T>, SentryMetric<T>?>)` option. If the callback returns `null`, the metric is not emitted. Attributes can also be updated in the callback delegate.


Need to decide what the API will look like before we can do the docs:

feat(metrics): Trace-connected Metrics (Implementation) sentry-dotnet#4834 (comment)

sfanahata · 2026-02-02T22:44:55Z

docs/platforms/dotnet/common/metrics/index.mdx

+
+## Options
+
+<PlatformContent includePath="metrics/options" />


@Flash0ver this include is not rendering. There might be something wrong with the formatting of the file itself? I can't quite tell. Can you take another look?

This might be the culprit: MDX is treating as JSX

Use SetBeforeSendMetric<T> (already in backticks but the heading line may not be)

Or escape: SetBeforeSendMetric<T>

Thanks for the review, @sfanahata.

We just implicitly fixed the issue:

-#### SetBeforeSendMetric<T> +#### SetBeforeSendMetric

As we've slightly overhauled the public API shape for a release this week,
we changed this method to be no longer generic.

Now all < and > characters are within code fences.

Fixed via 8279c73

sfanahata

Need to fix the bug failing /options/ from rendering in the index.

…elease

platform-includes/metrics/usage/dotnet.mdx

sfanahata · 2026-02-04T18:42:22Z

platform-includes/metrics/options/dotnet.mdx

+
+The metric object of type `SentryMetric` has the following members:
+
+| Member | Type | Description |


@Flash0ver - I updated this section to be a table. It was too hard to read in the other version. Can you take a quick look and make sure it's properly representing the intent?

splendid ... this is so much better ... thanks!

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

cursor · 2026-02-04T18:44:43Z

platform-includes/metrics/options/dotnet.mdx

+| `SetAttribute<TAttribute>(string key, TAttribute value)` | Method | Sets a key-value pair of data attached to the metric. Supported types are `string`, `bool`, integers up to a size of 64-bit signed, and floating-point numbers up to a size of 64-bit. |
+
+The numeric value of `SentryMetric` has the same numeric type that the metric was emitted with.
+The supported numeric types are `byte`, `short`, `int`, `long`, `float`, and `double`.


Duplicated numeric types text across two files

Low Severity

The exact text "The supported numeric types are byte, short, int, long, float, and double." appears verbatim in both usage/dotnet.mdx (line 6) and options/dotnet.mdx (lines 43-44). This duplication creates a maintenance burden if the supported types ever change.

True ... but to be fair, there is two parts of the API:

the "production" part via Emit, whose methods are all generic, dictating the type of the numeric value

the "consumption" part via BeforeSendMetric, which is a callback receiving/returning an instance of SentryMetric, which does not expose the Value directly, but through a "Try-Get-Value" method

We are not 100 % convinced that this is the best API shape, yet.
We are about to release this in v6.1.0 as an Experimental feature ... so we might be tweaking the API, and with that the documentation.
But for now, I'd like to be quite explicit ... and potentially duplicating.

And also ... I am quite sure that you will create a comment if future edits only update one part ... won't you 😉 ... and yes ... I am talking to a machine here right now ... it is getting late.

sentry · 2026-02-04T18:44:46Z

platform-includes/metrics/usage/dotnet.mdx

@@ -0,0 +1,42 @@
+Metrics are enabled by default. Once you initialize the SDK, you can send metrics using the `SentrySdk.Experimental.Metrics` APIs.
+
+The `SentryMetricEmitter` type exposes three method groups that you can use to capture different types of metric information: `Counter`, `Gauge`, and `Distribution`.


Bug: The documentation refers to the SentryMetricEmitter type, but code examples use SentrySdk.Experimental.Metrics, which is confusing and inconsistent with other SDKs.
_{Severity: MEDIUM}

Suggested Fix

Update the documentation to align the description with the code examples. Either state that metrics are sent via SentrySdk.Experimental.Metrics or clarify the relationship between SentrySdk.Experimental.Metrics and SentryMetricEmitter.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: platform-includes/metrics/usage/dotnet.mdx#L3 Potential issue: The documentation states that "The `SentryMetricEmitter` type exposes three method groups," but the code examples show calls to `SentrySdk.Experimental.Metrics.EmitCounter(...)`. This discrepancy is misleading because the type `SentryMetricEmitter` never appears in the example code. A developer following the text might search for `SentryMetricEmitter` and be unable to find it, or try to instantiate it, leading to confusion. This is inconsistent with other Sentry SDKs where the documented component name matches the code path used in examples.

But it is consistent with Logs for .NET:

sentry-docs/platform-includes/logs/usage/dotnet.mdx

Lines 3 to 5 in 5685ebd

Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the `SentrySdk.Logger` APIs.

The `SentryStructuredLogger` type exposes six method groups that you can use to log messages at different log levels: `Trace`, `Debug`, `Info`, `Warning`, `Error`, and `Fatal`.

And the type name is indeed SentryMetricEmitter.
And the SDK-API (SentrySdk.Experimental.Metrics) is mentioned just the line above.

sfanahata

Looking good!

Flash0ver self-assigned this Jan 16, 2026

Flash0ver mentioned this pull request Jan 16, 2026

feat(metrics): Trace-connected Metrics (Implementation) getsentry/sentry-dotnet#4834

Open

codeowner-assignment bot requested a review from a team January 16, 2026 18:11

vercel bot deployed to Preview – sentry-docs January 16, 2026 18:18 View deployment

This was referenced Jan 16, 2026

docs(dotnet): update logs docs to .NET SDK v6 #16055

Merged

docs(metrics): remove unsupported set type #16056

Merged

docs(metrics): remove old metrics platform-includes #16058

Merged

Flash0ver changed the title ~~docs(dotnet): Add metrics documentation~~ docs(dotnet): Add metrics documentation for .NET Jan 16, 2026

ref(dotnet): increment Heading of Metric-Types for Usage

540b231

vercel bot deployed to Preview – sentry-docs January 16, 2026 21:01 View deployment

Flash0ver mentioned this pull request Jan 16, 2026

docs(metrics): align headings of Metrics usage #16059

Merged

6 tasks

Merge branch 'master' into docs/dotnet-metrics

dac218f

vercel bot deployed to Preview – develop-docs January 16, 2026 21:20 View deployment

vercel bot deployed to Preview – sentry-docs January 16, 2026 21:24 View deployment

Flash0ver marked this pull request as ready for review January 16, 2026 21:34

Flash0ver requested review from a team and jamescrosswell January 16, 2026 21:34

Flash0ver mentioned this pull request Jan 19, 2026

Metrics Docs getsentry/sentry-dotnet#4749

Open

jamescrosswell reviewed Jan 20, 2026

View reviewed changes

Flash0ver mentioned this pull request Jan 21, 2026

feat(onboarding): Metrics page for .NET platforms getsentry/sentry#106552

Draft

sfanahata reviewed Feb 2, 2026

View reviewed changes

sfanahata requested changes Feb 2, 2026

View reviewed changes

Flash0ver added 2 commits February 4, 2026 15:29

Merge branch 'master' into docs/dotnet-metrics

165dcad

ref(dotnet): update API shape for matching the initial experimental r…

8279c73

…elease

sentry bot reviewed Feb 4, 2026

View reviewed changes

platform-includes/metrics/usage/dotnet.mdx Outdated Show resolved Hide resolved

vercel bot deployed to Preview – sentry-docs February 4, 2026 15:01 View deployment

fix(dotnet): update renamed type name

05858fc

vercel bot deployed to Preview – sentry-docs February 4, 2026 15:30 View deployment

Flash0ver requested review from jamescrosswell and sfanahata February 4, 2026 15:31

Flash0ver mentioned this pull request Feb 4, 2026

docs(dotnet): Add dotnet to metrics getting started #16262

Open

6 tasks

updating options to be in a table

5685ebd

sfanahata reviewed Feb 4, 2026

View reviewed changes

cursor bot reviewed Feb 4, 2026

View reviewed changes

sentry bot reviewed Feb 4, 2026

View reviewed changes

vercel bot deployed to Preview – sentry-docs February 4, 2026 18:52 View deployment

sfanahata approved these changes Feb 4, 2026

View reviewed changes


		#### SetBeforeSendMetric<T>

		To filter metrics, or update them before they are sent to Sentry, you can use the `SetBeforeSendMetric<T>(Func<SentryMetric<T>, SentryMetric<T>?>)` option. If the callback returns `null`, the metric is not emitted. Attributes can also be updated in the callback delegate.


		The metric object of type `SentryMetric` has the following members:

		\| Member \| Type \| Description \|

		@@ -0,0 +1,42 @@
		Metrics are enabled by default. Once you initialize the SDK, you can send metrics using the `SentrySdk.Experimental.Metrics` APIs.

		The `SentryMetricEmitter` type exposes three method groups that you can use to capture different types of metric information: `Counter`, `Gauge`, and `Distribution`.

	Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the `SentrySdk.Logger` APIs.

	The `SentryStructuredLogger` type exposes six method groups that you can use to log messages at different log levels: `Trace`, `Debug`, `Info`, `Warning`, `Error`, and `Fatal`.

Uh oh!

Conversation

Flash0ver commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

Uh oh!

vercel bot commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jamescrosswell Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

sfanahata Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Flash0ver Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

sfanahata left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sfanahata Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Flash0ver Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Feb 4, 2026

Choose a reason for hiding this comment

Duplicated numeric types text across two files

Uh oh!

Flash0ver Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

sentry bot Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Flash0ver Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

sfanahata left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Flash0ver commented Jan 16, 2026 •

edited

Loading

vercel bot commented Jan 16, 2026 •

edited

Loading

Flash0ver Feb 4, 2026 •

edited

Loading