Merge pull request #2219 from DataDog/maxep/RUM-8448/benchmarks-additional-telemetry

dd-mergequeue[bot] · maxep · web-flow · commit 09490e5c73d3 · 2025-03-20T11:18:49.000Z
RUM-8448 Benchmarks Additional Metrics

Co-authored-by: maxep &lt;maxime.epain@datadoghq.com&gt;
diff --git a/BenchmarkTests/Runner/BenchmarkMeter.swift b/BenchmarkTests/Runner/BenchmarkMeter.swift
@@ -68,6 +68,10 @@ internal final class Meter: DatadogInternal.BenchmarkMeter {
     func gauge(metric: @autoclosure () -> String) -> DatadogInternal.BenchmarkGauge {
         meter.createDoubleMeasure(name: metric())
     }
+
+    func observe(metric: @autoclosure () -> String, callback: @escaping (any DatadogInternal.BenchmarkGauge) -> Void) {
+        _ = meter.createDoubleObserver(name: metric()) { callback(DoubleObserverWrapper(observer: $0)) }
+    }
 }
 
 extension AnyCounterMetric<Double>: DatadogInternal.BenchmarkCounter {
@@ -81,3 +85,11 @@ extension AnyMeasureMetric<Double>: DatadogInternal.BenchmarkGauge {
         record(value: value, labelset: LabelSet(labels: attributes()))
     }
 }
+
+private struct DoubleObserverWrapper: DatadogInternal.BenchmarkGauge {
+    let observer: DoubleObserverMetric
+
+    func record(value: Double, attributes: @autoclosure () -> [String: String]) {
+        observer.observe(value: value, labelset: LabelSet(labels: attributes()))
+    }
+}
diff --git a/Datadog/Datadog.xcodeproj/project.pbxproj b/Datadog/Datadog.xcodeproj/project.pbxproj
@@ -1710,6 +1710,8 @@
 		D2DC4BF727F484AA00E4FB96 /* DataEncryption.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2DC4BF527F484AA00E4FB96 /* DataEncryption.swift */; };
 		D2DE63532A30A7CA00441A54 /* CoreRegistry.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2DE63522A30A7CA00441A54 /* CoreRegistry.swift */; };
 		D2DE63542A30A7CA00441A54 /* CoreRegistry.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2DE63522A30A7CA00441A54 /* CoreRegistry.swift */; };
+		D2E6E8FB2D8039BB00FF1398 /* BenchmarkURLSessionTaskDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2E6E8FA2D8039B200FF1398 /* BenchmarkURLSessionTaskDelegate.swift */; };
+		D2E6E8FC2D8039BB00FF1398 /* BenchmarkURLSessionTaskDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2E6E8FA2D8039B200FF1398 /* BenchmarkURLSessionTaskDelegate.swift */; };
 		D2EA0F462C0E1AE300CB20F8 /* SessionReplayConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2EA0F452C0E1AE200CB20F8 /* SessionReplayConfiguration.swift */; };
 		D2EBEE1F29BA160F00B15732 /* HTTPHeadersReader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 618E13A92524B8700098C6B0 /* HTTPHeadersReader.swift */; };
 		D2EBEE2029BA160F00B15732 /* TracePropagationHeadersWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2EBEDCF29B8A02100B15732 /* TracePropagationHeadersWriter.swift */; };
