feat(metrics): Add implementation for metrics envelope item

Author: philprime

Sentry.xcodeproj/project.pbxproj

@@ -784,6 +784,8 @@
 		D468C0622D3669A200964230 /* SentryFileIOTracker+SwiftHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = D468C0612D3669A200964230 /* SentryFileIOTracker+SwiftHelpers.swift */; };
 		D46B041D2EDF168400AF4A0A /* MetricsIntegration.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46B041C2EDF167D00AF4A0A /* MetricsIntegration.swift */; };
 		D46B04202EDF175C00AF4A0A /* MetricsIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46B041F2EDF175600AF4A0A /* MetricsIntegrationTests.swift */; };
+		D46B04482EDF25E100AF4A0A /* SentryMetric.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46B04472EDF25E100AF4A0A /* SentryMetric.swift */; };
+		D46B044F2EDF260A00AF4A0A /* SentryMetricBatcher.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46B044E2EDF260A00AF4A0A /* SentryMetricBatcher.swift */; };
 		D473ACD72D8090FC000F1CC6 /* FileManager+SentryTracing.swift in Sources */ = {isa = PBXBuildFile; fileRef = D473ACD62D8090FC000F1CC6 /* FileManager+SentryTracing.swift */; };
 		D480F9D92DE47A50009A0594 /* TestSentryScopePersistentStore.swift in Sources */ = {isa = PBXBuildFile; fileRef = D480F9D82DE47A48009A0594 /* TestSentryScopePersistentStore.swift */; };
 		D480F9DB2DE47AF2009A0594 /* SentryScopePersistentStoreTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D480F9DA2DE47AEB009A0594 /* SentryScopePersistentStoreTests.swift */; };
@@ -2147,6 +2149,8 @@
 		D468C0612D3669A200964230 /* SentryFileIOTracker+SwiftHelpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryFileIOTracker+SwiftHelpers.swift"; sourceTree = "<group>"; };
 		D46B041C2EDF167D00AF4A0A /* MetricsIntegration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsIntegration.swift; sourceTree = "<group>"; };
 		D46B041F2EDF175600AF4A0A /* MetricsIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsIntegrationTests.swift; sourceTree = "<group>"; };
+		D46B04472EDF25E100AF4A0A /* SentryMetric.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryMetric.swift; sourceTree = "<group>"; };
+		D46B044E2EDF260A00AF4A0A /* SentryMetricBatcher.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryMetricBatcher.swift; sourceTree = "<group>"; };
 		D46D45E12D5F3FD600A1CB35 /* Sentry_Base.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = Sentry_Base.xctestplan; sourceTree = "<group>"; };
 		D46D45E92D5F411700A1CB35 /* SentrySwiftUI_Base.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; name = SentrySwiftUI_Base.xctestplan; path = Plans/SentrySwiftUI_Base.xctestplan; sourceTree = SOURCE_ROOT; };
 		D473ACD62D8090FC000F1CC6 /* FileManager+SentryTracing.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "FileManager+SentryTracing.swift"; sourceTree = "<group>"; };
@@ -4645,6 +4649,7 @@
 				FA01BCB12E69352A00968DFA /* SentryDiscardedEvent.swift */,
 				92235CAD2E15549C00865983 /* SentryLogger.swift */,
 				92235CAB2E15369900865983 /* SentryLogBatcher.swift */,
+				D46B044E2EDF260A00AF4A0A /* SentryMetricBatcher.swift */,
 				F451FAA52E0B304E0050ACF2 /* LoadValidator.swift */,
 				FA34C1A22E692A5000BC52AA /* SentryEnvelopeItem.swift */,
 				FA90FAFC2E070A3B008CAAE8 /* SentryURLRequestFactory.swift */,
@@ -4870,6 +4875,7 @@
 				92ECD73F2E05AD500063EC10 /* SentryLogAttribute.swift */,
 				92ECD73D2E05AD2B0063EC10 /* SentryLogLevel.swift */,
 				9264E1EA2E2E385B00B077CF /* SentryLogMessage.swift */,
+				D46B04472EDF25E100AF4A0A /* SentryMetric.swift */,
 				F458D1122E180BB00028273E /* SentryFileManagerProtocol.swift */,
 			);
 			path = Protocol;
