# Set Up Metrics | Sentry for .NET for iOS, macOS, and Mac Catalyst

This feature is currently in open beta. Please reach out on [GitHub](https://github.com/getsentry/sentry/discussions/102275) if you have feedback or questions. Features in beta are still in-progress and may have bugs. We recognize the irony.

Sentry metrics help you pinpoint and solve issues that impact user experience and app performance by measuring the data points that are important to you. You can track things like processing time, event size, user signups, and conversion rates, then correlate them back to tracing data in order to get deeper insights and solve issues faster.

Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes.

## [Requirements](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#requirements)

Metrics for .NET are supported in Sentry .NET SDK version `6.1.0` and above.

## [Usage](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#usage)

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`.

All methods are generic, where the provided type argument defines the numeric value type that the metric is emitted with. The supported numeric types are `byte`, `short`, `int`, `long`, `float`, and `double`.

### [Emit a Counter](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#emit-a-counter)

Counters are one of the more basic types of metrics and can be used to count certain event occurrences.

To emit a counter, do the following:

```csharp
// Record five total button clicks
SentrySdk.Experimental.Metrics.EmitCounter("button_click", 5,
    [new KeyValuePair<string, object>("browser", "Firefox"), new KeyValuePair<string, object>("app_version", "1.0.0")]);
```

### [Emit a Distribution](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#emit-a-distribution)

Distributions help you get the most insights from your data by allowing you to obtain aggregations such as `p90`, `min`, `max`, and `avg`.

To emit a distribution, do the following:

```csharp
// Add '15.0' to a distribution used for tracking the loading times per page.
SentrySdk.Experimental.Metrics.EmitDistribution("page_load", 15.0, MeasurementUnit.Duration.Millisecond,
    [new KeyValuePair<string, object>("page", "/home")]);
```

### [Emit a Gauge](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#emit-a-gauge)

Gauges let you obtain aggregates like `min`, `max`, `avg`, `sum`, and `count`. They can be represented in a more space-efficient way than distributions, but they can't be used to get percentiles. If percentiles aren't important to you, we recommend using gauges.

To emit a gauge, do the following:

```csharp
// Add '15.0' to a gauge used for tracking the loading times for a page.
SentrySdk.Experimental.Metrics.EmitGauge("page_load", 15.0, MeasurementUnit.Duration.Millisecond,
    [new KeyValuePair<string, object>("page", "/home")]);
```

## [Options](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#options)

#### [EnableMetrics](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#enablemetrics)

Set to `false` in order to disable the `SentrySdk.Experimental.Metrics` APIs.

#### [SetBeforeSendMetric](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#setbeforesendmetric)

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

```csharp
SentrySdk.Init(options =>
{
    options.Dsn = "___PUBLIC_DSN___";
    options.Experimental.SetBeforeSendMetric(static metric =>
    {
        if (metric.Name == "removed-metric")
        {
            return null;
        }

        metric.SetAttribute("extra", "foo");

        return metric;
    });
});
```

The `beforeSendMetric` delegate receives a metric object, and should return the metric object if you want it to be sent to Sentry, or `null` if you want to discard it.

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

| Member                                                          | Type               | Description                                                                                                                                                                                               |
| --------------------------------------------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Timestamp`                                                     | `DateTimeOffset`   | Timestamp indicating when the metric was emitted.                                                                                                                                                         |
| `TraceId`                                                       | `SentryId`         | The trace ID of the trace this metric belongs to.                                                                                                                                                         |
| `Type`                                                          | `SentryMetricType` | The type of metric. One of `Counter`, `Gauge`, `Distribution`.                                                                                                                                            |
| `Name`                                                          | `string`           | The name of the metric.                                                                                                                                                                                   |
| `SpanId`                                                        | `SpanId?`          | The span ID of the span that was active when the metric was emitted.                                                                                                                                      |
| `Unit`                                                          | `string?`          | The unit of measurement for the metric value. Applies to `Gauge` and `Distribution` only.                                                                                                                 |
| `TryGetValue<TValue>(out TValue value)`                         | Method             | Gets the numeric value of the metric. Returns `true` if the metric value is of type `TValue`, otherwise `false`. Supported numeric value types are `byte`, `short`, `int`, `long`, `float`, and `double`. |
| `TryGetAttribute<TAttribute>(string key, out TAttribute value)` | Method             | Gets the attribute value associated with the specified key. Returns `true` if the metric contains an attribute with the specified key and its value is of type `TAttribute`, otherwise `false`.           |
| `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`.

## [Default Attributes](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#default-attributes)

The .NET SDK automatically sets several default attributes on all metrics to provide context and improve debugging:

### [Core Attributes](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#core-attributes)

* `environment`: The environment set in the SDK if defined. This is sent from the SDK as `sentry.environment`.
* `release`: The release set in the SDK if defined. This is sent from the SDK as `sentry.release`.
* `sdk.name`: The name of the SDK that sent the metric. This is sent from the SDK as `sentry.sdk.name`.
* `sdk.version`: The version of the SDK that sent the metric. This is sent from the SDK as `sentry.sdk.version`.

### [Server Attributes](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#server-attributes)

* `server.address`: The address of the server that sent the metric. Equivalent to `server_name` that gets attached to Sentry errors.

### [User Attributes](https://docs.sentry.io/platforms/dotnet/guides/apple/metrics.md#user-attributes)

If user information is available in the current scope, the following attributes are added to the metric:

* `user.id`: The user ID.
* `user.name`: The username.
* `user.email`: The email address.
