feat(metrics): Trace Metrics

sentry-android-core/src/test/java/io/sentry/android/core/SessionTrackingIntegrationTest.kt

@@ -18,6 +18,8 @@ import io.sentry.SentryEnvelope
 import io.sentry.SentryEvent
 import io.sentry.SentryLogEvent
 import io.sentry.SentryLogEvents
+import io.sentry.SentryMetricsEvent
+import io.sentry.SentryMetricsEvents
 import io.sentry.SentryReplayEvent
 import io.sentry.Session
 import io.sentry.TraceContext
@@ -192,6 +194,14 @@ class SessionTrackingIntegrationTest {
       TODO("Not yet implemented")
     }
 
+    override fun captureMetric(event: SentryMetricsEvent, scope: IScope?) {
+      TODO("Not yet implemented")
+    }
+
+    override fun captureBatchedMetricsEvents(metricsEvents: SentryMetricsEvents) {
+      TODO("Not yet implemented")
+    }
+
     override fun getRateLimiter(): RateLimiter? {
       TODO("Not yet implemented")
     }

sentry/api/sentry.api

@@ -461,6 +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/SentryReplayEvent;Lio/sentry/Hint;)Lio/sentry/SentryReplayEvent;
 	public fun process (Lio/sentry/protocol/SentryTransaction;Lio/sentry/Hint;)Lio/sentry/protocol/SentryTransaction;
 }
