feat: set sampling config via graphql client (#19)

- add flush API
- add Disable instrumentation logs, tracers, metrics
- refactor instrumentation manager

Author: mario-launchdarkly

ExampleApp/ExampleApp/AppDelegate.swift

@@ -9,7 +9,16 @@ let config = { () -> LDConfig in
         autoEnvAttributes: .enabled
     )
     config.plugins = [
-        Observability(options: .init(sessionBackgroundTimeout: 3, isDebug: true))
+        Observability(
+            options: .init(
+//                otlpEndpoint: "http://localhost:4318",
+                sessionBackgroundTimeout: 3,
+                isDebug: true,
+                disableLogs: false,
+                disableTraces: false,
+                disableMetrics: false
+            )
+        )
     ]
     return config
 }()

Package.swift

@@ -72,6 +72,16 @@ let package = Package(
                 .copy("Resources/Stubs/MinConfig.json")
             ]
         ),
+        .target(
+            name: "Instrumentation",
+            dependencies: [
+                "API",
+                "CrashReporter",
+                "Sampling",
+                .product(name: "OpenTelemetrySdk", package: "opentelemetry-swift"),
+                .product(name: "OpenTelemetryApi", package: "opentelemetry-swift"),
+            ]
+        ),
         .target(
             name: "Observability",
             dependencies: [
@@ -81,13 +91,14 @@ let package = Package(
                 "CrashReporterLive",
                 "Sampling",
                 "SamplingLive",
+                "Instrumentation",
                 .product(name: "OpenTelemetrySdk", package: "opentelemetry-swift"),
                 .product(name: "OpenTelemetryApi", package: "opentelemetry-swift"),
                 .product(name: "OpenTelemetryProtocolExporterHTTP", package: "opentelemetry-swift"),
                 .product(name: "URLSessionInstrumentation", package: "opentelemetry-swift"),
             ],
             resources: [
-                .copy("Resources/Config.json"),
+                .process("Resources"),
             ]
         ),
         .target(

Sources/API/Observe.swift

@@ -54,5 +54,5 @@ public protocol Observe {
      */
     func startSpan(name: String, attributes: [String: AttributeValue]) -> Span
 
-    func flush()
+    func flush() -> Bool
 }

Sources/Common/LDLogger.swift

@@ -0,0 +1,11 @@
+import OSLog
+
+public final class ObservabilityLogger {
+    public let log: OSLog
+    
+    public init(
+        name: String = "observability-sdk"
+    ) {
+        self.log = OSLog(subsystem: "com.launchdarkly", category: name)
+    }
+}

Sources/CrashReporterLive/LiveValue.swift

@@ -34,7 +34,7 @@ extension CrashReporter {
                 let installation = CrashInstallationStandard.shared
                 let config = KSCrashConfiguration()
 
-                config.deadlockWatchdogInterval = 5.0
+                config.deadlockWatchdogInterval = 0
                 config.enableMemoryIntrospection = true
                 config.monitors = .all
                 config.enableSigTermMonitoring = true

Sources/Instrumentation/Instrumentation.swift

@@ -0,0 +1,70 @@
+import OpenTelemetryApi
+
+import API
+import Sampling
+
+public struct Instrumentation {
+    public var recordMetric: (_ metric: Metric) -> Void
+    public var recordCount: (_ metric: Metric) -> Void
+    public var recordIncr: (_ metric: Metric) -> Void
+    public var recordHistogram: (_ metric: Metric) -> Void
+    public var recordUpDownCounter: (_ metric: Metric) -> Void
+    public var recordError: (_ error: Error, _ attributes: [String: AttributeValue]) -> Void
+    public var recordLog: (_ message: String, _ severity: Severity, _ attributes: [String: AttributeValue]) -> Void
+    public var startSpan: (_ name: String, _ attributes: [String: AttributeValue]) -> Span
+    public var flush: () -> Bool
+    
+    public init(
+        recordMetric: @escaping (_: Metric) -> Void,
+        recordCount: @escaping (_: Metric) -> Void,
+        recordIncr: @escaping (_: Metric) -> Void,
+        recordHistogram: @escaping (_: Metric) -> Void,
+        recordUpDownCounter: @escaping (_: Metric) -> Void,
+        recordError: @escaping (_: Error, _: [String : AttributeValue]) -> Void,
+        recordLog: @escaping (_: String, _: Severity, _: [String : AttributeValue]) -> Void,
+        startSpan: @escaping (_: String, _: [String : AttributeValue]) -> Span,
+        flush: @escaping () -> Bool
+    ) {
+        self.recordMetric = recordMetric
+        self.recordCount = recordCount
+        self.recordIncr = recordIncr
+        self.recordHistogram = recordHistogram
+        self.recordUpDownCounter = recordUpDownCounter
+        self.recordError = recordError
+        self.recordLog = recordLog
+        self.startSpan = startSpan
+        self.flush = flush
+    }
+    
+    public func recordMetric(metric: Metric) {
+        recordMetric(metric)
+    }
+
+    public func recordCount(metric: Metric) {
+        recordCount(metric)
+    }
+
+    public func recordIncr(metric: Metric) {
+        recordIncr(metric)
+    }
+
+    public func recordHistogram(metric: Metric) {
+        recordHistogram(metric)
+    }
+
+    public func recordUpDownCounter(metric: Metric) {
+        recordUpDownCounter(metric)
+    }
+
+    public func recordError(error: Error, attributes: [String: AttributeValue]) {
+        recordError(error, attributes)
+    }
+
+    public func recordLog(message: String, severity: Severity, attributes: [String: AttributeValue]) {
+        recordLog(message, severity, attributes)
+    }
+
+    public func startSpan(name: String, attributes: [String: AttributeValue]) -> Span {
+        startSpan(name, attributes)
+    }
+}

Sources/Instrumentation/InstrumentationError.swift

@@ -0,0 +1,3 @@
+public enum InstrumentationError: Error {
+    case graphQLUrlIsInvalid
+}

Sources/LaunchDarklyObservability/LDObserve.swift

@@ -12,12 +12,10 @@ private final class NoOpClient: Observe {
     func recordError(error: any Error, attributes: [String : AttributeValue]) {}
     func recordLog(message: String, severity: Severity, attributes: [String : AttributeValue]) {}
     func startSpan(name: String, attributes: [String : AttributeValue]) -> any Span {
-        OpenTelemetry.instance.tracerProvider.get(
-            instrumentationName: "",
-            instrumentationVersion: ""
-        ).spanBuilder(spanName: "").startSpan()
+        /// No-op implementation of the Tracer
+        DefaultTracer.instance.spanBuilder(spanName: "").startSpan()
     }
-    func flush() {}
+    func flush() -> Bool { true }
 }
 
 public final class LDObserve: @unchecked Sendable, Observe {
@@ -83,9 +81,9 @@ public final class LDObserve: @unchecked Sendable, Observe {
         return client.startSpan(name: name, attributes: attributes)
     }
 
-    public func flush() {
+    public func flush() -> Bool {
         lock.lock()
         defer { lock.unlock() }
-        client.flush()
+        return client.flush()
     }
 }

Sources/LaunchDarklyObservability/Plugin/Observability.swift

@@ -43,9 +43,12 @@ public final class Observability: Plugin {
             loggerName: options.loggerName
         )
         let client = ObservabilityClient(
-            sdkKey: sdkKey,
-            resource: .init(attributes: resourceAttributes),
-            options: options
+            context: .init(
+                sdkKey: sdkKey,
+                resource: .init(attributes: resourceAttributes),
+                options: options,
+                logger: .init(name: options.loggerName)
+            )
         )
 
         LDObserve.shared.set(client: client)