Metrics (Trace Connected) for .NET

[Flash0ver]

Sentry is introducing metrics that let you send counters, gauges, and distributions from your code to track things like email.sent, checkout.failed, or queue.depth — and pivot directly into the related traces, logs, and errors when something looks off.

TraceConnectedMetrics.mp4

Note

To get early access to the Sentry metrics product and to see how it works, see the announcement post.

To use the new Metric APIs to send metrics directly to Sentry, you'll have to upgrade to the latest pre-release 6.1.0-alpha.1 of the .NET SDK. The APIs are currently experimental.

Once the SDK is initialized, you can send metrics using the SentrySdk.Experimental.Metrics APIs.

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

SentrySdk.Experimental.Metrics.EmitCounter("checkout.failed", 1);
SentrySdk.Experimental.Metrics.EmitGauge("queue.depth", 42);
SentrySdk.Experimental.Metrics.EmitDistribution("cart.amount_usd", 187.5);

You can also pass additional attributes directly to EmitCounter, EmitGauge, and EmitDistribution via the attributes parameter.

SentrySdk.Experimental.Metrics.EmitCounter("checkout.failed", 1,
  [new KeyValuePair<string, object>("route", "/checkout"), new KeyValuePair<string,object>("tenant", "acme"), new KeyValuePair<string,object>("provider", "stripe")]);

You can also set a unit on the metric (Gauge and Distribution).

SentrySdk.Experimental.Metrics.EmitDistribution("http.request.duration", timeSpan.TotalSeconds,
  SentryUnits.Duration.Second,
  [new KeyValuePair<string, object>("http.request.method", HttpMethod.Get.Method), new KeyValuePair<string,object>("http.response.status_code", (int)HttpStatusCode.OK)]);

Currently allowed numeric value types of metrics:

• 64-bit signed integral types: byte, short, int, long
• 64-bit floating-point types: float, double

Currently allowed units (see also Units supported by Relay):

• Duration: nanosecond, microsecond, millisecond, second, minute, hour, day, week
• Information: bit, byte, kilobyte, kibibyte, megabyte, mebibyte, gigabyte, gibibyte, terabyte, tebibyte, petabyte, pebibyte, exabyte, exbibyte
• Fraction: ratio, percent

Documentation

• Metrics Docs #4749

Related Issues

• Sentry Metrics for .NET #4741