@@ -5803,8 +5809,10 @@
 				D8ACE3C82762187200F5A213 /* SentryFileIOTrackerHelper.m in Sources */,
 				D8B088B729C9E3FF00213258 /* SentryTracerConfiguration.m in Sources */,
 				FA7206E12E0B37C80072FDD4 /* SentryProfileCollector.mm in Sources */,
+				D46B044F2EDF260A00AF4A0A /* SentryMetricBatcher.swift in Sources */,
 				9264E1EB2E2E385E00B077CF /* SentryLogMessage.swift in Sources */,
 				8ECC674A25C23A20000E2BF6 /* SentryTransactionContext.m in Sources */,
+				D46B04482EDF25E100AF4A0A /* SentryMetric.swift in Sources */,
 				03BCC38C27E1C01A003232C7 /* SentryTime.mm in Sources */,
 				A8F17B342902870300990B25 /* SentryHttpStatusCodeRange.m in Sources */,
 				62C97D3A2CC64E6B00DDA204 /* SentryUncaughtNSExceptions.m in Sources */,

SentryTestUtils/Sources/TestClient.swift

@@ -167,4 +167,10 @@ public class TestClient: SentryClientInternal {
             captureLogInvocations.record((castLog, scope))
         }
     }
+    
+    @_spi(Private) public var captureMetricsDataInvocations = Invocations<(data: NSData, count: NSNumber)>()
+    @_spi(Private) public override func captureMetricsData(_ data: NSData, with itemCount: NSNumber) {
+        captureMetricsDataInvocations.record((data, itemCount))
+        super.captureMetricsData(data, with: itemCount)
+    }
 }

Sources/Sentry/SentryClient.m

@@ -1117,6 +1117,18 @@ - (void)captureLogsData:(NSData *)data with:(NSNumber *)itemCount
     [self captureEnvelope:envelope];
 }
 
+- (void)captureMetricsData:(NSData *)data with:(NSNumber *)itemCount
+{
+    SentryEnvelopeItem *envelopeItem =
+        [[SentryEnvelopeItem alloc] initWithType:SentryEnvelopeItemTypes.traceMetric
+                                            data:data
+                                     contentType:@"application/vnd.sentry.items.trace-metric+json"
+                                       itemCount:itemCount];
+    SentryEnvelope *envelope = [[SentryEnvelope alloc] initWithHeader:[SentryEnvelopeHeader empty]
+                                                           singleItem:envelopeItem];
+    [self captureEnvelope:envelope];
+}
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/SentryDataCategoryMapper.m

@@ -18,6 +18,7 @@
 NSString *const kSentryDataCategoryNameSpan = @"span";
 NSString *const kSentryDataCategoryNameFeedback = @"feedback";
 NSString *const kSentryDataCategoryNameLogItem = @"log_item";
+NSString *const kSentryDataCategoryNameTraceMetric = @"trace_metric";
 NSString *const kSentryDataCategoryNameUnknown = @"unknown";
 
 NS_ASSUME_NONNULL_BEGIN
@@ -57,6 +58,9 @@
     if ([itemType isEqualToString:SentryEnvelopeItemTypes.log]) {
         return kSentryDataCategoryLogItem;
     }
+    if ([itemType isEqualToString:SentryEnvelopeItemTypes.traceMetric]) {
+        return kSentryDataCategoryTraceMetric;
+    }
 
     return kSentryDataCategoryDefault;
 }
@@ -113,6 +117,9 @@
     if ([value isEqualToString:kSentryDataCategoryNameLogItem]) {
         return kSentryDataCategoryLogItem;
     }
+    if ([value isEqualToString:kSentryDataCategoryNameTraceMetric]) {
+        return kSentryDataCategoryTraceMetric;
+    }
 
     return kSentryDataCategoryUnknown;
 }
@@ -148,6 +155,8 @@
         return kSentryDataCategoryNameFeedback;
     case kSentryDataCategoryLogItem:
         return kSentryDataCategoryNameLogItem;
+    case kSentryDataCategoryTraceMetric:
+        return kSentryDataCategoryNameTraceMetric;
 
     default: // !!!: fall-through!
     case kSentryDataCategoryUnknown:

Sources/Sentry/SentryOptionsInternal.m

