enabled swiftlint & fixed issues (#657)

* enabled swiftlint & fixed issues

* Made swiftlint plugin env-var enabled optional

* Update Package.swift

* Update [email protected]

Author: bryce-b

CONTRIBUTING.md

@@ -80,6 +80,13 @@ To test from the command line you need `swift` version `5.0+`.
 swift test
 ```
 
+### SwiftLint
+the SwiftLint Xcode plugin can be optionally enabled during development by using an environmental variable when opening the project from the commandline. 
+```
+OTEL_ENABLE_SWIFTLINT=1 open Package.swift
+```
+Note: Xcode must be completely closed before running the above command, close Xcode using `⌘Q` or running `killall xcode` in the commandline.  
+
 ### Make your modifications
 
 Always work in a branch from your fork:

Examples/Datadog Sample/main.swift

@@ -48,7 +48,7 @@ sleep(10)
 
 func testTraces() {
     let spanProcessor = SimpleSpanProcessor(spanExporter: datadogExporter)
-    
+
     OpenTelemetry.registerTracerProvider(tracerProvider:
         TracerProviderBuilder()
             .add(spanProcessor: spanProcessor)

Examples/Logs Sample/main.swift

@@ -11,19 +11,15 @@ import Logging
 import GRPC
 import NIO
 
-
 func configure() {
   let configuration = ClientConnection.Configuration.default(
-      target: .hostAndPort("localhost", 4317),
-      eventLoopGroup: MultiThreadedEventLoopGroup(numberOfThreads: 1))
+    target: .hostAndPort("localhost", 4317),
+    eventLoopGroup: MultiThreadedEventLoopGroup(numberOfThreads: 1))
 
-      OpenTelemetry.registerLoggerProvider(loggerProvider: LoggerProviderBuilder().with(processors: [
-        BatchLogRecordProcessor(logRecordExporter:OtlpLogExporter(channel: ClientConnection(configuration: configuration)))]).build())
-      
-  }
+  OpenTelemetry.registerLoggerProvider(loggerProvider: LoggerProviderBuilder().with(processors: [
+    BatchLogRecordProcessor(logRecordExporter: OtlpLogExporter(channel: ClientConnection(configuration: configuration)))]).build())
+}
 
   configure()
-        
+
   let eventProvider = OpenTelemetry.instance.loggerProvider.loggerBuilder(instrumentationScopeName: "myScope").setEventDomain("device").build()
-      
-      

Examples/Network Sample/main.swift

@@ -9,16 +9,15 @@ import OpenTelemetrySdk
 import StdoutExporter
 import URLSessionInstrumentation
 
-
 func simpleNetworkCall() {
     let url = URL(string: "http://httpbin.org/get")!
     let request = URLRequest(url: url)
     let semaphore = DispatchSemaphore(value: 0)
 
     let task = URLSession.shared.dataTask(with: request) { data, _, _ in
         if let data = data {
-            let string = String(decoding: data, as: UTF8.self)
-            print(string)
+          let string = String(bytes: data, encoding: .utf8)
+            print(string as Any)
         }
         semaphore.signal()
     }
@@ -27,7 +26,6 @@ func simpleNetworkCall() {
     semaphore.wait()
 }
 
-
 class SessionDelegate: NSObject, URLSessionDataDelegate, URLSessionTaskDelegate {
     let semaphore = DispatchSemaphore(value: 0)
 
@@ -39,7 +37,7 @@ let delegate = SessionDelegate()
 
 func simpleNetworkCallWithDelegate() {
 
-    let session = URLSession(configuration: .default, delegate: delegate, delegateQueue:nil)
+    let session = URLSession(configuration: .default, delegate: delegate, delegateQueue: nil)
 
     let url = URL(string: "http://httpbin.org/get")!
     let request = URLRequest(url: url)
@@ -50,7 +48,6 @@ func simpleNetworkCallWithDelegate() {
     delegate.semaphore.wait()
 }
 
-
 let spanProcessor = SimpleSpanProcessor(spanExporter: StdoutSpanExporter(isDebug: true))
 OpenTelemetry.registerTracerProvider(tracerProvider:
     TracerProviderBuilder()

Examples/OTLP Exporter/main.swift

@@ -44,7 +44,6 @@ OpenTelemetry.registerTracerProvider(tracerProvider:
 
 let tracer = OpenTelemetry.instance.tracerProvider.get(instrumentationName: instrumentationScopeName, instrumentationVersion: instrumentationScopeVersion)
 
-
 if #available(macOS 10.14, *), #available(iOS 12.0, *) {
     let tracerProviderSDK = OpenTelemetry.instance.tracerProvider as? TracerProviderSdk
     tracerProviderSDK?.addSpanProcessor(SignPostIntegration())
@@ -88,7 +87,6 @@ let meterProvider = MeterProviderSdk(metricProcessor: processor, metricExporter:
 
 OpenTelemetry.registerMeterProvider(meterProvider: meterProvider)
 
-
 let labels1 = ["dim1": "value1"]
 
 var meter = meterProvider.get(instrumentationName: "otlp_example_meter'")

Examples/OTLP HTTP Exporter/main.swift

@@ -48,15 +48,15 @@ func createSpans() {
         doWork()
     }
     Thread.sleep(forTimeInterval: 0.5)
-    
+
     let parentSpan2 = tracer.spanBuilder(spanName: "Another").setSpanKind(spanKind: .client).setActive(true).startSpan()
     parentSpan2.setAttribute(key: sampleKey, value: sampleValue)
     // do more Work
     for _ in 1...3 {
         doWork()
     }
     Thread.sleep(forTimeInterval: 0.5)
-    
+
     parentSpan2.end()
     parentSpan1.end()
 }
@@ -78,7 +78,6 @@ let meterProvider = MeterProviderSdk(metricProcessor: processor, metricExporter:
 
 OpenTelemetry.registerMeterProvider(meterProvider: meterProvider)
 
-
 var meter = meterProvider.get(instrumentationName: "otlp_example_meter'")
 var exampleCounter = meter.createIntCounter(name: "otlp_example_counter")
 var exampleMeasure = meter.createIntMeasure(name: "otlp_example_measure")

Examples/Prometheus Sample/main.swift

@@ -11,7 +11,7 @@ import PrometheusExporter
 print("Hello Prometheus")
 
 //
-//You should use here your real local address, change it also in the prometheus.yml file
+// You should use here your real local address, change it also in the prometheus.yml file
 let localAddress = "192.168.1.28"
 //
 
@@ -30,7 +30,6 @@ DispatchQueue.global(qos: .default).async {
 
 let processor = MetricProcessorSdk()
 
-
 let meterProvider = MeterProviderSdk(metricProcessor: processor, metricExporter: promExporter, metricPushInterval: 0.1)
 OpenTelemetry.registerMeterProvider(meterProvider: meterProvider)
 
@@ -39,7 +38,7 @@ var meter = meterProvider.get(instrumentationName: "MyMeter")
 var testCounter = meter.createIntCounter(name: "MyCounter")
 var testMeasure = meter.createIntMeasure(name: "MyMeasure")
 
-let boundaries: Array<Int> = [5, 10, 25]
+let boundaries: [Int] = [5, 10, 25]
 var testHistogram = meter.createIntHistogram(name: "MyHistogram", explicitBoundaries: boundaries, absolute: true)
 
 var testObserver = meter.createIntObserver(name: "MyObservation") { observer in

[email protected]

@@ -2,11 +2,12 @@
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
+import Foundation
 
 let package = Package(
     name: "opentelemetry-swift",
     platforms: [
-        .macOS(.v10_15),
+        .macOS(.v12),
         .iOS(.v13),
         .tvOS(.v13),
         .watchOS(.v6),
@@ -289,3 +290,15 @@ extension Package {
         return self
     }
 }
+
+if ProcessInfo.processInfo.environment["OTEL_ENABLE_SWIFTLINT"] != nil {
+  package.dependencies.append(contentsOf: [
+    .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", from: "0.57.1")
+  ])
+  
+  for target in package.targets {
+    target.plugins = [
+      .plugin(name: "SwiftLintBuildToolPlugin", package: "SwiftLintPlugins"),
+    ]
+  }
+}

Sources/Bridges/OTelSwiftLog/LogHandler.swift

@@ -8,19 +8,19 @@ let version: String = "1.0.0"
 
 /// A  custom log handler to translate swift logs into otel logs
 public struct OTelLogHandler: LogHandler {
-  
+
   /// Get or set the configured log level.
   ///
   /// - note: `LogHandler`s must treat the log level as a value type. This means that the change in metadata must
   ///         only affect this very `LogHandler`. It is acceptable to provide some form of global log level override
   ///         that means a change in log level on a particular `LogHandler` might not be reflected in any
   ///        `LogHandler`.
   public var logLevel: Logging.Logger.Level = .info
-  
+
   /// loggerProvider to use for the bridge.
-  private var loggerProvider : LoggerProvider
+  private var loggerProvider: LoggerProvider
   private var logger: OpenTelemetryApi.Logger
-  
+
   // Define metadata for this handler
   public var metadata: Logging.Logger.Metadata = [:]
   public subscript(metadataKey key: String) -> Logging.Logger.Metadata.Value? {
@@ -31,15 +31,15 @@ public struct OTelLogHandler: LogHandler {
       self.metadata[key] = newValue
     }
   }
-  
+
 /// create a new OtelLogHandler
 ///  - Parameter loggerProvider: The logger provider to use in the bridge. Defaults to the global logger provider.
 ///  - Parameter includeTraceContext : boolean flag used for the logger builder
 ///  - Parameter attributes: attributes to apply to the logger builder
   public init(loggerProvider: LoggerProvider = OpenTelemetryApi.DefaultLoggerProvider.instance,
-              includeTraceContext : Bool = true,
-              attributes: [String:AttributeValue] = [String:AttributeValue]()) {
-    
+              includeTraceContext: Bool = true,
+              attributes: [String: AttributeValue] = [String: AttributeValue]()) {
+
     self.loggerProvider = loggerProvider
     self.logger = self.loggerProvider.loggerBuilder(instrumentationScopeName: bridgeName)
       .setInstrumentationVersion(version)
@@ -49,62 +49,59 @@ public struct OTelLogHandler: LogHandler {
       .setIncludeTraceContext(includeTraceContext)
       .build()
   }
-  
+
   public func log(level: Logging.Logger.Level,
                   message: Logging.Logger.Message,
                   metadata: Logging.Logger.Metadata?,
                   source: String,
                   file: String,
                   function: String,
                   line: UInt) {
-    
-    
+
     // This converts log atrributes to otel attributes
     var otelattributes: [String: AttributeValue] = [
       "source": AttributeValue.string(source),
       "file": AttributeValue.string(file),
       "function": AttributeValue.string(function),
-      "line": AttributeValue.int(Int(line)),
+      "line": AttributeValue.int(Int(line))
     ]
-    
+
     // Convert metadata from the method parameter to AttributeValue and assign it to otelattributes
     if let metadata = metadata {
       let methodMetadata = convertMetadata(metadata)
       otelattributes.merge(methodMetadata) { _, new in new }
     }
-    
+
     // Convert metadata from the struct property to AttributeValue and merge it with otelattributes
     let structMetadata = convertMetadata(self.metadata)
     otelattributes.merge(structMetadata) { _, new in new }
-    
+
     // Build the log record and emit it
     let event = self.logger.logRecordBuilder().setSeverity(convertSeverity(level: level))
       .setBody(AttributeValue.string(message.description))
       .setAttributes(otelattributes)
-    
+
     if let context = OpenTelemetry.instance.contextProvider.activeSpan?.context {
       _ = event.setSpanContext(context)
     }
     event.emit()
-    
+
   }
-  
-  
-  
+
 }
 
 func convertMetadata(_ metadata: Logging.Logger.Metadata) -> [String: AttributeValue] {
   var convertedAttributes: [String: AttributeValue] = [:]
-  
+
   // Iterate over each key-value pair in the metadata dictionary
   for (key, value) in metadata {
     // Convert each value to AttributeValue
     let attributeValue = convertToAttributeValue(value)
-    
+
     // Store the converted value with its corresponding key in the attributes dictionary
     convertedAttributes[key] = attributeValue
   }
-  
+
   return convertedAttributes
 }
 
@@ -126,11 +123,11 @@ func convertToAttributeValue(_ value: Logging.Logger.Metadata.Value) -> Attribut
     return AttributeValue(str)
   case .stringConvertible(let strConvertable):
     return AttributeValue(strConvertable.description)
-    
+
   }
 }
 
-func convertSeverity(level: Logging.Logger.Level) -> OpenTelemetryApi.Severity{
+func convertSeverity(level: Logging.Logger.Level) -> OpenTelemetryApi.Severity {
   switch level {
   case .trace:
     return OpenTelemetryApi.Severity.trace
@@ -145,6 +142,6 @@ func convertSeverity(level: Logging.Logger.Level) -> OpenTelemetryApi.Severity{
   case .error:
     return OpenTelemetryApi.Severity.error
   case .critical:
-    return OpenTelemetryApi.Severity.error2  //should this be fatal instead?
+    return OpenTelemetryApi.Severity.error2  // should this be fatal instead?
   }
 }