Metrics Support - alpha

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Experimental pre-release availability of Delightful Developer Metrics. We're exploring the use of Metrics in Sentry. The API will very likely change and we don't yet have any documentation. ([#2949](https://github.com/getsentry/sentry-dotnet/pull/2949))
+
 ### Fixes
 
 - Stop Sentry for MacCatalyst from creating `default.profraw` in the app bundle using xcodebuild archive to build sentry-cocoa ([#2960](https://github.com/getsentry/sentry-dotnet/pull/2960))

samples/Sentry.Samples.AspNetCore.Basic/Program.cs

@@ -15,11 +15,12 @@ public static IWebHost BuildWebHost(string[] args) =>
             .UseSentry(o =>
             {
                 // A DSN is required.  You can set it here, or in configuration, or in an environment variable.
-                o.Dsn = "https://eb18e953812b41c3aeb042e666fd3b5c@o447951.ingest.sentry.io/5428537";
+                o.Dsn = "https://b887218a80114d26a9b1a51c5f88e0b4@o447951.ingest.sentry.io/6601807";
 
                 // Enable Sentry performance monitoring
                 o.EnableTracing = true;
 
+                o.ExperimentalMetrics = new ExperimentalMetricsOptions(){ MetricSampleRate = 1.0 };
 #if DEBUG
                 // Log debug information about the Sentry SDK
                 o.Debug = true;
@@ -35,6 +36,11 @@ public static IWebHost BuildWebHost(string[] args) =>
                 // exception when serving a request to path: /throw
                 app.UseEndpoints(endpoints =>
                 {
+                    endpoints.MapGet("/hello", () =>
+                    {
+                        SentrySdk.Metrics.Increment("hello.world");
+                        return "Hello World!";
+                    });
                     // Reported events will be grouped by route pattern
                     endpoints.MapGet("/throw/{message?}", context =>
                     {

src/Sentry/DelegatingMetricAggregator.cs

@@ -0,0 +1,19 @@
+namespace Sentry;
+
+internal class DelegatingMetricAggregator(IMetricAggregator innerAggregator) : IMetricAggregator
+{
+    public void Increment(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null) => innerAggregator.Increment(key, value, unit, tags, timestamp);
+
+    public void Gauge(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null) => innerAggregator.Gauge(key, value, unit, tags, timestamp);
+
+    public void Distribution(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null) => innerAggregator.Distribution(key, value, unit, tags, timestamp);
+
+    public void Set(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null) => innerAggregator.Set(key, value, unit, tags, timestamp);
+
+    public void Timing(string key, double value, MeasurementUnit.Duration unit = MeasurementUnit.Duration.Second, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null) => innerAggregator.Timing(key, value, unit, tags, timestamp);
+}

src/Sentry/DisabledMetricAggregator.cs

@@ -0,0 +1,34 @@
+namespace Sentry;
+
+internal class DisabledMetricAggregator : IMetricAggregator
+{
+    public void Increment(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null)
+    {
+        // No Op
+    }
+
+    public void Gauge(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null)
+    {
+        // No Op
+    }
+
+    public void Distribution(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null)
+    {
+        // No Op
+    }
+
+    public void Set(string key, double value = 1, MeasurementUnit? unit = null, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null)
+    {
+        // No Op
+    }
+
+    public void Timing(string key, double value, MeasurementUnit.Duration unit = MeasurementUnit.Duration.Second, IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null)
+    {
+        // No Op
+    }
+}

src/Sentry/Extensibility/DisabledHub.cs

@@ -174,6 +174,11 @@ public void CaptureSession(SessionUpdate sessionUpdate)
     /// </summary>
     public Task FlushAsync(TimeSpan timeout) => Task.CompletedTask;
 
+    /// <summary>
+    /// Disabled Metrics Aggregator (all methods are no-op).
+    /// </summary>
+    public IMetricAggregator Metrics { get; } = new DisabledMetricAggregator();
+
     /// <summary>
     /// No-Op.
     /// </summary>

src/Sentry/Extensibility/HubAdapter.cs

@@ -271,6 +271,10 @@ public void CaptureSession(SessionUpdate sessionUpdate)
     public Task FlushAsync(TimeSpan timeout)
         => SentrySdk.FlushAsync(timeout);
 
+    /// <inheritdoc cref="IMetricAggregator"/>
+    public IMetricAggregator Metrics
+        => SentrySdk.Metrics;
+
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>
     /// </summary>

src/Sentry/IMetricAggregator.cs

@@ -0,0 +1,103 @@
+namespace Sentry;
+
+/// <summary>
+/// Exposes EXPERIMENTAL capability to emit metrics. This API is subject to change without major version bumps so use
+/// with caution. We advise disabling in production at the moment.
+/// </summary>
+public interface IMetricAggregator
+{
+    /// <summary>
+    /// Emits a Counter metric
+    /// </summary>
+    /// <param name="key">A unique key identifying the metric</param>
+    /// <param name="value">The value to be added</param>
+    /// <param name="unit">An optional <see cref="MeasurementUnit"/></param>
+    /// <param name="tags">Optional Tags to associate with the metric</param>
+    /// <param name="timestamp">
+    /// The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.
+    /// </param>
+    void Increment(
+        string key,
+        double value = 1.0,
+        MeasurementUnit? unit = null,
+        IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null
+        // , int stacklevel = 0 // Used for code locations
+    );
+
+    /// <summary>
+    /// Emits a Gauge metric
+    /// </summary>
+    /// <param name="key">A unique key identifying the metric</param>
+    /// <param name="value">The value to be added</param>
+    /// <param name="unit">An optional <see cref="MeasurementUnit"/></param>
+    /// <param name="tags">Optional Tags to associate with the metric</param>
+    /// <param name="timestamp">
+    /// The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.
+    /// </param>
+    void Gauge(
+        string key,
+        double value = 1.0,
+        MeasurementUnit? unit = null,
+        IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null
+        // , int stacklevel = 0 // Used for code locations
+    );
+
+    /// <summary>
+    /// Emits a Distribution metric
+    /// </summary>
+    /// <param name="key">A unique key identifying the metric</param>
+    /// <param name="value">The value to be added</param>
+    /// <param name="unit">An optional <see cref="MeasurementUnit"/></param>
+    /// <param name="tags">Optional Tags to associate with the metric</param>
+    /// <param name="timestamp">
+    /// The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.
+    /// </param>
+    void Distribution(
+        string key,
+        double value = 1.0,
+        MeasurementUnit? unit = null,
+        IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null
+        // , int stacklevel = 0 // Used for code locations
+    );
+
+    /// <summary>
+    /// Emits a Set metric
+    /// </summary>
+    /// <param name="key">A unique key identifying the metric</param>
+    /// <param name="value">The value to be added</param>
+    /// <param name="unit">An optional <see cref="MeasurementUnit"/></param>
+    /// <param name="tags">Optional Tags to associate with the metric</param>
+    /// <param name="timestamp">
+    /// The time when the metric was emitted. Defaults to the time at which the metric is emitted, if no value is provided.
+    /// </param>
+    void Set(
+        string key,
+        double value = 1.0,
+        MeasurementUnit? unit = null,
+        IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null
+        // , int stacklevel = 0 // Used for code locations
+    );
+
+    /// <summary>
+    /// Emits a distribution with the time it takes to run a given code block.
+    /// </summary>
+    /// <param name="key">A unique key identifying the metric</param>
+    /// <param name="value">The value to be added</param>
+    /// <param name="unit">
+    /// An optional <see cref="MeasurementUnit.Duration"/>. Defaults to <see cref="MeasurementUnit.Duration.Second"/>
+    /// </param>
+    /// <param name="tags">Optional Tags to associate with the metric</param>
+    /// <param name="timestamp">The time when the metric was emitted</param>
+    void Timing(
+        string key,
+        double value,
+        MeasurementUnit.Duration unit = MeasurementUnit.Duration.Second,
+        IDictionary<string, string>? tags = null,
+        DateTime? timestamp = null
+        // , int stacklevel = 0 // Used for code locations
+    );
+}

src/Sentry/ISentryClient.cs

@@ -68,4 +68,9 @@ public interface ISentryClient
     /// <param name="timeout">The amount of time allowed for flushing.</param>
     /// <returns>A task to await for the flush operation.</returns>
     Task FlushAsync(TimeSpan timeout);
+
+    /// <summary>
+    /// <inheritdoc cref="IMetricAggregator"/>
+    /// </summary>
+    IMetricAggregator Metrics { get; }
 }

src/Sentry/Internal/Hub.cs

@@ -2,6 +2,7 @@
 using Sentry.Infrastructure;
 using Sentry.Integrations;
 using Sentry.Internal.ScopeStack;
+using Sentry.Protocol.Metrics;
 
 namespace Sentry.Internal;
 
@@ -22,6 +23,9 @@ internal class Hub : IHub, IDisposable
 
     internal IInternalScopeManager ScopeManager { get; }
 
+    /// <inheritdoc cref="IMetricAggregator"/>
+    public IMetricAggregator Metrics { get; }
+
     private int _isEnabled = 1;
     public bool IsEnabled => _isEnabled == 1;
 
@@ -58,6 +62,8 @@ internal Hub(
             PushScope();
         }
 
+        Metrics = new DelegatingMetricAggregator(_ownedClient.Metrics);
+
         foreach (var integration in options.Integrations)
         {
             options.LogDebug("Registering integration: '{0}'.", integration.GetType().Name);

src/Sentry/MeasurementUnit.cs

@@ -93,4 +93,4 @@ internal static MeasurementUnit Parse(string? name)
     /// Returns true if the operands are not equal.
     /// </summary>
     public static bool operator !=(MeasurementUnit left, MeasurementUnit right) => !left.Equals(right);
-}
+}