Merge pull request #5019 from getsentry/01-12-add_hint_to_metrics

adinauer · web-flow · commit 6f439acc6f41 · 2026-01-14T11:54:00.000+01:00
feat(metrics): [Trace Metrics 25] Add Hint to Metrics
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/DefaultAndroidEventProcessor.java b/sentry-android-core/src/main/java/io/sentry/android/core/DefaultAndroidEventProcessor.java
@@ -94,7 +94,8 @@ public DefaultAndroidEventProcessor(
   }
 
   @Override
-  public @Nullable SentryMetricsEvent process(@NotNull SentryMetricsEvent event) {
+  public @Nullable SentryMetricsEvent process(
+      final @NotNull SentryMetricsEvent event, final @NotNull Hint hint) {
     setDevice(event);
     setOs(event);
     return event;
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/DefaultAndroidEventProcessorTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/DefaultAndroidEventProcessorTest.kt
@@ -636,7 +636,8 @@ class DefaultAndroidEventProcessorTest {
           "42e6bd2a-c45e-414d-8066-ed5196fbc686",
           "counter",
           123.0,
-        )
+        ),
+        Hint(),
       )
 
     assertNotNull(processedEvent?.attributes?.get("device.brand"))
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/SessionTrackingIntegrationTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/SessionTrackingIntegrationTest.kt
@@ -194,7 +194,7 @@ class SessionTrackingIntegrationTest {
       TODO("Not yet implemented")
     }
 