@@ -120,6 +120,10 @@ + (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
         sentryOptions.beforeSendLog = options[@"beforeSendLog"];
     }
 
+    if ([self isBlock:options[@"beforeSendMetric"]]) {
+        sentryOptions.beforeSendMetric = options[@"beforeSendMetric"];
+    }
+
     if ([self isBlock:options[@"beforeSendSpan"]]) {
         sentryOptions.beforeSendSpan = options[@"beforeSendSpan"];
     }

Sources/Sentry/include/SentryClient+Private.h

@@ -82,6 +82,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)_swiftCaptureLog:(NSObject *)log withScope:(SentryScope *)scope;
 
+- (void)captureMetricsData:(NSData *)data with:(NSNumber *)itemCount;
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryDataCategory.h

@@ -20,5 +20,6 @@ typedef NS_ENUM(NSUInteger, SentryDataCategory) {
     kSentryDataCategorySpan = 11,
     kSentryDataCategoryFeedback = 12,
     kSentryDataCategoryLogItem = 13,
-    kSentryDataCategoryUnknown = 14,
+    kSentryDataCategoryTraceMetric = 14,
+    kSentryDataCategoryUnknown = 15,
 };

Sources/Swift/Helper/SentryEnvelopeItemType.swift

@@ -14,4 +14,5 @@
     public static let statsd = "statsd"
     public static let profileChunk = "profile_chunk"
     public static let log = "log"
+    public static let traceMetric = "trace_metric"
 }

Sources/Swift/Helper/SentrySDK.swift

@@ -37,7 +37,10 @@ import Foundation
             return SentryLogger(dateProvider: SentryDependencyContainer.sharedInstance().dateProvider)
         }
     }
-    
+
+    /// API to collect metrics
+    @objc public static var metrics = MetricsApi()
+
     /// Inits and configures Sentry (`SentryHub`, `SentryClient`) and sets up all integrations. Make sure to
     /// set a valid DSN.
     /// - note: Call this method on the main thread. When calling it from a background thread, the

Sources/Swift/Integrations/Metrics/MetricsIntegration.swift

@@ -1,13 +1,58 @@
-final class MetricsIntegration<Dependencies>: NSObject, SwiftIntegration {
+final class MetricsIntegration<Dependencies>: NSObject, SwiftIntegration, SentryMetricBatcherDelegate {
+    private let options: Options
+    private let metricBatcher: SentryMetricBatcher
+    private let dispatchQueue: SentryDispatchQueueWrapper
+    
     init?(with options: Options, dependencies: Dependencies) {
         guard options.enableMetrics else { return nil }
-
-        SentrySDKLog.debug("Integration initialized")
+        
+        guard let dispatchQueueWrapper = dependencies.dispatchQueueWrapper else {
+            SentrySDKLog.error("MetricsIntegration: dispatchQueueWrapper not available in dependencies")
+            return nil
+        }
+        
+        self.options = options
+        self.dispatchQueue = dispatchQueueWrapper
+        
+        super.init()
+        
+        // Create the batcher with self as delegate after initialization
+        self.metricBatcher = SentryMetricBatcher(
+            options: options,
+            dispatchQueue: dispatchQueue,
+            delegate: self
+        )
+        
+        SentrySDKLog.debug("MetricsIntegration initialized")
     }
 
-    func uninstall() {}
+    func uninstall() {
+        // Flush any pending metrics before uninstalling
+        metricBatcher.captureMetrics()
+    }
 
     static var name: String {
         "SentryMetricsIntegration"
     }
+    
+    // MARK: - Public API for MetricsApi
+    
+    func addMetric(_ metric: SentryMetric, scope: Scope) {
+        metricBatcher.addMetric(metric, scope: scope)
+    }
+    
+    // MARK: - SentryMetricBatcherDelegate
+    
+    @objc(captureMetricsData:with:)
+    func capture(metricsData: NSData, count: NSNumber) {
+        // Get the client from the current hub
+        let hub = SentrySDKInternal.currentHub()
+        guard let client = hub.getClient() else {
+            SentrySDKLog.warn("MetricsIntegration: No client available, dropping metrics")
+            return
+        }
+        
+        // Call the client's captureMetricsData method
+        client.captureMetricsData(metricsData, with: count)
+    }
 }