feat(metrics): Add integration with installation by SDK

philprime · philprime · commit 723845a1bdca · 2025-12-02T14:09:56.000+01:00
diff --git a/Samples/SentrySampleShared/SentrySampleShared/SentrySDKOverrides.swift b/Samples/SentrySampleShared/SentrySampleShared/SentrySDKOverrides.swift
@@ -47,6 +47,7 @@ public enum SentrySDKOverrides: String, CaseIterable {
         case .tracing: return SentrySDKOverrides.Tracing.allCases
         case .profiling: return SentrySDKOverrides.Profiling.allCases
         case .networking: return SentrySDKOverrides.Networking.allCases
+        case .metrics: return SentrySDKOverrides.Metrics.allCases
         }
     }
 
@@ -167,6 +168,11 @@ public enum SentrySDKOverrides: String, CaseIterable {
         case immediateStop              = "--io.sentry.profiling.continuous-profiler-immediate-stop"
     }
     case profiling = "Profiling"
+
+    public enum Metrics: String, SentrySDKOverride {
+        case enable = "--io.sentry.metrics.enable"
+    }
+    case metrics = "Metrics"
 }
 
 // MARK: Public flag/variable value access
@@ -348,6 +354,14 @@ extension SentrySDKOverrides.Special {
     }
 }
 
+extension SentrySDKOverrides.Metrics {
+    public var overrideType: OverrideType {
+        switch self {
+        case .enable: return .boolean
+        }
+    }
+}
+
 // MARK: Disable Everything Helper
 
 // These are listed exhaustively, without using default cases, so that when new cases are added to the enums above, the compiler helps remind you to annotate what type it is down here.
@@ -429,4 +443,11 @@ extension SentrySDKOverrides.Special {
     }
 }
 
+extension SentrySDKOverrides.Metrics {
+    public var ignoresDisableEverything: Bool {
+        switch self {
+        case .enable: return false
+        }
+    }
+}
 // swiftlint:enable file_length
diff --git a/Samples/SentrySampleShared/SentrySampleShared/SentrySDKWrapper.swift b/Samples/SentrySampleShared/SentrySampleShared/SentrySDKWrapper.swift
@@ -156,8 +156,12 @@ public struct SentrySDKWrapper {
         options.configureUserFeedback = configureFeedback(config:)
 #endif // !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)
 
+        // Integration: Logs
         options.enableLogs = true
 
+        // Integration: Metrics
+        options.enableMetrics = SentrySDKOverrides.Metrics.enable.boolValue
+
         // Experimental features
         options.enableFileManagerSwizzling = !SentrySDKOverrides.Other.disableFileManagerSwizzling.boolValue
         options.experimental.enableUnhandledCPPExceptionsV2 = true
diff --git a/Samples/Shared/feature-flags.yml b/Samples/Shared/feature-flags.yml
@@ -82,6 +82,9 @@ schemeTemplates:
         "--io.sentry.other.reject-view-hierarchy-in-before-capture-view-hierarchy": false
         "--io.sentry.other.reject-all-spans": false
 
+        # metrics
+        "--io.sentry.metrics.enable": false
+
       environmentVariables:
         # events
         - variable: "--io.sentry.events.sampleRate"
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
@@ -782,6 +782,8 @@
 		D46712622DCD059900D4074A /* SentryRedactDefaultOptionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46712612DCD059500D4074A /* SentryRedactDefaultOptionsTests.swift */; };
 		D46712642DCD063800D4074A /* PreviewRedactOptionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D46712632DCD062700D4074A /* PreviewRedactOptionsTests.swift */; };
 		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 */; };
 		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 */; };
@@ -2143,6 +2145,8 @@
 		D46712612DCD059500D4074A /* SentryRedactDefaultOptionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryRedactDefaultOptionsTests.swift; sourceTree = "<group>"; };
 		D46712632DCD062700D4074A /* PreviewRedactOptionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PreviewRedactOptionsTests.swift; sourceTree = "<group>"; };
 		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>"; };
 		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>"; };
@@ -3510,6 +3514,7 @@
 			children = (
 				843FB3422D156B9900558F18 /* Feedback */,
 				7BF6505D292B77D100BBA5A8 /* MetricKit */,
+				D46B041E2EDF173A00AF4A0A /* Metrics */,
 				D808FB85281AB2EF009A2A33 /* UIEvents */,
 				D8AB40D92806EBDC00E5E9F7 /* Screenshot */,
 				0A9BF4E528A123070068D266 /* ViewHierarchy */,
@@ -4361,6 +4366,22 @@
 			path = IO;
 			sourceTree = "<group>";
 		};
