feat(metrics): Add integration with installation by SDK

.gitignore

@@ -121,3 +121,4 @@ analyzer
 
 # Output folder for Sentry local builds
 XCFrameworkBuildPath/
+*.xcresult

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add integration to collect Metrics, can be enabled by setting `options.enableMetrics = true` (#6956)
+### Fixes
+
+- Use `sendDefaultPii` and `span_id` for attributes in `BatcherScope` (#7055)
+
 ## 9.1.0
 
 > [!Warning]

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 true
+        }
+    }
+}
 // swiftlint:enable file_length

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

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"

Sentry.xcodeproj/project.pbxproj

@@ -777,6 +777,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 */; };
@@ -2146,6 +2148,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>"; };
@@ -3522,6 +3526,7 @@
 				F498EBA52EE0B8E400F57509 /* SentrySwiftIntegrationInstallerTests.swift */,
 				843FB3422D156B9900558F18 /* Feedback */,
 				7BF6505D292B77D100BBA5A8 /* MetricKit */,
+				D46B041E2EDF173A00AF4A0A /* Metrics */,
 				D808FB85281AB2EF009A2A33 /* UIEvents */,
 				D8AB40D92806EBDC00E5E9F7 /* Screenshot */,
 				0A9BF4E528A123070068D266 /* ViewHierarchy */,
@@ -4394,6 +4399,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 = (
@@ -4879,6 +4900,7 @@
 			isa = PBXGroup;
 			children = (
 				925189AB2EDDA6A300557BD1 /* Log */,
+				D46B04162EDF167800AF4A0A /* Metrics */,
 				FAB0073C2E9F47DE001C806A /* Session */,
 				FAE579B42E7DBE9400B710F9 /* SentryGlobalEventProcessor.swift */,
 				FAD882C12EDAADF90055AA44 /* SwiftAsyncIntegration.swift */,
@@ -6195,6 +6217,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 */,
@@ -6282,6 +6305,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 */,

SentryTestUtils/Sources/TestOptions.swift

@@ -21,6 +21,7 @@ public extension Options {
         attachViewHierarchy = false
         enableUIViewControllerTracing = false
         #endif
+        enableMetrics = false
     }
 
     static func noIntegrations() -> Options {

Sources/Sentry/Public/SentryScope.h

@@ -46,6 +46,12 @@ NS_SWIFT_NAME(Scope)
  */
 @property (nonatomic, readonly, copy) NSDictionary<NSString *, id> *attributes;
 
+/**
+ * Indicates if default PII should be sent with events.
+ * This is set from ``SentryOptions.sendDefaultPii`` during SDK initialization.
+ */
+@property (nonatomic) BOOL sendDefaultPii;
+
 - (instancetype)initWithMaxBreadcrumbs:(NSInteger)maxBreadcrumbs NS_DESIGNATED_INITIALIZER;
 - (instancetype)init;
 - (instancetype)initWithScope:(SentryScope *)scope;

Sources/Sentry/SentryOptionsInternal.m

@@ -95,6 +95,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; }];
 

Sources/Sentry/SentrySDKInternal.m

@@ -231,6 +231,7 @@ + (void)startWithOptions:(SentryOptions *)options
 
     SentryScope *scope
         = options.initialScope([[SentryScope alloc] initWithMaxBreadcrumbs:options.maxBreadcrumbs]);
+    scope.sendDefaultPii = options.sendDefaultPii;
 
     SENTRY_LOG_DEBUG(@"Dispatching init work required to run on main thread.");
     [SentryDependencyContainer.sharedInstance.dispatchQueueWrapper

Sources/Sentry/SentryScope.m

@@ -56,6 +56,7 @@ - (instancetype)initWithMaxBreadcrumbs:(NSInteger)maxBreadcrumbs
         _spanLock = [[NSObject alloc] init];
         self.observers = [NSMutableArray new];
         self.propagationContext = [[SentryPropagationContext alloc] init];
+        _sendDefaultPii = NO;
     }
     return self;
 }
@@ -87,6 +88,7 @@ - (instancetype)initWithScope:(SentryScope *)scope
         self.levelEnum = scope.levelEnum;
         self.span = scope.span;
         self.replayId = scope.replayId;
+        self.sendDefaultPii = scope.sendDefaultPii;
     }
     return self;
 }

Sources/Swift/Core/Integrations/Integrations.swift

@@ -37,7 +37,8 @@ private struct AnyIntegration {
 
         var integrations: [AnyIntegration] = [
             .init(SwiftAsyncIntegration.self),
-            .init(SentryAutoSessionTrackingIntegration.self)
+            .init(SentryAutoSessionTrackingIntegration.self),
+            .init(MetricsIntegration.self)
         ]
 
         #if os(iOS) && !SENTRY_NO_UIKIT

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
     }

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 {
+        "MetricsIntegration"
+    }
+}

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?)?

Sources/Swift/Tools/Batcher/BatcherScope.swift

