From e5601708cc6199e4a5a28f48bf0cf30ec746af3b Mon Sep 17 00:00:00 2001 From: Bryce Buchanan Date: Wed, 20 Dec 2023 09:04:56 -0800 Subject: [PATCH] removed NIO dependency and replaced with Lock.swift --- Package.swift | 9 +- Package@swift-5.6.swift | 9 +- Package@swift-5.9.swift | 6 +- .../OpenTelemetryProtocolHttp/Lock.swift | 198 ++++++++++++++++++ .../logs/OtlpHttpLogExporter.swift | 4 +- .../metric/OltpHTTPMetricExporter.swift | 5 +- .../metric/StableOtlpHTTPMetricExporter.swift | 4 +- .../trace/OtlpHttpTraceExporter.swift | 4 +- 8 files changed, 210 insertions(+), 29 deletions(-) create mode 100644 Sources/Exporters/OpenTelemetryProtocolHttp/Lock.swift diff --git a/Package.swift b/Package.swift index 4198ca1c..1f10a928 100644 --- a/Package.swift +++ b/Package.swift @@ -92,19 +92,16 @@ let package = Package( .target(name: "OpenTelemetryProtocolExporterCommon", dependencies: ["OpenTelemetrySdk", .product(name: "Logging", package: "swift-log"), - .product(name: "SwiftProtobuf", package: "swift-protobuf"), - .product(name: "NIO", package: "swift-nio")], + .product(name: "SwiftProtobuf", package: "swift-protobuf")], path: "Sources/Exporters/OpenTelemetryProtocolCommon"), .target(name: "OpenTelemetryProtocolExporterHttp", dependencies: ["OpenTelemetrySdk", - "OpenTelemetryProtocolExporterCommon", - .product(name: "NIO", package: "swift-nio")], + "OpenTelemetryProtocolExporterCommon"], path: "Sources/Exporters/OpenTelemetryProtocolHttp"), .target(name: "OpenTelemetryProtocolExporterGrpc", dependencies: ["OpenTelemetrySdk", "OpenTelemetryProtocolExporterCommon", - .product(name: "GRPC", package: "grpc-swift"), - .product(name: "NIO", package: "swift-nio")], + .product(name: "GRPC", package: "grpc-swift")], path: "Sources/Exporters/OpenTelemetryProtocolGrpc"), .target(name: "StdoutExporter", dependencies: ["OpenTelemetrySdk"], diff --git a/Package@swift-5.6.swift b/Package@swift-5.6.swift index b1ee81fc..2871b171 100644 --- a/Package@swift-5.6.swift +++ b/Package@swift-5.6.swift @@ -97,19 +97,16 @@ let package = Package( .target(name: "OpenTelemetryProtocolExporterCommon", dependencies: ["OpenTelemetrySdk", .product(name: "Logging", package: "swift-log"), - .product(name: "SwiftProtobuf", package: "swift-protobuf"), - .product(name: "NIO", package: "swift-nio")], + .product(name: "SwiftProtobuf", package: "swift-protobuf")], path: "Sources/Exporters/OpenTelemetryProtocolCommon"), .target(name: "OpenTelemetryProtocolExporterHttp", dependencies: ["OpenTelemetrySdk", - "OpenTelemetryProtocolExporterCommon", - .product(name: "NIO", package: "swift-nio")], + "OpenTelemetryProtocolExporterCommon"], path: "Sources/Exporters/OpenTelemetryProtocolHttp"), .target(name: "OpenTelemetryProtocolExporterGrpc", dependencies: ["OpenTelemetrySdk", "OpenTelemetryProtocolExporterCommon", - .product(name: "GRPC", package: "grpc-swift"), - .product(name: "NIO", package: "swift-nio")], + .product(name: "GRPC", package: "grpc-swift")], path: "Sources/Exporters/OpenTelemetryProtocolGrpc"), .target(name: "StdoutExporter", dependencies: ["OpenTelemetrySdk"], diff --git a/Package@swift-5.9.swift b/Package@swift-5.9.swift index 25e06ebb..45e45172 100644 --- a/Package@swift-5.9.swift +++ b/Package@swift-5.9.swift @@ -99,14 +99,12 @@ let package = Package( path: "Sources/Exporters/OpenTelemetryProtocolCommon"), .target(name: "OpenTelemetryProtocolExporterHttp", dependencies: ["OpenTelemetrySdk", - "OpenTelemetryProtocolExporterCommon", - .product(name: "NIO", package: "swift-nio")], + "OpenTelemetryProtocolExporterCommon"], path: "Sources/Exporters/OpenTelemetryProtocolHttp"), .target(name: "OpenTelemetryProtocolExporterGrpc", dependencies: ["OpenTelemetrySdk", "OpenTelemetryProtocolExporterCommon", - .product(name: "GRPC", package: "grpc-swift"), - .product(name: "NIO", package: "swift-nio")], + .product(name: "GRPC", package: "grpc-swift")], path: "Sources/Exporters/OpenTelemetryProtocolGrpc"), .target(name: "StdoutExporter", dependencies: ["OpenTelemetrySdk"], diff --git a/Sources/Exporters/OpenTelemetryProtocolHttp/Lock.swift b/Sources/Exporters/OpenTelemetryProtocolHttp/Lock.swift new file mode 100644 index 00000000..5a51c654 --- /dev/null +++ b/Sources/Exporters/OpenTelemetryProtocolHttp/Lock.swift @@ -0,0 +1,198 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +//===----------------------------------------------------------------------===// +// +// This source file is part of the Swift Metrics API open source project +// +// Copyright (c) 2018-2019 Apple Inc. and the Swift Metrics API project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of Swift Metrics API project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===// + +//===----------------------------------------------------------------------===// +// +// This source file is part of the SwiftNIO open source project +// +// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of SwiftNIO project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===// + +#if os(macOS) || os(iOS) || os(tvOS) || os(watchOS) +import Darwin +#else +import Glibc +#endif + +/// A threading lock based on `libpthread` instead of `libdispatch`. +/// +/// This object provides a lock on top of a single `pthread_mutex_t`. This kind +/// of lock is safe to use with `libpthread`-based threading models, such as the +/// one used by NIO. +internal final class Lock { + fileprivate let mutex: UnsafeMutablePointer = UnsafeMutablePointer.allocate(capacity: 1) + + /// Create a new lock. + public init() { + let err = pthread_mutex_init(self.mutex, nil) + precondition(err == 0, "pthread_mutex_init failed with error \(err)") + } + + deinit { + let err = pthread_mutex_destroy(self.mutex) + precondition(err == 0, "pthread_mutex_destroy failed with error \(err)") + self.mutex.deallocate() + } + + /// Acquire the lock. + /// + /// Whenever possible, consider using `withLock` instead of this method and + /// `unlock`, to simplify lock handling. + public func lock() { + let err = pthread_mutex_lock(self.mutex) + precondition(err == 0, "pthread_mutex_lock failed with error \(err)") + } + + /// Release the lock. + /// + /// Whenever possible, consider using `withLock` instead of this method and + /// `lock`, to simplify lock handling. + public func unlock() { + let err = pthread_mutex_unlock(self.mutex) + precondition(err == 0, "pthread_mutex_unlock failed with error \(err)") + } +} + +extension Lock { + /// Acquire the lock for the duration of the given block. + /// + /// This convenience method should be preferred to `lock` and `unlock` in + /// most situations, as it ensures that the lock will be released regardless + /// of how `body` exits. + /// + /// - Parameter body: The block to execute while holding the lock. + /// - Returns: The value returned by the block. + @inlinable + internal func withLock(_ body: () throws -> T) rethrows -> T { + self.lock() + defer { + self.unlock() + } + return try body() + } + + // specialise Void return (for performance) + @inlinable + internal func withLockVoid(_ body: () throws -> Void) rethrows { + try self.withLock(body) + } +} + +/// A threading lock based on `libpthread` instead of `libdispatch`. +/// +/// This object provides a lock on top of a single `pthread_mutex_t`. This kind +/// of lock is safe to use with `libpthread`-based threading models, such as the +/// one used by NIO. +internal final class ReadWriteLock { + fileprivate let rwlock: UnsafeMutablePointer = UnsafeMutablePointer.allocate(capacity: 1) + + /// Create a new lock. + public init() { + let err = pthread_rwlock_init(self.rwlock, nil) + precondition(err == 0, "pthread_rwlock_init failed with error \(err)") + } + + deinit { + let err = pthread_rwlock_destroy(self.rwlock) + precondition(err == 0, "pthread_rwlock_destroy failed with error \(err)") + self.rwlock.deallocate() + } + + /// Acquire a reader lock. + /// + /// Whenever possible, consider using `withLock` instead of this method and + /// `unlock`, to simplify lock handling. + public func lockRead() { + let err = pthread_rwlock_rdlock(self.rwlock) + precondition(err == 0, "pthread_rwlock_rdlock failed with error \(err)") + } + + /// Acquire a writer lock. + /// + /// Whenever possible, consider using `withLock` instead of this method and + /// `unlock`, to simplify lock handling. + public func lockWrite() { + let err = pthread_rwlock_wrlock(self.rwlock) + precondition(err == 0, "pthread_rwlock_wrlock failed with error \(err)") + } + + /// Release the lock. + /// + /// Whenever possible, consider using `withLock` instead of this method and + /// `lock`, to simplify lock handling. + public func unlock() { + let err = pthread_rwlock_unlock(self.rwlock) + precondition(err == 0, "pthread_rwlock_unlock failed with error \(err)") + } +} + +extension ReadWriteLock { + /// Acquire the reader lock for the duration of the given block. + /// + /// This convenience method should be preferred to `lock` and `unlock` in + /// most situations, as it ensures that the lock will be released regardless + /// of how `body` exits. + /// + /// - Parameter body: The block to execute while holding the lock. + /// - Returns: The value returned by the block. + @inlinable + internal func withReaderLock(_ body: () throws -> T) rethrows -> T { + self.lockRead() + defer { + self.unlock() + } + return try body() + } + + /// Acquire the writer lock for the duration of the given block. + /// + /// This convenience method should be preferred to `lock` and `unlock` in + /// most situations, as it ensures that the lock will be released regardless + /// of how `body` exits. + /// + /// - Parameter body: The block to execute while holding the lock. + /// - Returns: The value returned by the block. + @inlinable + internal func withWriterLock(_ body: () throws -> T) rethrows -> T { + self.lockWrite() + defer { + self.unlock() + } + return try body() + } + + // specialise Void return (for performance) + @inlinable + internal func withReaderLockVoid(_ body: () throws -> Void) rethrows { + try self.withReaderLock(body) + } + + // specialise Void return (for performance) + @inlinable + internal func withWriterLockVoid(_ body: () throws -> Void) rethrows { + try self.withWriterLock(body) + } +} diff --git a/Sources/Exporters/OpenTelemetryProtocolHttp/logs/OtlpHttpLogExporter.swift b/Sources/Exporters/OpenTelemetryProtocolHttp/logs/OtlpHttpLogExporter.swift index 72d26d6f..4e982913 100644 --- a/Sources/Exporters/OpenTelemetryProtocolHttp/logs/OtlpHttpLogExporter.swift +++ b/Sources/Exporters/OpenTelemetryProtocolHttp/logs/OtlpHttpLogExporter.swift @@ -6,8 +6,6 @@ import Foundation import OpenTelemetrySdk import OpenTelemetryProtocolExporterCommon -import NIO -import NIOConcurrencyHelpers public func defaultOltpHttpLoggingEndpoint() -> URL { URL(string: "http://localhost:4318/v1/logs")! @@ -16,7 +14,7 @@ public func defaultOltpHttpLoggingEndpoint() -> URL { public class OtlpHttpLogExporter : OtlpHttpExporterBase, LogRecordExporter { var pendingLogRecords: [ReadableLogRecord] = [] - private let exporterLock = NIOLock() + private let exporterLock = Lock() override public init(endpoint: URL = defaultOltpHttpLoggingEndpoint(), config: OtlpConfiguration = OtlpConfiguration(), useSession: URLSession? = nil, diff --git a/Sources/Exporters/OpenTelemetryProtocolHttp/metric/OltpHTTPMetricExporter.swift b/Sources/Exporters/OpenTelemetryProtocolHttp/metric/OltpHTTPMetricExporter.swift index c0308350..c8c253e0 100644 --- a/Sources/Exporters/OpenTelemetryProtocolHttp/metric/OltpHTTPMetricExporter.swift +++ b/Sources/Exporters/OpenTelemetryProtocolHttp/metric/OltpHTTPMetricExporter.swift @@ -6,9 +6,6 @@ import OpenTelemetrySdk import OpenTelemetryProtocolExporterCommon import Foundation -import NIO -import NIOConcurrencyHelpers - public func defaultOltpHTTPMetricsEndpoint() -> URL { URL(string: "http://localhost:4318/v1/metrics")! @@ -16,7 +13,7 @@ public func defaultOltpHTTPMetricsEndpoint() -> URL { public class OtlpHttpMetricExporter: OtlpHttpExporterBase, MetricExporter { var pendingMetrics: [Metric] = [] - private let exporterLock = NIOLock() + private let exporterLock = Lock() override public init(endpoint: URL = defaultOltpHTTPMetricsEndpoint(), config : OtlpConfiguration = OtlpConfiguration(), useSession: URLSession? = nil, envVarHeaders: [(String,String)]? = EnvVarHeaders.attributes) { diff --git a/Sources/Exporters/OpenTelemetryProtocolHttp/metric/StableOtlpHTTPMetricExporter.swift b/Sources/Exporters/OpenTelemetryProtocolHttp/metric/StableOtlpHTTPMetricExporter.swift index eecc6138..cf0999de 100644 --- a/Sources/Exporters/OpenTelemetryProtocolHttp/metric/StableOtlpHTTPMetricExporter.swift +++ b/Sources/Exporters/OpenTelemetryProtocolHttp/metric/StableOtlpHTTPMetricExporter.swift @@ -6,8 +6,6 @@ import Foundation import OpenTelemetrySdk import OpenTelemetryProtocolExporterCommon -import NIO -import NIOConcurrencyHelpers public func defaultStableOtlpHTTPMetricsEndpoint() -> URL { URL(string: "http://localhost:4318/v1/metrics")! @@ -18,7 +16,7 @@ public class StableOtlpHTTPMetricExporter: StableOtlpHTTPExporterBase, StableMet var defaultAggregationSelector: DefaultAggregationSelector var pendingMetrics: [StableMetricData] = [] - private let exporterLock = NIOLock() + private let exporterLock = Lock() // MARK: - Init diff --git a/Sources/Exporters/OpenTelemetryProtocolHttp/trace/OtlpHttpTraceExporter.swift b/Sources/Exporters/OpenTelemetryProtocolHttp/trace/OtlpHttpTraceExporter.swift index baae72e2..ceee8362 100644 --- a/Sources/Exporters/OpenTelemetryProtocolHttp/trace/OtlpHttpTraceExporter.swift +++ b/Sources/Exporters/OpenTelemetryProtocolHttp/trace/OtlpHttpTraceExporter.swift @@ -6,8 +6,6 @@ import Foundation import OpenTelemetrySdk import OpenTelemetryProtocolExporterCommon -import NIO -import NIOConcurrencyHelpers public func defaultOltpHttpTracesEndpoint() -> URL { URL(string: "http://localhost:4318/v1/traces")! @@ -17,7 +15,7 @@ public class OtlpHttpTraceExporter: OtlpHttpExporterBase, SpanExporter { var pendingSpans: [SpanData] = [] - private let exporterLock = NIOLock() + private let exporterLock = Lock() override public init(endpoint: URL = defaultOltpHttpTracesEndpoint(), config: OtlpConfiguration = OtlpConfiguration(), useSession: URLSession? = nil, envVarHeaders: [(String,String)]? = EnvVarHeaders.attributes) {