Simplifies Queue logic, and removes FileRead queue that was not being used.

For UploadWorker and FileWriter internally created queues are used
It makes Persistence exporter simples to configure providing some default values

Author: Ignacio Bonafonte

Sources/Exporters/DatadogExporter/Logs/LogEncoder.swift

@@ -16,7 +16,7 @@ internal struct LogAttributes {
 
 /// `Encodable` representation of log. It gets sanitized before encoding.
 internal struct DDLog: Encodable {
-    internal struct TracingAttributes {
+    internal enum TracingAttributes {
         static let traceID = "dd.trace_id"
         static let spanID = "dd.span_id"
     }
@@ -80,7 +80,7 @@ internal struct DDLog: Encodable {
         self.threadName = attributes.removeValue(forKey: "threadName")?.description ?? "unkown"
         self.applicationVersion = configuration.version
 
-        let userAttributes:  [String: Encodable] = attributes.mapValues{
+        let userAttributes: [String: Encodable] = attributes.mapValues {
             switch $0 {
                 case let .string(value):
                     return value

Sources/Exporters/DatadogExporter/Logs/LogSanitizer.swift

@@ -7,7 +7,7 @@ import Foundation
 
 /// Sanitizes `Log` representation received from the user, so it can match Datadog log constraints.
 internal struct LogSanitizer {
-    struct Constraints {
+    enum Constraints {
         /// Attribute names reserved for Datadog.
         /// If any of those is used by the user, the attribute will be ignored.
         static let reservedAttributeNames: Set<String> = [
@@ -23,7 +23,7 @@ internal struct LogSanitizer {
         static let maxNumberOfAttributes: Int = 256
         /// Allowed first character of a tag name (given as ASCII values ranging from lowercased `a` to `z`) .
         /// Tags with name starting with different character will be dropped.
-        static let allowedTagNameFirstCharacterASCIIRange: [UInt8] = Array(97...122)
+        static let allowedTagNameFirstCharacterASCIIRange: [UInt8] = Array(97 ... 122)
         /// Maximum lenght of the tag.
         /// Tags exceeting this lenght will be trunkated.
         static let maxTagLength: Int = 200

Sources/Exporters/DatadogExporter/Logs/LogsExporter.swift

@@ -17,14 +17,9 @@ internal enum LogLevel: Int, Codable {
 
 internal class LogsExporter {
     let logsDirectory = "com.otel.datadog.logs/v1"
-
     let configuration: ExporterConfiguration
-
     let logsStorage: FeatureStorage
-    let logsStorageQueue = DispatchQueue(label: "com.otel.datadog.logswriter", target: .global(qos: .userInteractive))
-
     let logsUpload: FeatureUpload
-    let logsUploadQueue = DispatchQueue(label: "com.otel.datadog.logsupload", target: .global(qos: .userInteractive))
 
     init(config: ExporterConfiguration) throws {
         self.configuration = config
@@ -39,14 +34,12 @@ internal class LogsExporter {
 
         let logsFileWriter = FileWriter(
             dataFormat: dataFormat,
-            orchestrator: filesOrchestrator,
-            queue: logsStorageQueue
+            orchestrator: filesOrchestrator
         )
 
         let logsFileReader = FileReader(
             dataFormat: dataFormat,
-            orchestrator: filesOrchestrator,
-            queue: logsUploadQueue
+            orchestrator: filesOrchestrator
         )
 
         logsStorage = FeatureStorage(writer: logsFileWriter, reader: logsFileReader)
@@ -68,7 +61,6 @@ internal class LogsExporter {
                 .ddEVPOriginVersionHeader(version: configuration.version),
                 .ddRequestIDHeader()
             ] + (configuration.payloadCompression ? [RequestBuilder.HTTPHeader.contentEncodingHeader(contentEncoding: .deflate)] : [])
-
         )
 
         logsUpload = FeatureUpload(featureName: "logsUpload",

Sources/Exporters/DatadogExporter/Metrics/MetricsExporter.swift

@@ -8,14 +8,9 @@ import OpenTelemetrySdk
 
 internal class MetricsExporter {
     let metricsDirectory = "com.otel.datadog.metrics/v1"
-
     let configuration: ExporterConfiguration
-
     let metricsStorage: FeatureStorage
-    let metricsStorageQueue = DispatchQueue(label: "com.otel.datadog.metricswriter", target: .global(qos: .userInteractive))
-
     let metricsUpload: FeatureUpload
-    let metricsUploadQueue = DispatchQueue(label: "com.otel.datadog.metricsupload", target: .global(qos: .userInteractive))
 
     init(config: ExporterConfiguration) throws {
         configuration = config
@@ -30,14 +25,12 @@ internal class MetricsExporter {
 
         let spanFileWriter = FileWriter(
             dataFormat: dataFormat,
-            orchestrator: filesOrchestrator,
-            queue: metricsStorageQueue
+            orchestrator: filesOrchestrator
         )
 
         let spanFileReader = FileReader(
             dataFormat: dataFormat,
-            orchestrator: filesOrchestrator,
-            queue: metricsUploadQueue
+            orchestrator: filesOrchestrator
         )
 
         metricsStorage = FeatureStorage(writer: spanFileWriter, reader: spanFileReader)

Sources/Exporters/DatadogExporter/Persistence/FileReader.swift

@@ -17,16 +17,12 @@ internal final class FileReader {
     private let dataFormat: DataFormat
     /// Orchestrator producing reference to readable file.
     private let orchestrator: FilesOrchestrator
-    /// Queue used to synchronize files access (read / write).
-    private let queue: DispatchQueue
-
     /// Files marked as read.
     private var filesRead: [ReadableFile] = []
 
-    init(dataFormat: DataFormat, orchestrator: FilesOrchestrator, queue: DispatchQueue) {
+    init(dataFormat: DataFormat, orchestrator: FilesOrchestrator) {
         self.dataFormat = dataFormat
         self.orchestrator = orchestrator
-        self.queue = queue
     }
 
     // MARK: - Reading batches

Sources/Exporters/DatadogExporter/Persistence/FileWriter.swift

@@ -13,17 +13,16 @@ internal final class FileWriter {
     /// JSON encoder used to encode data.
     private let jsonEncoder: JSONEncoder
     /// Queue used to synchronize files access (read / write) and perform decoding on background thread.
-    // Temporarily internal so tests can wait for the writer to finish before exiting
-    internal let queue: DispatchQueue
+    internal let queue = DispatchQueue(label: "com.otel.datadog.filewriter", target: .global(qos: .userInteractive))
 
-    init(dataFormat: DataFormat, orchestrator: FilesOrchestrator, queue: DispatchQueue) {
+    init(dataFormat: DataFormat, orchestrator: FilesOrchestrator) {
         self.dataFormat = dataFormat
         self.orchestrator = orchestrator
-        self.queue = queue
         self.jsonEncoder = JSONEncoder.default()
     }
 
     // MARK: - Writing data
+
     /// Encodes given value to JSON data and writes it to file.
     /// Comma is used to separate consecutive values in the file.
 

Sources/Exporters/DatadogExporter/Spans/SpansExporter.swift

@@ -8,14 +8,9 @@ import OpenTelemetrySdk
 
 internal class SpansExporter {
     let tracesDirectory = "com.otel.datadog.traces/v1"
-
     let configuration: ExporterConfiguration
-
     let tracesStorage: FeatureStorage
-    let tracesStorageQueue = DispatchQueue(label: "com.otel.datadog.traceswriter", target: .global(qos: .userInteractive))
-
     let tracesUpload: FeatureUpload
-    let tracesUploadQueue = DispatchQueue(label: "com.otel.datadog.tracesupload", target: .global(qos: .userInteractive))
 
     init(config: ExporterConfiguration) throws {
         self.configuration = config
@@ -30,14 +25,12 @@ internal class SpansExporter {
 
         let spanFileWriter = FileWriter(
             dataFormat: dataFormat,
-            orchestrator: filesOrchestrator,
-            queue: tracesStorageQueue
+            orchestrator: filesOrchestrator
         )
 
         let spanFileReader = FileReader(
             dataFormat: dataFormat,
-            orchestrator: filesOrchestrator,
-            queue: tracesUploadQueue
+            orchestrator: filesOrchestrator
         )
 
         tracesStorage = FeatureStorage(writer: spanFileWriter, reader: spanFileReader)

Sources/Exporters/DatadogExporter/Upload/DataUploadWorker.swift

@@ -13,7 +13,7 @@ internal protocol DataUploadWorkerType {
 
 internal class DataUploadWorker: DataUploadWorkerType {
     /// Queue to execute uploads.
-    private let queue: DispatchQueue
+    internal let queue = DispatchQueue(label: "com.otel.datadog.datauploadworker", target: .global(qos: .utility))
     /// File reader providing data to upload.
     private let fileReader: FileReader
     /// Data uploader sending data to server.
@@ -31,14 +31,12 @@ internal class DataUploadWorker: DataUploadWorkerType {
     private var uploadWork: DispatchWorkItem?
 
     init(
-        queue: DispatchQueue,
         fileReader: FileReader,
         dataUploader: DataUploaderType,
         uploadCondition: @escaping () -> Bool,
         delay: Delay,
         featureName: String
     ) {
-        self.queue = queue
         self.fileReader = fileReader
         self.uploadCondition = uploadCondition
         self.dataUploader = dataUploader

Sources/Exporters/DatadogExporter/Utils/Feature.swift

@@ -36,19 +36,13 @@ internal struct FeatureUpload {
         performance: PerformancePreset,
         uploadCondition: @escaping () -> Bool
     ) {
-        let uploadQueue = DispatchQueue(
-            label: "com.datadoghq.ios-sdk-\(featureName)-upload",
-            target: .global(qos: .utility)
-        )
-
         let dataUploader = DataUploader(
             httpClient: HTTPClient(),
             requestBuilder: requestBuilder
         )
 
         self.init(
             uploader: DataUploadWorker(
-                queue: uploadQueue,
                 fileReader: storage.reader,
                 dataUploader: dataUploader,
                 uploadCondition: uploadCondition,

Sources/Exporters/Persistence/Export/DataExportWorker.swift

@@ -18,7 +18,7 @@ internal protocol DataExportWorkerProtocol {
 
 internal class DataExportWorker: DataExportWorkerProtocol {
     /// Queue to execute exports.
-    private let queue: DispatchQueue
+    internal let queue = DispatchQueue(label: "com.otel.datadog.dataExportWorker", target: .global(qos: .utility))
     /// File reader providing data to export.
     private let fileReader: FileReader
     /// Data exporter sending data to server.
@@ -33,13 +33,11 @@ internal class DataExportWorker: DataExportWorkerProtocol {
     private var exportWork: DispatchWorkItem?
 
     init(
-        queue: DispatchQueue,
         fileReader: FileReader,
         dataExporter: DataExporter,
         exportCondition: @escaping () -> Bool,
         delay: Delay
     ) {
-        self.queue = queue
         self.fileReader = fileReader
         self.exportCondition = exportCondition
         self.dataExporter = dataExporter
@@ -52,7 +50,7 @@ internal class DataExportWorker: DataExportWorkerProtocol {
 
             let isSystemReady = self.exportCondition()
             let nextBatch = isSystemReady ? self.fileReader.readNextBatch() : nil
-            if let batch = nextBatch {                
+            if let batch = nextBatch {
                 // Export batch
                 let exportStatus = self.dataExporter.export(data: batch.data)