@@ -661,6 +662,7 @@ public final class io/sentry/HubAdapter : io/sentry/IHub {
 	public fun isHealthy ()Z
 	public fun logger ()Lio/sentry/logger/ILoggerApi;
 	public fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public fun popScope ()V
 	public fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -732,6 +734,7 @@ public final class io/sentry/HubScopesWrapper : io/sentry/IHub {
 	public fun isHealthy ()Z
 	public fun logger ()Lio/sentry/logger/ILoggerApi;
 	public fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public fun popScope ()V
 	public fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -992,6 +995,7 @@ public abstract interface class io/sentry/IScopes {
 	public fun isNoOp ()Z
 	public abstract fun logger ()Lio/sentry/logger/ILoggerApi;
 	public abstract fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public abstract fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public abstract fun popScope ()V
 	public abstract fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public abstract fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -1026,6 +1030,7 @@ public abstract interface class io/sentry/IScopesStorage {
 
 public abstract interface class io/sentry/ISentryClient {
 	public abstract fun captureBatchedLogEvents (Lio/sentry/SentryLogEvents;)V
+	public abstract fun captureBatchedMetricsEvents (Lio/sentry/SentryMetricsEvents;)V
 	public abstract fun captureCheckIn (Lio/sentry/CheckIn;Lio/sentry/IScope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
 	public fun captureEnvelope (Lio/sentry/SentryEnvelope;)Lio/sentry/protocol/SentryId;
 	public abstract fun captureEnvelope (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
@@ -1041,6 +1046,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 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
@@ -1565,6 +1571,7 @@ public final class io/sentry/NoOpHub : io/sentry/IHub {
 	public fun isNoOp ()Z
 	public fun logger ()Lio/sentry/logger/ILoggerApi;
 	public fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public fun popScope ()V
 	public fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -1741,6 +1748,7 @@ public final class io/sentry/NoOpScopes : io/sentry/IScopes {
 	public fun isNoOp ()Z
 	public fun logger ()Lio/sentry/logger/ILoggerApi;
 	public fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public fun popScope ()V
 	public fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -2456,6 +2464,7 @@ public final class io/sentry/Scopes : io/sentry/IScopes {
 	public fun isHealthy ()Z
 	public fun logger ()Lio/sentry/logger/ILoggerApi;
 	public fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public fun popScope ()V
 	public fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -2528,6 +2537,7 @@ public final class io/sentry/ScopesAdapter : io/sentry/IScopes {
 	public fun isHealthy ()Z
 	public fun logger ()Lio/sentry/logger/ILoggerApi;
 	public fun makeCurrent ()Lio/sentry/ISentryLifecycleToken;
+	public fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public fun popScope ()V
 	public fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -2648,6 +2658,7 @@ public final class io/sentry/Sentry {
 	public static fun isEnabled ()Z
 	public static fun isHealthy ()Z
 	public static fun logger ()Lio/sentry/logger/ILoggerApi;
+	public static fun metrics ()Lio/sentry/metrics/IMetricsApi;
 	public static fun popScope ()V
 	public static fun pushIsolationScope ()Lio/sentry/ISentryLifecycleToken;
 	public static fun pushScope ()Lio/sentry/ISentryLifecycleToken;
@@ -2844,11 +2855,13 @@ public final class io/sentry/SentryBaseEvent$Serializer {
 public final class io/sentry/SentryClient : io/sentry/ISentryClient {
 	public fun <init> (Lio/sentry/SentryOptions;)V
 	public fun captureBatchedLogEvents (Lio/sentry/SentryLogEvents;)V
+	public fun captureBatchedMetricsEvents (Lio/sentry/SentryMetricsEvents;)V
 	public fun captureCheckIn (Lio/sentry/CheckIn;Lio/sentry/IScope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
 	public fun captureEnvelope (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)Lio/sentry/protocol/SentryId;
 	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 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
@@ -2930,6 +2943,7 @@ public final class io/sentry/SentryEnvelopeItem {
 	public static fun fromClientReport (Lio/sentry/ISerializer;Lio/sentry/clientreport/ClientReport;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromEvent (Lio/sentry/ISerializer;Lio/sentry/SentryBaseEvent;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromLogs (Lio/sentry/ISerializer;Lio/sentry/SentryLogEvents;)Lio/sentry/SentryEnvelopeItem;
+	public static fun fromMetrics (Lio/sentry/ISerializer;Lio/sentry/SentryMetricsEvents;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromProfileChunk (Lio/sentry/ProfileChunk;Lio/sentry/ISerializer;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromProfileChunk (Lio/sentry/ProfileChunk;Lio/sentry/ISerializer;Lio/sentry/IProfileConverter;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromProfilingTrace (Lio/sentry/ProfilingTraceData;JLio/sentry/ISerializer;)Lio/sentry/SentryEnvelopeItem;
@@ -3314,6 +3328,66 @@ public final class io/sentry/SentryLongDate : io/sentry/SentryDate {
 	public fun nanoTimestamp ()J
 }
 
+public final class io/sentry/SentryMetricsEvent : io/sentry/JsonSerializable, io/sentry/JsonUnknown {
+	public fun <init> (Lio/sentry/protocol/SentryId;Lio/sentry/SentryDate;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;)V
+	public fun <init> (Lio/sentry/protocol/SentryId;Ljava/lang/Double;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;)V
+	public fun getAttributes ()Ljava/util/Map;
+	public fun getName ()Ljava/lang/String;
+	public fun getSpanId ()Lio/sentry/SpanId;
+	public fun getTimestamp ()Ljava/lang/Double;
+	public fun getType ()Ljava/lang/String;
+	public fun getUnit ()Ljava/lang/String;
+	public fun getUnknown ()Ljava/util/Map;
+	public fun getValue ()Ljava/lang/Double;
+	public fun serialize (Lio/sentry/ObjectWriter;Lio/sentry/ILogger;)V
+	public fun setAttribute (Ljava/lang/String;Lio/sentry/SentryLogEventAttributeValue;)V
+	public fun setAttributes (Ljava/util/Map;)V
+	public fun setName (Ljava/lang/String;)V
+	public fun setSpanId (Lio/sentry/SpanId;)V
+	public fun setTimestamp (Ljava/lang/Double;)V
+	public fun setType (Ljava/lang/String;)V
+	public fun setUnit (Ljava/lang/String;)V
+	public fun setUnknown (Ljava/util/Map;)V
+	public fun setValue (Ljava/lang/Double;)V
+}
+
+public final class io/sentry/SentryMetricsEvent$Deserializer : io/sentry/JsonDeserializer {
+	public fun <init> ()V
+	public fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Lio/sentry/SentryMetricsEvent;
+	public synthetic fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Ljava/lang/Object;
+}
+
+public final class io/sentry/SentryMetricsEvent$JsonKeys {
+	public static final field ATTRIBUTES Ljava/lang/String;
+	public static final field NAME Ljava/lang/String;
+	public static final field SPAN_ID Ljava/lang/String;
+	public static final field TIMESTAMP Ljava/lang/String;
+	public static final field TRACE_ID Ljava/lang/String;
+	public static final field TYPE Ljava/lang/String;
+	public static final field UNIT Ljava/lang/String;
+	public static final field VALUE Ljava/lang/String;
+	public fun <init> ()V
+}
+
+public final class io/sentry/SentryMetricsEvents : io/sentry/JsonSerializable, io/sentry/JsonUnknown {
+	public fun <init> (Ljava/util/List;)V
+	public fun getItems ()Ljava/util/List;
+	public fun getUnknown ()Ljava/util/Map;
+	public fun serialize (Lio/sentry/ObjectWriter;Lio/sentry/ILogger;)V
+	public fun setUnknown (Ljava/util/Map;)V
+}
+
+public final class io/sentry/SentryMetricsEvents$Deserializer : io/sentry/JsonDeserializer {
+	public fun <init> ()V
+	public fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Lio/sentry/SentryMetricsEvents;
+	public synthetic fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Ljava/lang/Object;
+}
+
+public final class io/sentry/SentryMetricsEvents$JsonKeys {
+	public static final field ITEMS Ljava/lang/String;
+	public fun <init> ()V
+}
+
 public final class io/sentry/SentryNanotimeDate : io/sentry/SentryDate {
 	public fun <init> ()V
 	public fun <init> (Ljava/util/Date;J)V
@@ -3420,6 +3494,7 @@ public class io/sentry/SentryOptions {
 	public fun getMaxRequestBodySize ()Lio/sentry/SentryOptions$RequestSize;
 	public fun getMaxSpans ()I
 	public fun getMaxTraceFileSize ()J
+	public fun getMetrics ()Lio/sentry/SentryOptions$Metrics;
 	public fun getModulesLoader ()Lio/sentry/internal/modules/IModulesLoader;
 	public fun getOnDiscard ()Lio/sentry/SentryOptions$OnDiscardCallback;
 	public fun getOnOversizedEvent ()Lio/sentry/SentryOptions$OnOversizedEventCallback;
@@ -3572,6 +3647,7 @@ public class io/sentry/SentryOptions {
 	public fun setMaxRequestBodySize (Lio/sentry/SentryOptions$RequestSize;)V
 	public fun setMaxSpans (I)V
 	public fun setMaxTraceFileSize (J)V
+	public fun setMetrics (Lio/sentry/SentryOptions$Metrics;)V
 	public fun setModulesLoader (Lio/sentry/internal/modules/IModulesLoader;)V
 	public fun setOnDiscard (Lio/sentry/SentryOptions$OnDiscardCallback;)V
 	public fun setOnOversizedEvent (Lio/sentry/SentryOptions$OnOversizedEventCallback;)V
@@ -3626,10 +3702,6 @@ public abstract interface class io/sentry/SentryOptions$BeforeBreadcrumbCallback
 	public abstract fun execute (Lio/sentry/Breadcrumb;Lio/sentry/Hint;)Lio/sentry/Breadcrumb;
 }
 
-public abstract interface class io/sentry/SentryOptions$BeforeEmitMetricCallback {
-	public abstract fun execute (Ljava/lang/String;Ljava/util/Map;)Z
-}
-
 public abstract interface class io/sentry/SentryOptions$BeforeEnvelopeCallback {
 	public abstract fun execute (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)V
 }
@@ -3683,6 +3755,20 @@ public abstract interface class io/sentry/SentryOptions$Logs$BeforeSendLogCallba
 	public abstract fun execute (Lio/sentry/SentryLogEvent;)Lio/sentry/SentryLogEvent;
 }
 
+public final class io/sentry/SentryOptions$Metrics {
+	public fun <init> ()V
+	public fun getBeforeSend ()Lio/sentry/SentryOptions$Metrics$BeforeSendMetricCallback;
+	public fun getMetricsBatchProcessorFactory ()Lio/sentry/metrics/IMetricsBatchProcessorFactory;
+	public fun isEnabled ()Z
+	public fun setBeforeSend (Lio/sentry/SentryOptions$Metrics$BeforeSendMetricCallback;)V
+	public fun setEnabled (Z)V
+	public fun setMetricsBatchProcessorFactory (Lio/sentry/metrics/IMetricsBatchProcessorFactory;)V
+}
+
+public abstract interface class io/sentry/SentryOptions$Metrics$BeforeSendMetricCallback {
+	public abstract fun execute (Lio/sentry/SentryMetricsEvent;)Lio/sentry/SentryMetricsEvent;
+}
+
 public abstract interface class io/sentry/SentryOptions$OnDiscardCallback {
 	public abstract fun execute (Lio/sentry/clientreport/DiscardReason;Lio/sentry/DataCategory;Ljava/lang/Long;)V
 }
@@ -5113,6 +5199,53 @@ public final class io/sentry/logger/SentryLogParameters {
 	public fun setTimestamp (Lio/sentry/SentryDate;)V
 }
 
+public final class io/sentry/metrics/DefaultMetricsBatchProcessorFactory : io/sentry/metrics/IMetricsBatchProcessorFactory {
+	public fun <init> ()V
+	public fun create (Lio/sentry/SentryOptions;Lio/sentry/SentryClient;)Lio/sentry/metrics/IMetricsBatchProcessor;
+}
+
+public abstract interface class io/sentry/metrics/IMetricsApi {
+	public abstract fun count (Ljava/lang/String;)V
+}
+
+public abstract interface class io/sentry/metrics/IMetricsBatchProcessor {
+	public abstract fun add (Lio/sentry/SentryMetricsEvent;)V
+	public abstract fun close (Z)V
+	public abstract fun flush (J)V
+}
+
+public abstract interface class io/sentry/metrics/IMetricsBatchProcessorFactory {
+	public abstract fun create (Lio/sentry/SentryOptions;Lio/sentry/SentryClient;)Lio/sentry/metrics/IMetricsBatchProcessor;
+}
+
+public final class io/sentry/metrics/MetricsApi : io/sentry/metrics/IMetricsApi {
+	public fun <init> (Lio/sentry/Scopes;)V
+	public fun count (Ljava/lang/String;)V
+}
+
+public class io/sentry/metrics/MetricsBatchProcessor : io/sentry/metrics/IMetricsBatchProcessor {
+	public static final field FLUSH_AFTER_MS I
+	public static final field MAX_BATCH_SIZE I
+	public static final field MAX_QUEUE_SIZE I
+	protected final field options Lio/sentry/SentryOptions;
+	public fun <init> (Lio/sentry/SentryOptions;Lio/sentry/ISentryClient;)V
+	public fun add (Lio/sentry/SentryMetricsEvent;)V
+	public fun close (Z)V
+	public fun flush (J)V
+}
+
+public final class io/sentry/metrics/NoOpMetricsApi : io/sentry/metrics/IMetricsApi {
+	public fun count (Ljava/lang/String;)V
+	public static fun getInstance ()Lio/sentry/metrics/NoOpMetricsApi;
+}
+
+public final class io/sentry/metrics/NoOpMetricsBatchProcessor : io/sentry/metrics/IMetricsBatchProcessor {
+	public fun add (Lio/sentry/SentryMetricsEvent;)V
+	public fun close (Z)V
+	public fun flush (J)V
+	public static fun getInstance ()Lio/sentry/metrics/NoOpMetricsBatchProcessor;
+}
+
 public final class io/sentry/opentelemetry/OpenTelemetryUtil {
 	public fun <init> ()V
 	public static fun applyIgnoredSpanOrigins (Lio/sentry/SentryOptions;)V

sentry/src/main/java/io/sentry/EventProcessor.java

@@ -56,6 +56,17 @@ default SentryLogEvent process(@NotNull SentryLogEvent event) {
     return event;
   }
 
+  /**
+   * May mutate or drop a SentryMetricsEvent
+   *
+   * @param event the SentryMetricsEvent
+   * @return the event itself, a mutated SentryMetricsEvent or null
+   */
+  @Nullable
+  default SentryMetricsEvent process(@NotNull SentryMetricsEvent event) {
+    return event;
+  }
+
   /**
    * Controls when this EventProcessor is invoked.
    *

sentry/src/main/java/io/sentry/HubAdapter.java

@@ -1,6 +1,7 @@
 package io.sentry;
 
 import io.sentry.logger.ILoggerApi;
+import io.sentry.metrics.IMetricsApi;
 import io.sentry.protocol.Feedback;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.SentryTransaction;
@@ -389,6 +390,11 @@ public void reportFullyDisplayed() {
     return Sentry.getCurrentScopes().logger();
   }
 
+  @Override
+  public @NotNull IMetricsApi metrics() {
+    return Sentry.getCurrentScopes().metrics();
+  }
+
   @Override
   public void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result) {
     Sentry.addFeatureFlag(flag, result);

sentry/src/main/java/io/sentry/HubScopesWrapper.java

@@ -1,6 +1,7 @@
 package io.sentry;
 
 import io.sentry.logger.ILoggerApi;
+import io.sentry.metrics.IMetricsApi;
 import io.sentry.protocol.Feedback;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.SentryTransaction;
@@ -374,6 +375,11 @@ public void reportFullyDisplayed() {
     return scopes.logger();
   }
 
+  @Override
+  public @NotNull IMetricsApi metrics() {
+    return scopes.metrics();
+  }
+
   @Override
   public void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result) {
     scopes.addFeatureFlag(flag, result);

sentry/src/main/java/io/sentry/IScopes.java

@@ -1,6 +1,7 @@
 package io.sentry;
 
 import io.sentry.logger.ILoggerApi;
+import io.sentry.metrics.IMetricsApi;
 import io.sentry.protocol.Feedback;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.SentryTransaction;
@@ -744,5 +745,8 @@ default boolean isNoOp() {
   @NotNull
   ILoggerApi logger();
 
+  @NotNull
+  IMetricsApi metrics();
+
   void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result);
 }

sentry/src/main/java/io/sentry/ISentryClient.java

@@ -305,9 +305,14 @@ SentryId captureProfileChunk(
 
   void captureLog(@NotNull SentryLogEvent logEvent, @Nullable IScope scope);
 
+  void captureMetric(@NotNull SentryMetricsEvent logEvent, @Nullable IScope scope);
+
   @ApiStatus.Internal
   void captureBatchedLogEvents(@NotNull SentryLogEvents logEvents);
 
+  @ApiStatus.Internal
+  void captureBatchedMetricsEvents(@NotNull SentryMetricsEvents metricsEvents);
+
   @ApiStatus.Internal
   @Nullable
   RateLimiter getRateLimiter();