-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(Unity): Added Metrics #16356
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
feat(Unity): Added Metrics #16356
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: Set Up Metrics | ||
| sidebar_title: Metrics | ||
| description: "Metrics allow you to send, view and query counters, gauges and distributions from your Unity game to track application health and drill down into related traces, logs, and errors." | ||
| sidebar_order: 5700 | ||
| beta: true | ||
| --- | ||
|
|
||
| With Sentry Metrics, you can send counters, gauges, and distributions from your Unity game to Sentry. Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes. | ||
|
|
||
| <Alert> | ||
| This feature is currently in open beta. Features in beta are still in progress | ||
| and may have bugs. | ||
| </Alert> | ||
|
|
||
| ## Requirements | ||
|
|
||
| <PlatformContent includePath="metrics/requirements" /> | ||
|
|
||
| ## Setup | ||
|
|
||
| <PlatformContent includePath="metrics/setup" /> | ||
|
|
||
| ## Usage | ||
|
|
||
| <PlatformContent includePath="metrics/usage" /> | ||
|
|
||
| ## Options | ||
|
|
||
| <PlatformContent includePath="metrics/options" /> | ||
|
|
||
| ## Default Attributes | ||
|
|
||
| <PlatformContent includePath="metrics/default-attributes" /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| The Sentry SDK for Unity automatically sets several default attributes on all metrics to provide context and improve debugging: | ||
|
|
||
| <Include name="metrics/default-attributes/core" /> | ||
|
|
||
| <Include name="metrics/default-attributes/server" /> | ||
|
|
||
| <Include name="metrics/default-attributes/user" /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| #### EnableMetrics | ||
|
|
||
| Set to `false` in order to disable the `SentrySdk.Experimental.Metrics` APIs. | ||
|
|
||
| #### 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 | ||
| public override void Configure(SentryUnityOptions options) | ||
| { | ||
| options.Experimental.SetBeforeSendMetric(static metric => | ||
| { | ||
| if (metric.Name == "removed-metric") | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| metric.SetAttribute("extra", "foo"); | ||
|
|
||
| return metric; | ||
| }); | ||
| } | ||
| ``` | ||
|
|
||
| or if you're manually initializing the SDK: | ||
|
|
||
| ```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`, `char`, `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`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Metrics for Unity are supported in Sentry SDK version `4.1.0` and above. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| To enable metrics in your Unity game, you need to configure the Sentry SDK with metrics enabled. | ||
|
|
||
| ### Project Settings Configuration | ||
|
|
||
| 1. Inside the editor open: **Tools > Sentry > Advanced** | ||
| 2. Under the **Metrics** section, check the **Enable Metrics** option | ||
|
|
||
| ### Programmatic Configuration | ||
|
|
||
| Alternatively, you can enable metrics programmatically through the [configure callback](/platforms/unity/configuration/options/programmatic-configuration): | ||
|
|
||
| ```csharp | ||
| public override void Configure(SentryUnityOptions options) | ||
| { | ||
| options.Experimental.EnableMetrics = true; | ||
| } | ||
| ``` | ||
|
|
||
| or if you're manually initializing the SDK: | ||
|
|
||
| ```csharp | ||
| SentrySdk.Init(options => | ||
| { | ||
| options.Dsn = "___PUBLIC_DSN___"; | ||
|
|
||
| // Enable metrics to be sent to Sentry | ||
| options.Experimental.EnableMetrics = true; | ||
| }); | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. | ||
|
|
||
| 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 | ||
|
|
||
| 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 player interactions | ||
| SentrySdk.Experimental.Metrics.EmitCounter("player_interaction", 5, | ||
| new[] { new KeyValuePair<string, object>("scene", "MainMenu"), new KeyValuePair<string, object>("app_version", "1.0.0") }); | ||
| ``` | ||
|
|
||
| ### 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 scene. | ||
| SentrySdk.Experimental.Metrics.EmitDistribution("scene_load", 15.0, MeasurementUnit.Duration.Millisecond, | ||
| new[] { new KeyValuePair<string, object>("scene", "Level1") }); | ||
| ``` | ||
|
|
||
| ### 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 scene. | ||
| SentrySdk.Experimental.Metrics.EmitGauge("scene_load", 15.0, MeasurementUnit.Duration.Millisecond, | ||
| new[] { new KeyValuePair<string, object>("scene", "Level1") }); | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: The Unity metrics usage documentation incorrectly states that metrics are enabled by default, but the setup guide requires explicit enablement, leading to silent failures for users.
Severity: MEDIUM
Suggested Fix
In
platform-includes/metrics/usage/unity.mdx, change the first line from "Metrics are enabled by default. Once you initialize the SDK..." to "Once metrics are enabled, you can send metrics...". This removes the false claim and directs users to the setup guide implicitly.Prompt for AI Agent
Did we get this right? 👍 / 👎 to inform future reviews.