+		D46B04162EDF167800AF4A0A /* Metrics */ = {
+			isa = PBXGroup;
+			children = (
+				D46B041C2EDF167D00AF4A0A /* MetricsIntegration.swift */,
+			);
+			path = Metrics;
+			sourceTree = "<group>";
+		};
+		D46B041E2EDF173A00AF4A0A /* Metrics */ = {
+			isa = PBXGroup;
+			children = (
+				D46B041F2EDF175600AF4A0A /* MetricsIntegrationTests.swift */,
+			);
+			path = Metrics;
+			sourceTree = "<group>";
+		};
 		D46D45E22D5F3FD600A1CB35 /* Plans */ = {
 			isa = PBXGroup;
 			children = (
@@ -4828,6 +4849,7 @@
 		D8CAC02D2BA0663E00E38F34 /* Integrations */ = {
 			isa = PBXGroup;
 			children = (
+				D46B04162EDF167800AF4A0A /* Metrics */,
 				FAB0073C2E9F47DE001C806A /* Session */,
 				FAE579B42E7DBE9400B710F9 /* SentryGlobalEventProcessor.swift */,
 				FAD882C12EDAADF90055AA44 /* SwiftAsyncIntegration.swift */,
@@ -6139,6 +6161,7 @@
 				62E59A5A2E8FB85300DB7A7B /* SentryTracePropagation.m in Sources */,
 				FAB007522E9FE2FF001C806A /* SentrySwizzleWrapper.swift in Sources */,
 				62E300942D5202890037AA3F /* SentryExceptionCodable.swift in Sources */,
+				D46B041D2EDF168400AF4A0A /* MetricsIntegration.swift in Sources */,
 				0A2D8D5B289815C0008720F6 /* SentryBaseIntegration.m in Sources */,
 				639FCF991EBC7B9700778193 /* SentryEvent.m in Sources */,
 				D820CDB72BB1895F00BA339D /* SentrySessionReplayIntegration.m in Sources */,
@@ -6225,6 +6248,7 @@
 				7BFAA6E7297AA16A00E7E02E /* SentryCrashMonitor_CppException_Tests.mm in Sources */,
 				9286059929A50BAB00F96038 /* SentryGeoTests.swift in Sources */,
 				621655662DB12A8900810504 /* SentryCrashMach-OTests.m in Sources */,
+				D46B04202EDF175C00AF4A0A /* MetricsIntegrationTests.swift in Sources */,
 				62B220BB2E93A9EC004620FF /* SentryTracePropagationTests.swift in Sources */,
 				D8B76B0828081461000A58C4 /* TestSentryScreenshotProvider.swift in Sources */,
 				A8AFFCD22907DA7600967CD7 /* SentryHttpStatusCodeRangeTests.swift in Sources */,
diff --git a/Sources/Sentry/SentryOptionsInternal.m b/Sources/Sentry/SentryOptionsInternal.m
@@ -96,6 +96,9 @@ + (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
 
     [self setBool:options[@"enableLogs"] block:^(BOOL value) { sentryOptions.enableLogs = value; }];
 
+    [self setBool:options[@"enableMetrics"]
+            block:^(BOOL value) { sentryOptions.enableMetrics = value; }];
+
     [self setBool:options[@"enableNetworkBreadcrumbs"]
             block:^(BOOL value) { sentryOptions.enableNetworkBreadcrumbs = value; }];
 
diff --git a/Sources/Swift/Core/Integrations/Integrations.swift b/Sources/Swift/Core/Integrations/Integrations.swift
@@ -34,7 +34,10 @@ private struct AnyIntegration {
 @_spi(Private) @objc public final class SentrySwiftIntegrationInstaller: NSObject {
     @objc public class func install(with options: Options) {
         let dependencies = SentryDependencyContainer.sharedInstance()
-        let commonIntegrations: [AnyIntegration] = [.init(SwiftAsyncIntegration.self)]
+        let commonIntegrations: [AnyIntegration] = [
+            .init(MetricsIntegration.self),
+            .init(SwiftAsyncIntegration.self)
+        ]
         #if os(iOS) && !SENTRY_NO_UIKIT
         let integrations: [AnyIntegration] = commonIntegrations + [.init(UserFeedbackIntegration<SentryDependencyContainer>.self)]
         #else
diff --git a/Sources/Swift/Helper/SentryEnabledFeaturesBuilder.swift b/Sources/Swift/Helper/SentryEnabledFeaturesBuilder.swift
@@ -45,6 +45,9 @@ import Foundation
         if options.experimental.enableUnhandledCPPExceptionsV2 {
             features.append("unhandledCPPExceptionsV2")
         }
+        if options.enableMetrics {
+            features.append("metrics")
+        }
 
         return features
     }
diff --git a/Sources/Swift/Integrations/Metrics/MetricsIntegration.swift b/Sources/Swift/Integrations/Metrics/MetricsIntegration.swift
@@ -0,0 +1,13 @@
+final class MetricsIntegration<Dependencies>: NSObject, SwiftIntegration {
+    init?(with options: Options, dependencies: Dependencies) {
+        guard options.enableMetrics else { return nil }
+
+        SentrySDKLog.debug("Integration initialized")
+    }
+
+    func uninstall() {}
+
+    static var name: String {
+        "SentryMetricsIntegration"
+    }
+}
diff --git a/Sources/Swift/Options.swift b/Sources/Swift/Options.swift
@@ -130,6 +130,11 @@
     /// @note Default value is @c false.
     @objc public var enableLogs: Bool = false
 
+    /// When enabled, the SDK sends metrics to Sentry. Metrics can be captured using the SentrySDK.metrics
+    /// API, which allows you to send, view and query counters, gauges and measurements.
+    /// @note Default value is @c false.
+    @objc public var enableMetrics: Bool = false
+
     /// Use this callback to drop or modify a log before the SDK sends it to Sentry. Return nil to
     /// drop the log.
     @objc public var beforeSendLog: ((SentryLog) -> SentryLog?)?
diff --git a/Tests/SentryTests/Integrations/Metrics/MetricsIntegrationTests.swift b/Tests/SentryTests/Integrations/Metrics/MetricsIntegrationTests.swift
@@ -0,0 +1,41 @@
+import Foundation
+@_spi(Private) @testable import Sentry
+@_spi(Private) import SentryTestUtils
+import XCTest
+
+class MetricsIntegrationTests: XCTestCase {
+
+    func testStartSDK_whenIntegrationIsNotEnabled_shouldNotBeInstalled() {
+        // -- Act --
+        startSDK(isEnabled: false)
+
+        // -- Assert --
+        XCTAssertEqual(SentrySDKInternal.currentHub().trimmedInstalledIntegrationNames().count, 0)
+    }
+
+    func testStartSDK_whenIntegrationIsEnabled_shouldBeInstalled() {
+        // -- Act --
+        startSDK(isEnabled: true)
+
+        // -- Assert --
+        XCTAssertEqual(SentrySDKInternal.currentHub().trimmedInstalledIntegrationNames().count, 1)
+    }
+
+    // MARK: - Helpers
+
+    private func startSDK(isEnabled: Bool, configure: ((Options) -> Void)? = nil) {
+        SentrySDK.start {
+            $0.dsn = TestConstants.dsnForTestCase(type: MetricsIntegrationTests.self)
+            $0.removeAllIntegrations()
+
+            $0.enableMetrics = isEnabled
+
+            configure?($0)
+        }
+        SentrySDKInternal.currentHub().startSession()
+    }
+
+    private func getSut() throws -> MetricsIntegration<Dependencies> {
+        return try XCTUnwrap(SentrySDKInternal.currentHub().installedIntegrations().first as? MetricsIntegration)
+    }
+}
diff --git a/Tests/SentryTests/SentryOptionsTest.m b/Tests/SentryTests/SentryOptionsTest.m
@@ -205,6 +205,11 @@ - (void)testEnableLogs
     [self testBooleanField:@"enableLogs" defaultValue:NO];
 }
 
+- (void)testEnableMetrics
+{
+    [self testBooleanField:@"enableMetrics" defaultValue:NO];
+}
+
 - (void)testEnableAutoBreadcrumbTracking
 {
     [self testBooleanField:@"enableAutoBreadcrumbTracking"];
diff --git a/sdk_api.json b/sdk_api.json
@@ -46220,6 +46220,82 @@
               }
             ]
           },
+          {
+            "kind": "Var",
+            "name": "enableMetrics",
+            "printedName": "enableMetrics",
+            "children": [
+              {
+                "kind": "TypeNominal",
+                "name": "Bool",
+                "printedName": "Swift.Bool",
+                "usr": "s:Sb"
+              }
+            ],
+            "declKind": "Var",
+            "usr": "c:@M@Sentry@objc(cs)SentryOptions(py)enableMetrics",
+            "mangledName": "$s6Sentry7OptionsC13enableMetricsSbvp",
+            "moduleName": "Sentry",
+            "declAttributes": [
+              "Final",
+              "ObjC",
+              "HasStorage"
+            ],
+            "hasStorage": true,
+            "accessors": [
+              {
+                "kind": "Accessor",
+                "name": "Get",
+                "printedName": "Get()",
+                "children": [
+                  {
+                    "kind": "TypeNominal",
+                    "name": "Bool",
+                    "printedName": "Swift.Bool",
+                    "usr": "s:Sb"
+                  }
+                ],
+                "declKind": "Accessor",
+                "usr": "c:@M@Sentry@objc(cs)SentryOptions(im)enableMetrics",
+                "mangledName": "$s6Sentry7OptionsC13enableMetricsSbvg",
+                "moduleName": "Sentry",
+                "implicit": true,
+                "declAttributes": [
+                  "Final",
+                  "ObjC"
+                ],
+                "accessorKind": "get"
+              },
+              {
+                "kind": "Accessor",
+                "name": "Set",
+                "printedName": "Set()",
+                "children": [
+                  {
+                    "kind": "TypeNominal",
+                    "name": "Void",
+                    "printedName": "()"
+                  },
+                  {
+                    "kind": "TypeNominal",
+                    "name": "Bool",
+                    "printedName": "Swift.Bool",
+                    "usr": "s:Sb"
+                  }
+                ],
+                "declKind": "Accessor",
+                "usr": "c:@M@Sentry@objc(cs)SentryOptions(im)setEnableMetrics:",
+                "mangledName": "$s6Sentry7OptionsC13enableMetricsSbvs",
+                "moduleName": "Sentry",
+                "implicit": true,
+                "declAttributes": [
+                  "Final",
+                  "ObjC"
+                ],
+                "accessorKind": "set"
+              }
+            ]
+          },
           {
             "kind": "Var",
             "name": "beforeSendLog",

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ public enum SentrySDKOverrides: String, CaseIterable {`
`47`	`47`	`case .tracing: return SentrySDKOverrides.Tracing.allCases`
`48`	`48`	`case .profiling: return SentrySDKOverrides.Profiling.allCases`
`49`	`49`	`case .networking: return SentrySDKOverrides.Networking.allCases`
	`50`	`+ case .metrics: return SentrySDKOverrides.Metrics.allCases`
`50`	`51`	`}`
`51`	`52`	`}`
`52`	`53`
`@@ -167,6 +168,11 @@ public enum SentrySDKOverrides: String, CaseIterable {`
`167`	`168`	`case immediateStop = "--io.sentry.profiling.continuous-profiler-immediate-stop"`
`168`	`169`	`}`
`169`	`170`	`case profiling = "Profiling"`
	`171`	`+`
	`172`	`+ public enum Metrics: String, SentrySDKOverride {`
	`173`	`+ case enable = "--io.sentry.metrics.enable"`
	`174`	`+ }`
	`175`	`+ case metrics = "Metrics"`
`170`	`176`	`}`
`171`	`177`
`172`	`178`	`// MARK: Public flag/variable value access`
`@@ -348,6 +354,14 @@ extension SentrySDKOverrides.Special {`
`348`	`354`	`}`
`349`	`355`	`}`
`350`	`356`
	`357`	`+extension SentrySDKOverrides.Metrics {`
	`358`	`+ public var overrideType: OverrideType {`
	`359`	`+ switch self {`
	`360`	`+ case .enable: return .boolean`
	`361`	`+ }`
	`362`	`+ }`
	`363`	`+}`
	`364`	`+`
`351`	`365`	`// MARK: Disable Everything Helper`
`352`	`366`
`353`	`367`	`// These are listed exhaustively, without using default cases, so that when new cases are added to the enums above, the compiler helps remind you to annotate what type it is down here.`
`@@ -429,4 +443,11 @@ extension SentrySDKOverrides.Special {`
`429`	`443`	`}`
`430`	`444`	`}`
`431`	`445`
	`446`	`+extension SentrySDKOverrides.Metrics {`
	`447`	`+ public var ignoresDisableEverything: Bool {`
	`448`	`+ switch self {`
	`449`	`+ case .enable: return false`
	`450`	`+ }`
	`451`	`+ }`
	`452`	`+}`
`432`	`453`	`// swiftlint:enable file_length`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ import Foundation`
`45`	`45`	`if options.experimental.enableUnhandledCPPExceptionsV2 {`
`46`	`46`	`features.append("unhandledCPPExceptionsV2")`
`47`	`47`	`}`
	`48`	`+ if options.enableMetrics {`
	`49`	`+ features.append("metrics")`
	`50`	`+ }`
`48`	`51`
`49`	`52`	`return features`
`50`	`53`	`}`