@@ -3114,6 +3116,7 @@
 		D2DA23C9298D5C1300C6C7E6 /* UIKitMocks.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIKitMocks.swift; sourceTree = "<group>"; };
 		D2DC4BF527F484AA00E4FB96 /* DataEncryption.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DataEncryption.swift; sourceTree = "<group>"; };
 		D2DE63522A30A7CA00441A54 /* CoreRegistry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CoreRegistry.swift; sourceTree = "<group>"; };
+		D2E6E8FA2D8039B200FF1398 /* BenchmarkURLSessionTaskDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BenchmarkURLSessionTaskDelegate.swift; sourceTree = "<group>"; };
 		D2E8D59728C7AB90007E5DE1 /* ContextMessageReceiverTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ContextMessageReceiverTests.swift; sourceTree = "<group>"; };
 		D2EA0F452C0E1AE200CB20F8 /* SessionReplayConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SessionReplayConfiguration.swift; sourceTree = "<group>"; };
 		D2EBEDCC29B893D800B15732 /* TraceID.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TraceID.swift; sourceTree = "<group>"; };
@@ -5026,6 +5029,7 @@
 		6174D6082BFDDD1E00EC7469 /* SDKMetrics */ = {
 			isa = PBXGroup;
 			children = (
+				D2E6E8FA2D8039B200FF1398 /* BenchmarkURLSessionTaskDelegate.swift */,
 				614396712A67D74F00197326 /* BatchMetrics.swift */,
 			);
 			path = SDKMetrics;
@@ -8002,6 +8006,7 @@
 				D2FB1254292E0E96005B13F8 /* TrackingConsentPublisher.swift in Sources */,
 				61D3E0D6277B23F1008BE766 /* KronosClock.swift in Sources */,
 				D2A7841129A53B2F003B03BB /* File.swift in Sources */,
+				D2E6E8FB2D8039BB00FF1398 /* BenchmarkURLSessionTaskDelegate.swift in Sources */,
 				D286626E2A43487500852CE3 /* Datadog.swift in Sources */,
 				61F930C22BA1C41A005F0EE2 /* TLVBlockReader.swift in Sources */,
 				613E793B2577B6EE00DFCC17 /* DataReader.swift in Sources */,
@@ -9335,6 +9340,7 @@
 				D2CB6E5527C50EAE00A62B57 /* KronosNSTimer+ClosureKit.swift in Sources */,
 				D2CB6E6627C50EAE00A62B57 /* Reader.swift in Sources */,
 				D2CB6E6927C50EAE00A62B57 /* KronosDNSResolver.swift in Sources */,
+				D2E6E8FC2D8039BB00FF1398 /* BenchmarkURLSessionTaskDelegate.swift in Sources */,
 				D286626F2A43487500852CE3 /* Datadog.swift in Sources */,
 				61F930C32BA1C41A005F0EE2 /* TLVBlockReader.swift in Sources */,
 				D2A7841229A53B2F003B03BB /* File.swift in Sources */,
diff --git a/DatadogCore/Sources/Core/Storage/Files/File.swift b/DatadogCore/Sources/Core/Storage/Files/File.swift
@@ -35,6 +35,9 @@ internal protocol ReadableFile {
     /// Name of this file.
     var name: String { get }
 
+    /// Current size of this file.
+    func size() throws -> UInt64
+
     /// Creates InputStream for reading the available data from this file.
     func stream() throws -> InputStream
 
diff --git a/DatadogCore/Sources/Core/Storage/FilesOrchestrator.swift b/DatadogCore/Sources/Core/Storage/FilesOrchestrator.swift
@@ -80,6 +80,15 @@ internal class FilesOrchestrator: FilesOrchestratorType {
         self.dateProvider = dateProvider
         self.telemetry = telemetry
         self.metricsData = metricsData
+
+#if DD_BENCHMARK
+        bench.meter.observe(metric: "ios.benchmark.batch_count") {[weak self] gauge in
+            if let self {
+                let files = try? directory.files()
+                files.map { gauge.record($0.count, attributes: ["track": self.trackName]) }
+            }
+        }
+#endif
     }
 
     // MARK: - `WritableFile` orchestration
@@ -211,6 +220,12 @@ internal class FilesOrchestrator: FilesOrchestratorType {
 
     func delete(readableFile: ReadableFile, deletionReason: BatchDeletedMetric.RemovalReason) {
         do {
+#if DD_BENCHMARK
+            if case .intakeCode = deletionReason {
+                try bench.meter.counter(metric: "ios.benchmark.bytes_deleted")
+                    .increment(by: readableFile.size(), attributes: ["track": trackName])
+            }
+#endif
             try readableFile.delete()
             // Decrement pending batches at each batch deletion
             _pendingBatches.mutate { $0 -= 1 }
diff --git a/DatadogCore/Sources/Core/Upload/DataUploadWorker.swift b/DatadogCore/Sources/Core/Upload/DataUploadWorker.swift
@@ -139,6 +139,10 @@ internal class DataUploadWorker: DataUploadWorkerType {
                         batch,
                         reason: .intakeCode(responseCode: uploadStatus.responseCode)
                     )
+#if DD_BENCHMARK
+                    bench.meter.counter(metric: "ios.benchmark.upload_count")
+                        .increment(attributes: ["track": self.featureName])
+#endif
 
                     previousUploadStatus = nil
 
diff --git a/DatadogCore/Sources/Core/Upload/DataUploader.swift b/DatadogCore/Sources/Core/Upload/DataUploader.swift
@@ -26,10 +26,17 @@ internal final class DataUploader: DataUploaderType {
 
     private let httpClient: HTTPClient
     private let requestBuilder: FeatureRequestBuilder
+    /// Name of the feature this worker is performing uploads for.
+    private let featureName: String
 
-    init(httpClient: HTTPClient, requestBuilder: FeatureRequestBuilder) {
+    init(
+        httpClient: HTTPClient,
+        requestBuilder: FeatureRequestBuilder,
+        featureName: String
+    ) {
         self.httpClient = httpClient
         self.requestBuilder = requestBuilder
+        self.featureName = featureName
     }
 
     /// Uploads data synchronously (will block current thread) and returns the upload status.
@@ -51,7 +58,13 @@ internal final class DataUploader: DataUploaderType {
 
         let semaphore = DispatchSemaphore(value: 0)
 
-        httpClient.send(request: request) { result in
+#if DD_BENCHMARK
+        let delegate: URLSessionTaskDelegate = BenchmarkURLSessionTaskDelegate(track: featureName)
+#else
+        let delegate: URLSessionTaskDelegate? = nil
+#endif
+
+        httpClient.send(request: request, delegate: delegate) { result in
             switch result {
             case .success(let httpResponse):
                 uploadStatus = DataUploadStatus(
@@ -71,6 +84,11 @@ internal final class DataUploader: DataUploaderType {
 
         _ = semaphore.wait(timeout: .distantFuture)
 
+#if DD_BENCHMARK
+        bench.meter.counter(metric: "ios.benchmark.bytes_uploaded")
+            .increment(by: request.httpBody?.count ?? 0, attributes: ["track": featureName])
+#endif
+
         return uploadStatus ?? DataUploader.unreachableUploadStatus
     }
 }
diff --git a/DatadogCore/Sources/Core/Upload/FeatureUpload.swift b/DatadogCore/Sources/Core/Upload/FeatureUpload.swift
@@ -30,7 +30,8 @@ internal struct FeatureUpload {
 
         let dataUploader = DataUploader(
             httpClient: httpClient,
-            requestBuilder: requestBuilder
+            requestBuilder: requestBuilder,
+            featureName: featureName
         )
 
         #if canImport(UIKit)
diff --git a/DatadogCore/Sources/Core/Upload/HTTPClient.swift b/DatadogCore/Sources/Core/Upload/HTTPClient.swift
@@ -11,6 +11,17 @@ internal protocol HTTPClient {
     /// Sends the provided request using HTTP.
     /// - Parameters:
     ///   - request: The request to be sent.
+    ///   - delegate: The task-specific delegate.
     ///   - completion: A closure that receives a Result containing either an HTTPURLResponse or an Error.
-    func send(request: URLRequest, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void)
+    func send(request: URLRequest, delegate: URLSessionTaskDelegate?, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void)
+}
+
+extension HTTPClient {
+    /// Sends the provided request using HTTP.
+    /// - Parameters:
+    ///   - request: The request to be sent.
+    ///   - completion: A closure that receives a Result containing either an HTTPURLResponse or an Error.
+    func send(request: URLRequest, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void) {
+        self.send(request: request, delegate: nil, completion: completion)
+    }
 }
diff --git a/DatadogCore/Sources/Core/Upload/URLSessionClient.swift b/DatadogCore/Sources/Core/Upload/URLSessionClient.swift
@@ -35,10 +35,13 @@ internal class URLSessionClient: HTTPClient {
         self.session = session
     }
 
-    func send(request: URLRequest, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void) {
+    func send(request: URLRequest, delegate: URLSessionTaskDelegate?, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void) {
         let task = session.dataTask(with: request) { data, response, error in
             completion(httpClientResult(for: (data, response, error)))
         }
+        if #available(iOS 15.0, tvOS 15.0, watchOS 8.0, *) {
+            task.delegate = delegate
+        }
         task.resume()
     }
 }
diff --git a/DatadogCore/Sources/SDKMetrics/BenchmarkURLSessionTaskDelegate.swift b/DatadogCore/Sources/SDKMetrics/BenchmarkURLSessionTaskDelegate.swift
@@ -0,0 +1,26 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2019-Present Datadog, Inc.
+ */
+
+#if DD_BENCHMARK
+
+import Foundation
+import DatadogInternal
+
+/// `URLSessionTaskDelegate` implementation to collect network request metrics during benchmark execution.
+internal final class BenchmarkURLSessionTaskDelegate: NSObject, URLSessionTaskDelegate {
+    let track: String
+
+    init(track: String) {
+        self.track = track
+    }
+
+    func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
+        bench.meter.gauge(metric: "ios.benchmark.reponse_latency")
+            .record(metrics.taskInterval.duration, attributes: ["track": track])
+    }
+}
+
+#endif
diff --git a/DatadogCore/Tests/Datadog/Core/Upload/DataUploadWorkerTests.swift b/DatadogCore/Tests/Datadog/Core/Upload/DataUploadWorkerTests.swift
@@ -765,7 +765,8 @@ class DataUploadWorkerTests: XCTestCase {
 
         let dataUploader = DataUploader(
             httpClient: httpClient,
-            requestBuilder: FeatureRequestBuilderMock()
+            requestBuilder: FeatureRequestBuilderMock(),
+            featureName: .mockRandom()
         )
         let worker = DataUploadWorker(
             queue: uploaderQueue,
diff --git a/DatadogCore/Tests/Datadog/Core/Upload/DataUploaderTests.swift b/DatadogCore/Tests/Datadog/Core/Upload/DataUploaderTests.swift
@@ -21,7 +21,8 @@ class DataUploaderTests: XCTestCase {
 
         let uploader = DataUploader(
             httpClient: HTTPClientMock(response: randomResponse),
-            requestBuilder: FeatureRequestBuilderMock(request: randomRequest)
+            requestBuilder: FeatureRequestBuilderMock(request: randomRequest),
+            featureName: .mockRandom()
         )
 
         // When
@@ -50,7 +51,8 @@ class DataUploaderTests: XCTestCase {
 
         let uploader = DataUploader(
             httpClient: HTTPClientMock(error: randomError),
-            requestBuilder: FeatureRequestBuilderMock(request: randomRequest)
+            requestBuilder: FeatureRequestBuilderMock(request: randomRequest),
+            featureName: .mockRandom()
         )
 
         // When
@@ -72,7 +74,8 @@ class DataUploaderTests: XCTestCase {
 
         let uploader = DataUploader(
             httpClient: HTTPClientMock(),
-            requestBuilder: FailingRequestBuilderMock(error: error)
+            requestBuilder: FailingRequestBuilderMock(error: error),
+            featureName: .mockRandom()
         )
 
         // When & Then
diff --git a/DatadogCore/Tests/Datadog/Mocks/HTTPClientMock.swift b/DatadogCore/Tests/Datadog/Mocks/HTTPClientMock.swift
@@ -42,7 +42,7 @@ internal class HTTPClientMock: HTTPClient {
 
     // MARK: - HTTPClient conformance
 
-    func send(request: URLRequest, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void) {
+    func send(request: URLRequest, delegate: URLSessionTaskDelegate?, completion: @escaping (Result<HTTPURLResponse, any Error>) -> Void) {
         queue.async {
             completion(self.result(request))
             self.requests.append(request)
diff --git a/DatadogInternal/Sources/Benchmarks/BenchmarkProfiler.swift b/DatadogInternal/Sources/Benchmarks/BenchmarkProfiler.swift
@@ -56,6 +56,13 @@ public protocol BenchmarkMeter {
     /// - Parameter metric: The metric name.
     /// - Returns: The gauge instance.
     func gauge(metric: @autoclosure () -> String) -> BenchmarkGauge
+
+    /// Observe a measure value.
+    ///
+    /// - Parameters:
+    ///   - metric: The metric name.
+    ///   - callback: Callback providing a gauge instance to record a value.
+    func observe(metric: @autoclosure () -> String, callback: @escaping (BenchmarkGauge) -> Void )
 }
 
 /// The Benchmark Tracer will create and start spans in a benchmark environment.
@@ -87,6 +94,11 @@ public protocol BenchmarkCounter {
 }
 
 extension BenchmarkCounter {
+    /// Increment the counter by one.
+    public func increment(attributes: @autoclosure () -> [String: String] = [:]) {
+        add(value: 1, attributes: attributes())
+    }
+
     /// Increment the counter.
     ///
     /// - parameters:
@@ -99,7 +111,7 @@ extension BenchmarkCounter {
     ///
     /// - parameters:
     ///     - by: Amount to increment by.
-    public func increment<Integer>(by amount: Integer = 1, attributes: @autoclosure () -> [String: String] = [:]) where Integer: BinaryInteger {
+    public func increment<Integer>(by amount: Integer, attributes: @autoclosure () -> [String: String] = [:]) where Integer: BinaryInteger {
         add(value: Double(amount), attributes: attributes())
     }
 }
@@ -132,6 +144,8 @@ private final class NOPBench: BenchmarkProfiler, BenchmarkTracer, BenchmarkSpan,
     /// no-op
     func gauge(metric: @autoclosure () -> String) -> BenchmarkGauge { self }
     /// no-op
+    func observe(metric: @autoclosure () -> String, callback: @escaping (any BenchmarkGauge) -> Void) { }
+    /// no-op
     func add(value: Double, attributes: @autoclosure () -> [String: String]) { }
     /// no-op
     func record(value: Double, attributes: @autoclosure () -> [String: String]) { }
diff --git a/Package.swift b/Package.swift
@@ -81,7 +81,7 @@ let package = Package(
             resources: [
                 .copy("Resources/PrivacyInfo.xcprivacy")
             ],
-            swiftSettings: [.define("SPM_BUILD")]
+            swiftSettings: [.define("SPM_BUILD")] + internalSwiftSettings
         ),
         .target(
             name: "DatadogObjc",

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,10 @@ internal final class Meter: DatadogInternal.BenchmarkMeter {`
`68`	`68`	`func gauge(metric: @autoclosure () -> String) -> DatadogInternal.BenchmarkGauge {`
`69`	`69`	`meter.createDoubleMeasure(name: metric())`
`70`	`70`	`}`
	`71`	`+`
	`72`	`+ func observe(metric: @autoclosure () -> String, callback: @escaping (any DatadogInternal.BenchmarkGauge) -> Void) {`
	`73`	`+ _ = meter.createDoubleObserver(name: metric()) { callback(DoubleObserverWrapper(observer: $0)) }`
	`74`	`+ }`
`71`	`75`	`}`
`72`	`76`
`73`	`77`	`extension AnyCounterMetric<Double>: DatadogInternal.BenchmarkCounter {`
`@@ -81,3 +85,11 @@ extension AnyMeasureMetric<Double>: DatadogInternal.BenchmarkGauge {`
`81`	`85`	`record(value: value, labelset: LabelSet(labels: attributes()))`
`82`	`86`	`}`
`83`	`87`	`}`
	`88`	`+`
	`89`	`+private struct DoubleObserverWrapper: DatadogInternal.BenchmarkGauge {`
	`90`	`+ let observer: DoubleObserverMetric`
	`91`	`+`
	`92`	`+ func record(value: Double, attributes: @autoclosure () -> [String: String]) {`
	`93`	`+ observer.observe(value: value, labelset: LabelSet(labels: attributes()))`
	`94`	`+ }`
	`95`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,10 @@ internal class DataUploadWorker: DataUploadWorkerType {`
`139`	`139`	`batch,`
`140`	`140`	`reason: .intakeCode(responseCode: uploadStatus.responseCode)`
`141`	`141`	`)`
	`142`	`+#if DD_BENCHMARK`
	`143`	`+ bench.meter.counter(metric: "ios.benchmark.upload_count")`
	`144`	`+ .increment(attributes: ["track": self.featureName])`
	`145`	`+#endif`
`142`	`146`
`143`	`147`	`previousUploadStatus = nil`
`144`	`148`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,8 @@ internal struct FeatureUpload {`
`30`	`30`
`31`	`31`	`let dataUploader = DataUploader(`
`32`	`32`	`httpClient: httpClient,`
`33`		`- requestBuilder: requestBuilder`
	`33`	`+ requestBuilder: requestBuilder,`
	`34`	`+ featureName: featureName`
`34`	`35`	`)`
`35`	`36`
`36`	`37`	`#if canImport(UIKit)`
Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,13 @@ internal class URLSessionClient: HTTPClient {`
`35`	`35`	`self.session = session`
`36`	`36`	`}`
`37`	`37`
`38`		`- func send(request: URLRequest, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void) {`
	`38`	`+ func send(request: URLRequest, delegate: URLSessionTaskDelegate?, completion: @escaping (Result<HTTPURLResponse, Error>) -> Void) {`
`39`	`39`	`let task = session.dataTask(with: request) { data, response, error in`
`40`	`40`	`completion(httpClientResult(for: (data, response, error)))`
`41`	`41`	`}`
	`42`	`+ if #available(iOS 15.0, tvOS 15.0, watchOS 8.0, *) {`
	`43`	`+ task.delegate = delegate`
	`44`	`+ }`
`42`	`45`	`task.resume()`
`43`	`46`	`}`
`44`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -765,7 +765,8 @@ class DataUploadWorkerTests: XCTestCase {`
`765`	`765`
`766`	`766`	`let dataUploader = DataUploader(`
`767`	`767`	`httpClient: httpClient,`
`768`		`- requestBuilder: FeatureRequestBuilderMock()`
	`768`	`+ requestBuilder: FeatureRequestBuilderMock(),`
	`769`	`+ featureName: .mockRandom()`
`769`	`770`	`)`
`770`	`771`	`let worker = DataUploadWorker(`
`771`	`772`	`queue: uploaderQueue,`