feat(metrics): Add public API to collect count, distribution and gauge

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 */; };
+		D46B043E2EDF1E3C00AF4A0A /* MetricsApi.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46B043D2EDF1E3A00AF4A0A /* MetricsApi.swift */; };
+		D46B04422EDF207900AF4A0A /* MetricsApiTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46B04412EDF207900AF4A0A /* MetricsApiTests.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>"; };
+		D46B043D2EDF1E3A00AF4A0A /* MetricsApi.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsApi.swift; sourceTree = "<group>"; };
+		D46B04412EDF207900AF4A0A /* MetricsApiTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsApiTests.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>"; };
@@ -4369,6 +4373,7 @@
 		D46B04162EDF167800AF4A0A /* Metrics */ = {
 			isa = PBXGroup;
 			children = (
+				D46B043D2EDF1E3A00AF4A0A /* MetricsApi.swift */,
 				D46B041C2EDF167D00AF4A0A /* MetricsIntegration.swift */,
 			);
 			path = Metrics;
@@ -4377,6 +4382,7 @@
 		D46B041E2EDF173A00AF4A0A /* Metrics */ = {
 			isa = PBXGroup;
 			children = (
+				D46B04412EDF207900AF4A0A /* MetricsApiTests.swift */,
 				D46B041F2EDF175600AF4A0A /* MetricsIntegrationTests.swift */,
 			);
 			path = Metrics;
@@ -5803,6 +5809,7 @@
 				D8ACE3C82762187200F5A213 /* SentryFileIOTrackerHelper.m in Sources */,
 				D8B088B729C9E3FF00213258 /* SentryTracerConfiguration.m in Sources */,
 				FA7206E12E0B37C80072FDD4 /* SentryProfileCollector.mm in Sources */,
+				D46B043E2EDF1E3C00AF4A0A /* MetricsApi.swift in Sources */,
 				9264E1EB2E2E385E00B077CF /* SentryLogMessage.swift in Sources */,
 				8ECC674A25C23A20000E2BF6 /* SentryTransactionContext.m in Sources */,
 				03BCC38C27E1C01A003232C7 /* SentryTime.mm in Sources */,
@@ -6313,6 +6320,7 @@
 				7B72D23A28D074BC0014798A /* TestExtensions.swift in Sources */,
 				7BBD18BB24530D2600427C76 /* SentryFileManagerTests.swift in Sources */,
 				63FE722020DA66EC00CDBAE8 /* SentryCrashObjC_Tests.m in Sources */,
+				D46B04422EDF207900AF4A0A /* MetricsApiTests.swift in Sources */,
 				62277BBC2DA5183500EF06B7 /* SentryTracer+Test.m in Sources */,
 				7B58816727FC5D790098B121 /* SentryDiscardReasonMapperTests.swift in Sources */,
 				D434DB102DE09D0300DD6F82 /* TestSentryWatchdogTerminationAttributesProcessorTests.swift in Sources */,

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/MetricsApi.swift

@@ -0,0 +1,46 @@
+@objc public class MetricsApi: NSObject {
+
+    /// Records a count metric for the specified key.
+    /// 
+    /// Use this to increment or set a discrete occurrence count associated with a metric key,
+    /// such as the number of events, requests, or errors.
+    /// 
+    /// - Parameters:
+    ///   - key: A namespaced identifier for the metric (for example, "network.request.count").
+    ///          Prefer stable, lowercase, dot-delimited names to aid aggregation and filtering.
+    ///   - value: The count value to record. Typically a non-negative integer (e.g., 1 to increment by one).
+    ///            Values less than zero may be ignored or clamped by the metrics backend.
+    public func count(key: String, value: Int) {
+        // noop
+    }
+
+    /// Records a distribution metric for the specified key.
+    /// 
+    /// Use this to track the distribution of a value over time, such as response times,
+    /// request durations, or any measurable quantity where you want to analyze statistical
+    /// properties (mean, median, percentiles, etc.).
+    /// 
+    /// - Parameters:
+    ///   - key: A namespaced identifier for the metric (for example, "http.request.duration").
+    ///          Prefer stable, lowercase, dot-delimited names to aid aggregation and filtering.
+    ///   - value: The value to record in the distribution. This can be any numeric value
+    ///            representing the measurement (e.g., milliseconds for response time).
+    public func distribution(key: String, value: Double) {
+       // noop
+    }
+
+    /// Records a gauge metric for the specified key.
+    /// 
+    /// Use this to track a value that can go up and down over time, such as current memory usage,
+    /// queue depth, active connections, or any metric that represents a current state rather
+    /// than an incrementing counter.
+    /// 
+    /// - Parameters:
+    ///   - key: A namespaced identifier for the metric (for example, "memory.usage" or "queue.depth").
+    ///          Prefer stable, lowercase, dot-delimited names to aid aggregation and filtering.
+    ///   - value: The current gauge value to record. This represents the state at the time of
+    ///            recording (e.g., current memory in bytes, current number of items in queue).
+    public func gauge(key: String, value: Double) {
+        // noop
+    }
+}