Set Up Metrics

Learn how to measure the data points you care about by configuring Metrics in your Unity project.

Sentry Metrics is currently in open beta, so be gentle - features are still in-progress and may have bugs. We recognize the irony. For any questions or feedback, you can reach us on Discord or GitHub.

Metrics for Unity are supported with Sentry Unity SDK version 2.0.0 and above.

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.

To enable metrics, opt in to the metrics feature:

Copied
public class SentryRuntimeConfiguration : SentryRuntimeOptionsConfiguration
{
    public override void Configure(SentryUnityOptions options)
    {
        // Initialize some (non null) ExperimentalMetricsOptions to enable Sentry Metrics,
        options.ExperimentalMetrics = new ExperimentalMetricsOptions { EnableCodeLocations = true };
    }
}

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:

Copied
// Incrementing a counter by one for each button click.
SentrySdk.Metrics.Increment("ButtonClicked",
    tags: new Dictionary<string, string> {{ "region", "us-west-1" }}
);

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:

Copied
// Adding '15' to a distribution used to track the loading time.
SentrySdk.Metrics.Distribution("LoadingTime",
    15,
    unit: MeasurementUnit.Duration.Millisecond,
    tags: new Dictionary<string, string> {{ "region", "us-west-1" }}
);

Sets are useful for looking at unique occurrences and counting the unique elements you added.

To emit a set, do the following:

Copied
// Adding a set of unique occurrences.
SentrySdk.Metrics.Set("UserView", "Rufus",
    unit: MeasurementUnit.Custom("username"),
    tags: new Dictionary<string, string> {{ "region", "us-west-1" }});

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:

Copied
// Adding '15' to a gauge used to track the loading time.
SentrySdk.Metrics.Gauge("LoadingTime",
    15,
    unit: MeasurementUnit.Duration.Millisecond,
    tags: new Dictionary<string, string> {{ "region", "us-west-1" }});

Timers can be used to measure the execution time of a specific block of code. They're implemented like distributions, but measured in seconds.

To emit a timer, do the following:

Copied
// Measure the time of execution within the using block
using (SentrySdk.Metrics.StartTimer("bingo"))
{
    // Your code goes here
}
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").