-    override fun captureMetric(event: SentryMetricsEvent, scope: IScope?) {
+    override fun captureMetric(event: SentryMetricsEvent, scope: IScope?, hint: Hint?) {
       TODO("Not yet implemented")
     }
 
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -461,7 +461,7 @@ public abstract interface class io/sentry/EventProcessor {
 	public fun getOrder ()Ljava/lang/Long;
 	public fun process (Lio/sentry/SentryEvent;Lio/sentry/Hint;)Lio/sentry/SentryEvent;
 	public fun process (Lio/sentry/SentryLogEvent;)Lio/sentry/SentryLogEvent;
-	public fun process (Lio/sentry/SentryMetricsEvent;)Lio/sentry/SentryMetricsEvent;
+	public fun process (Lio/sentry/SentryMetricsEvent;Lio/sentry/Hint;)Lio/sentry/SentryMetricsEvent;
 	public fun process (Lio/sentry/SentryReplayEvent;Lio/sentry/Hint;)Lio/sentry/SentryReplayEvent;
 	public fun process (Lio/sentry/protocol/SentryTransaction;Lio/sentry/Hint;)Lio/sentry/protocol/SentryTransaction;
 }
@@ -1048,7 +1048,7 @@ public abstract interface class io/sentry/ISentryClient {
 	public abstract fun captureLog (Lio/sentry/SentryLogEvent;Lio/sentry/IScope;)V
 	public fun captureMessage (Ljava/lang/String;Lio/sentry/SentryLevel;)Lio/sentry/protocol/SentryId;
 	public fun captureMessage (Ljava/lang/String;Lio/sentry/SentryLevel;Lio/sentry/IScope;)Lio/sentry/protocol/SentryId;
-	public abstract fun captureMetric (Lio/sentry/SentryMetricsEvent;Lio/sentry/IScope;)V
+	public abstract fun captureMetric (Lio/sentry/SentryMetricsEvent;Lio/sentry/IScope;Lio/sentry/Hint;)V
 	public abstract fun captureProfileChunk (Lio/sentry/ProfileChunk;Lio/sentry/IScope;)Lio/sentry/protocol/SentryId;
 	public abstract fun captureReplayEvent (Lio/sentry/SentryReplayEvent;Lio/sentry/IScope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
 	public fun captureSession (Lio/sentry/Session;)V
@@ -2863,7 +2863,7 @@ public final class io/sentry/SentryClient : io/sentry/ISentryClient {
 	public fun captureEvent (Lio/sentry/SentryEvent;Lio/sentry/IScope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
 	public fun captureFeedback (Lio/sentry/protocol/Feedback;Lio/sentry/Hint;Lio/sentry/IScope;)Lio/sentry/protocol/SentryId;
 	public fun captureLog (Lio/sentry/SentryLogEvent;Lio/sentry/IScope;)V
-	public fun captureMetric (Lio/sentry/SentryMetricsEvent;Lio/sentry/IScope;)V
+	public fun captureMetric (Lio/sentry/SentryMetricsEvent;Lio/sentry/IScope;Lio/sentry/Hint;)V
 	public fun captureProfileChunk (Lio/sentry/ProfileChunk;Lio/sentry/IScope;)Lio/sentry/protocol/SentryId;
 	public fun captureReplayEvent (Lio/sentry/SentryReplayEvent;Lio/sentry/IScope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
 	public fun captureSession (Lio/sentry/Session;Lio/sentry/Hint;)V
@@ -3769,7 +3769,7 @@ public final class io/sentry/SentryOptions$Metrics {
 }
 
 public abstract interface class io/sentry/SentryOptions$Metrics$BeforeSendMetricCallback {
-	public abstract fun execute (Lio/sentry/SentryMetricsEvent;)Lio/sentry/SentryMetricsEvent;
+	public abstract fun execute (Lio/sentry/SentryMetricsEvent;Lio/sentry/Hint;)Lio/sentry/SentryMetricsEvent;
 }
 
 public abstract interface class io/sentry/SentryOptions$OnDiscardCallback {
@@ -5284,9 +5284,11 @@ public final class io/sentry/metrics/SentryMetricsParameters {
 	public static fun create (Lio/sentry/SentryAttributes;)Lio/sentry/metrics/SentryMetricsParameters;
 	public static fun create (Lio/sentry/SentryDate;Lio/sentry/SentryAttributes;)Lio/sentry/metrics/SentryMetricsParameters;
 	public fun getAttributes ()Lio/sentry/SentryAttributes;
+	public fun getHint ()Lio/sentry/Hint;
 	public fun getOrigin ()Ljava/lang/String;
 	public fun getTimestamp ()Lio/sentry/SentryDate;
 	public fun setAttributes (Lio/sentry/SentryAttributes;)V
+	public fun setHint (Lio/sentry/Hint;)V
 	public fun setOrigin (Ljava/lang/String;)V
 	public fun setTimestamp (Lio/sentry/SentryDate;)V
 }
diff --git a/sentry/src/main/java/io/sentry/EventProcessor.java b/sentry/src/main/java/io/sentry/EventProcessor.java
@@ -63,7 +63,7 @@ default SentryLogEvent process(@NotNull SentryLogEvent event) {
    * @return the event itself, a mutated SentryMetricsEvent or null
    */
   @Nullable
-  default SentryMetricsEvent process(@NotNull SentryMetricsEvent event) {
+  default SentryMetricsEvent process(@NotNull SentryMetricsEvent event, @NotNull Hint hint) {
     return event;
   }
 
diff --git a/sentry/src/main/java/io/sentry/ISentryClient.java b/sentry/src/main/java/io/sentry/ISentryClient.java
@@ -305,7 +305,8 @@ SentryId captureProfileChunk(
 
   void captureLog(@NotNull SentryLogEvent logEvent, @Nullable IScope scope);
 
-  void captureMetric(@NotNull SentryMetricsEvent logEvent, @Nullable IScope scope);
+  void captureMetric(
+      @NotNull SentryMetricsEvent logEvent, @Nullable IScope scope, @Nullable Hint hint);
 
   @ApiStatus.Internal
   void captureBatchedLogEvents(@NotNull SentryLogEvents logEvents);
diff --git a/sentry/src/main/java/io/sentry/NoOpSentryClient.java b/sentry/src/main/java/io/sentry/NoOpSentryClient.java
@@ -89,7 +89,8 @@ public void captureLog(@NotNull SentryLogEvent logEvent, @Nullable IScope scope)
   }
 
   @Override
-  public void captureMetric(@NotNull SentryMetricsEvent metricsEvent, @Nullable IScope scope) {
+  public void captureMetric(
+      @NotNull SentryMetricsEvent metricsEvent, @Nullable IScope scope, @Nullable Hint hint) {
     // do nothing
   }
 
diff --git a/sentry/src/main/java/io/sentry/SentryClient.java b/sentry/src/main/java/io/sentry/SentryClient.java
@@ -517,10 +517,12 @@ private SentryLogEvent processLogEvent(
 
   @Nullable
   private SentryMetricsEvent processMetricsEvent(
-      @NotNull SentryMetricsEvent event, final @NotNull List<EventProcessor> eventProcessors) {
+      @NotNull SentryMetricsEvent event,
+      final @NotNull List<EventProcessor> eventProcessors,
+      final @NotNull Hint hint) {
     for (final EventProcessor processor : eventProcessors) {
       try {
-        event = processor.process(event);
+        event = processor.process(event, hint);
       } catch (Throwable e) {
         options
             .getLogger()
@@ -1278,23 +1280,30 @@ public void captureBatchedLogEvents(final @NotNull SentryLogEvents logEvents) {
 
   @ApiStatus.Experimental
   @Override
-  public void captureMetric(@Nullable SentryMetricsEvent metricsEvent, @Nullable IScope scope) {
+  public void captureMetric(
+      @Nullable SentryMetricsEvent metricsEvent,
+      final @Nullable IScope scope,
+      @Nullable Hint hint) {
+    if (hint == null) {
+      hint = new Hint();
+    }
+
     if (metricsEvent != null && scope != null) {
-      metricsEvent = processMetricsEvent(metricsEvent, scope.getEventProcessors());
+      metricsEvent = processMetricsEvent(metricsEvent, scope.getEventProcessors(), hint);
       if (metricsEvent == null) {
         return;
       }
     }
 
     if (metricsEvent != null) {
-      metricsEvent = processMetricsEvent(metricsEvent, options.getEventProcessors());
+      metricsEvent = processMetricsEvent(metricsEvent, options.getEventProcessors(), hint);
       if (metricsEvent == null) {
         return;
       }
     }
 
     if (metricsEvent != null) {
-      metricsEvent = executeBeforeSendMetric(metricsEvent);
+      metricsEvent = executeBeforeSendMetric(metricsEvent, hint);
 
       if (metricsEvent == null) {
         options
@@ -1625,12 +1634,13 @@ private void sortBreadcrumbsByDate(
     return event;
   }
 
-  private @Nullable SentryMetricsEvent executeBeforeSendMetric(@NotNull SentryMetricsEvent event) {
+  private @Nullable SentryMetricsEvent executeBeforeSendMetric(
+      @NotNull SentryMetricsEvent event, final @NotNull Hint hint) {
     final SentryOptions.Metrics.BeforeSendMetricCallback beforeSendMetric =
         options.getMetrics().getBeforeSend();
     if (beforeSendMetric != null) {
       try {
-        event = beforeSendMetric.execute(event);
+        event = beforeSendMetric.execute(event, hint);
       } catch (Throwable e) {
         options
             .getLogger()
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -3813,7 +3813,8 @@ public interface BeforeSendMetricCallback {
        * @return the original metric, mutated metric or null if metric was dropped
        */
       @Nullable
-      SentryMetricsEvent execute(final @NotNull SentryMetricsEvent metric);
+      SentryMetricsEvent execute(
+          final @NotNull SentryMetricsEvent metric, final @NotNull Hint hint);
     }
   }
 
diff --git a/sentry/src/main/java/io/sentry/metrics/MetricsApi.java b/sentry/src/main/java/io/sentry/metrics/MetricsApi.java
@@ -158,7 +158,7 @@ private void captureMetrics(
       metricsEvent.setUnit(unit);
       metricsEvent.setAttributes(createAttributes(params));
 
-      scopes.getClient().captureMetric(metricsEvent, combinedScope);
+      scopes.getClient().captureMetric(metricsEvent, combinedScope, params.getHint());
     } catch (Throwable e) {
       options.getLogger().log(SentryLevel.ERROR, "Error while capturing log event", e);
     }
diff --git a/sentry/src/main/java/io/sentry/metrics/SentryMetricsParameters.java b/sentry/src/main/java/io/sentry/metrics/SentryMetricsParameters.java
@@ -1,5 +1,6 @@
 package io.sentry.metrics;
 
+import io.sentry.Hint;
 import io.sentry.SentryAttributes;
 import io.sentry.SentryDate;
 import org.jetbrains.annotations.NotNull;
@@ -11,6 +12,8 @@ public final class SentryMetricsParameters {
   private @Nullable SentryAttributes attributes;
   private @NotNull String origin = "manual";
 
+  private @Nullable Hint hint = null;
+
   public @Nullable SentryDate getTimestamp() {
     return timestamp;
   }
@@ -35,6 +38,14 @@ public void setOrigin(final @NotNull String origin) {
     this.origin = origin;
   }
 
+  public @Nullable Hint getHint() {
+    return hint;
+  }
+
+  public void setHint(final @Nullable Hint hint) {
+    this.hint = hint;
+  }
+
   public static @NotNull SentryMetricsParameters create(
       final @Nullable SentryDate timestamp, final @Nullable SentryAttributes attributes) {
     final @NotNull SentryMetricsParameters params = new SentryMetricsParameters();
diff --git a/sentry/src/test/java/io/sentry/ScopesTest.kt b/sentry/src/test/java/io/sentry/ScopesTest.kt
diff --git a/sentry/src/test/java/io/sentry/SentryClientTest.kt b/sentry/src/test/java/io/sentry/SentryClientTest.kt

Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,8 @@ public DefaultAndroidEventProcessor(`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`@Override`
`97`		`- public @Nullable SentryMetricsEvent process(@NotNull SentryMetricsEvent event) {`
	`97`	`+ public @Nullable SentryMetricsEvent process(`
	`98`	`+ final @NotNull SentryMetricsEvent event, final @NotNull Hint hint) {`
`98`	`99`	`setDevice(event);`
`99`	`100`	`setOs(event);`
`100`	`101`	`return event;`
Original file line number	Diff line number	Diff line change
`@@ -636,7 +636,8 @@ class DefaultAndroidEventProcessorTest {`
`636`	`636`	`"42e6bd2a-c45e-414d-8066-ed5196fbc686",`
`637`	`637`	`"counter",`
`638`	`638`	`123.0,`
`639`		`- )`
	`639`	`+ ),`
	`640`	`+ Hint(),`
`640`	`641`	`)`
`641`	`642`
`642`	`643`	`assertNotNull(processedEvent?.attributes?.get("device.brand"))`
Original file line number	Diff line number	Diff line change
`@@ -194,7 +194,7 @@ class SessionTrackingIntegrationTest {`
`194`	`194`	`TODO("Not yet implemented")`
`195`	`195`	`}`
`196`	`196`
`197`		`- override fun captureMetric(event: SentryMetricsEvent, scope: IScope?) {`
	`197`	`+ override fun captureMetric(event: SentryMetricsEvent, scope: IScope?, hint: Hint?) {`
`198`	`198`	`TODO("Not yet implemented")`
`199`	`199`	`}`
`200`	`200`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ default SentryLogEvent process(@NotNull SentryLogEvent event) {`
`63`	`63`	`* @return the event itself, a mutated SentryMetricsEvent or null`
`64`	`64`	`*/`
`65`	`65`	`@Nullable`
`66`		`- default SentryMetricsEvent process(@NotNull SentryMetricsEvent event) {`
	`66`	`+ default SentryMetricsEvent process(@NotNull SentryMetricsEvent event, @NotNull Hint hint) {`
`67`	`67`	`return event;`
`68`	`68`	`}`
`69`	`69`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,8 @@ public void captureLog(@NotNull SentryLogEvent logEvent, @Nullable IScope scope)`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`@Override`
`92`		`- public void captureMetric(@NotNull SentryMetricsEvent metricsEvent, @Nullable IScope scope) {`
	`92`	`+ public void captureMetric(`
	`93`	`+ @NotNull SentryMetricsEvent metricsEvent, @Nullable IScope scope, @Nullable Hint hint) {`
`93`	`94`	`// do nothing`
`94`	`95`	`}`
`95`	`96`
Original file line number	Diff line number	Diff line change
`@@ -3813,7 +3813,8 @@ public interface BeforeSendMetricCallback {`
`3813`	`3813`	`* @return the original metric, mutated metric or null if metric was dropped`
`3814`	`3814`	`*/`
`3815`	`3815`	`@Nullable`
`3816`		`- SentryMetricsEvent execute(final @NotNull SentryMetricsEvent metric);`
	`3816`	`+ SentryMetricsEvent execute(`
	`3817`	`+ final @NotNull SentryMetricsEvent metric, final @NotNull Hint hint);`
`3817`	`3818`	`}`
`3818`	`3819`	`}`
`3819`	`3820`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ private void captureMetrics(`
`158`	`158`	`metricsEvent.setUnit(unit);`
`159`	`159`	`metricsEvent.setAttributes(createAttributes(params));`
`160`	`160`
`161`		`- scopes.getClient().captureMetric(metricsEvent, combinedScope);`
	`161`	`+ scopes.getClient().captureMetric(metricsEvent, combinedScope, params.getHint());`
`162`	`162`	`} catch (Throwable e) {`
`163`	`163`	`options.getLogger().log(SentryLevel.ERROR, "Error while capturing log event", e);`
`164`	`164`	`}`