@@ -7,6 +7,7 @@ protocol BatcherScope {
     var userObject: User? { get }
     func getContextForKey(_ key: String) -> [String: Any]?
     var attributes: [String: Any] { get }
+    var sendDefaultPii: Bool { get }
 
     func applyToItem<Item: BatcherItem, Config: BatcherConfig<Item>, Metadata: BatcherMetadata>(
         _ item: inout Item,
@@ -40,7 +41,7 @@ extension BatcherScope {
             attributes["sentry.release"] = .init(string: releaseName)
         }
         if let span = self.span {
-            attributes["sentry.trace.parent_span_id"] = .init(string: span.spanId.sentrySpanIdString)
+            attributes["span_id"] = .init(string: span.spanId.sentrySpanIdString)
         }
     }
 
@@ -72,6 +73,9 @@ extension BatcherScope {
     }
 
     private func addUserAttributes(to attributes: inout [String: SentryAttribute], config: any BatcherConfig) {
+        guard self.sendDefaultPii else {
+            return
+        }
         if let userId = userObject?.userId {
             attributes["user.id"] = .init(string: userId)
         }

Tests/SentryTests/Batcher/BatcherScopeTests.swift

@@ -47,6 +47,7 @@ final class BatcherScopeTests: XCTestCase {
         var userObject: User?
         var contextStore: [String: [String: Any]] = [:]
         var attributes: [String: Any] = [:]
+        var sendDefaultPii = true
 
         func getContextForKey(_ key: String) -> [String: Any]? {
             return contextStore[key]
@@ -145,7 +146,7 @@ final class BatcherScopeTests: XCTestCase {
         scope.applyToItem(&item, config: config, metadata: metadata)
 
         // -- Assert --
-        XCTAssertEqual(item.attributes["sentry.trace.parent_span_id"]?.value as? String, span.spanId.sentrySpanIdString)
+        XCTAssertEqual(item.attributes["span_id"]?.value as? String, span.spanId.sentrySpanIdString)
     }
 
     func testApplyToItem_withoutSpan_shouldNotAddParentSpanId() {
@@ -654,7 +655,7 @@ final class BatcherScopeTests: XCTestCase {
         XCTAssertEqual(item.attributes["sentry.sdk.version"]?.value as? String, SentryMeta.versionString)
         XCTAssertEqual(item.attributes["sentry.environment"]?.value as? String, "production")
         XCTAssertEqual(item.attributes["sentry.release"]?.value as? String, "1.0.0")
-        XCTAssertEqual(item.attributes["sentry.trace.parent_span_id"]?.value as? String, span.spanId.sentrySpanIdString)
+        XCTAssertEqual(item.attributes["span_id"]?.value as? String, span.spanId.sentrySpanIdString)
 
         // OS attributes
         XCTAssertEqual(item.attributes["os.name"]?.value as? String, "iOS")

Tests/SentryTests/Batcher/BatcherTests.swift

@@ -9,6 +9,7 @@ private struct TestScope: BatcherScope {
     var userObject: User?
     var contextStore: [String: [String: Any]] = [:]
     var attributes: [String: Any] = [:]
+    var sendDefaultPii = true
 
     init(propagationContextTraceIdString: String = SentryId().sentryIdString) {
         self.propagationContextTraceIdString = propagationContextTraceIdString

Tests/SentryTests/Helper/SentryEnabledFeaturesBuilderTests.swift

@@ -169,4 +169,30 @@ final class SentryEnabledFeaturesBuilderTests: XCTestCase {
         // -- Assert --
         XCTAssert(features.contains("unhandledCPPExceptionsV2"))
     }
+
+    func testEnableMetrics_isEnabled_shouldAddFeature() throws {
+        // -- Arrange --
+        let options = Options()
+
+        options.enableMetrics = true
+
+        // -- Act --
+        let features = SentryEnabledFeaturesBuilder.getEnabledFeatures(options: options)
+
+        // -- Assert --
+        XCTAssert(features.contains("metrics"))
+    }
+
+    func testEnableMetrics_isDisabled_shouldNotAddFeature() throws {
+        // -- Arrange --
+        let options = Options()
+
+        options.enableMetrics = false
+
+        // -- Act --
+        let features = SentryEnabledFeaturesBuilder.getEnabledFeatures(options: options)
+
+        // -- Assert --
+        XCTAssertFalse(features.contains("metrics"))
+    }
 }

Tests/SentryTests/Integrations/Metrics/MetricsIntegrationTests.swift

@@ -0,0 +1,43 @@
+import Foundation
+@_spi(Private) @testable import Sentry
+@_spi(Private) import SentryTestUtils
+import XCTest
+
+class MetricsIntegrationTests: XCTestCase {
+
+    override func tearDown() {
+        super.tearDown()
+        clearTestState()
+    }
+
+    // MARK: - Tests
+
+    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().first, "Metrics")
+    }
+
+    // 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)
+        }
+    }
+}