Merge pull request #147 from nachoBonafonte/Null-or-empty-name-passed-to-TracerProvider.getTracer()-should-log-the-error

TracerProviderSdk must log if the name is empty and use a default name. Fixes #139
Added tests for TracerProviderSdk
Also added default resources to EnvVarResources

Author: Ignacio Bonafonte

Sources/OpenTelemetrySdk/Resources/EnvVarResource.swift

@@ -24,7 +24,7 @@ public struct EnvVarResource {
 
     ///  This resource information is loaded from the OC_RESOURCE_LABELS
     ///  environment variable.
-    public static let resource = Resource(attributes: parseResourceAttributes(rawEnvAttributes: ProcessInfo.processInfo.environment[otelResourceAttributesEnv]))
+    public static let resource = Resource(attributes: parseResourceAttributes(rawEnvAttributes: ProcessInfo.processInfo.environment[otelResourceAttributesEnv])).merging(other: Resource())
 
     private init() {}
 

Sources/OpenTelemetrySdk/Trace/NoopSpanProcessor.swift

@@ -16,17 +16,17 @@
 import Foundation
 import OpenTelemetryApi
 
-public struct NoopSpanProcessor: SpanProcessor {
-    public init() {}
+struct NoopSpanProcessor: SpanProcessor {
+    init() {}
 
-    public let isStartRequired = false
-    public let isEndRequired = false
+    let isStartRequired = false
+    let isEndRequired = false
 
-    public func onStart(parentContext: SpanContext?, span: ReadableSpan) {}
+    func onStart(parentContext: SpanContext?, span: ReadableSpan) {}
 
-    public func onEnd(span: ReadableSpan) {}
+    func onEnd(span: ReadableSpan) {}
 
-    public func shutdown() {}
+    func shutdown() {}
 
-    public func forceFlush() {}
+    func forceFlush() {}
 }

Sources/OpenTelemetrySdk/Trace/TracerProviderSdk.swift

@@ -20,19 +20,35 @@ import OpenTelemetryApi
 public class TracerProviderSdk: TracerProvider {
     private var tracerProvider = [InstrumentationLibraryInfo: TracerSdk]()
     internal var sharedState: TracerSharedState
+    internal static let emptyName = "unknown"
 
     /// Returns a new TracerProviderSdk with default Clock, IdGenerator and Resource.
     public init(clock: Clock = MillisClock(),
                 idGenerator: IdGenerator = RandomIdGenerator(),
-                resource: Resource = EnvVarResource.resource)
+                resource: Resource = EnvVarResource.resource,
+                spanLimits: SpanLimits = SpanLimits(),
+                sampler: Sampler = Samplers.parentBased(root: Samplers.alwaysOn),
+                spanProcessors: [SpanProcessor] = [])
     {
-        sharedState = TracerSharedState(clock: clock, idGenerator: idGenerator, resource: resource)
+        sharedState = TracerSharedState(clock: clock,
+                                        idGenerator: idGenerator,
+                                        resource: resource,
+                                        spanLimits: spanLimits,
+                                        sampler: sampler,
+                                        spanProcessors: spanProcessors)
     }
 
     public func get(instrumentationName: String, instrumentationVersion: String? = nil) -> Tracer {
         if sharedState.hasBeenShutdown {
             return DefaultTracer.instance
         }
+
+        var instrumentationName = instrumentationName
+        if instrumentationName.isEmpty {
+            // Per the spec, empty is "invalid"
+            print("Tracer requested without instrumentation name.")
+            instrumentationName = TracerProviderSdk.emptyName
+        }
         let instrumentationLibraryInfo = InstrumentationLibraryInfo(name: instrumentationName, version: instrumentationVersion ?? "")
         if let tracer = tracerProvider[instrumentationLibraryInfo] {
             return tracer

Sources/OpenTelemetrySdk/Trace/TracerSharedState.swift

@@ -21,24 +21,45 @@ class TracerSharedState {
     var idGenerator: IdGenerator
     var resource: Resource
 
-    var sampler: Sampler = ParentBasedSampler(root: Samplers.alwaysOn)
-    var activeSpanLimits = SpanLimits()
-    var activeSpanProcessor: SpanProcessor = NoopSpanProcessor()
+    var activeSpanLimits: SpanLimits
+    var sampler: Sampler
+    var activeSpanProcessor: SpanProcessor
     var hasBeenShutdown = false
 
     var registeredSpanProcessors = [SpanProcessor]()
 
-    init(clock: Clock, idGenerator: IdGenerator, resource: Resource) {
+    init(clock: Clock,
+         idGenerator: IdGenerator,
+         resource: Resource,
+         spanLimits: SpanLimits,
+         sampler: Sampler,
+         spanProcessors: [SpanProcessor])
+    {
         self.clock = clock
         self.idGenerator = idGenerator
         self.resource = resource
+        self.activeSpanLimits = spanLimits
+        self.sampler = sampler
+        if spanProcessors.count > 1 {
+            self.activeSpanProcessor = MultiSpanProcessor(spanProcessors: spanProcessors)
+            registeredSpanProcessors = spanProcessors
+        } else if spanProcessors.count == 1 {
+            self.activeSpanProcessor = spanProcessors[0]
+            registeredSpanProcessors = spanProcessors
+        } else {
+            activeSpanProcessor = NoopSpanProcessor()
+        }
     }
 
     /// Adds a new SpanProcessor
     /// - Parameter spanProcessor:  the new SpanProcessor to be added.
     func addSpanProcessor(_ spanProcessor: SpanProcessor) {
         registeredSpanProcessors.append(spanProcessor)
-        activeSpanProcessor = MultiSpanProcessor(spanProcessors: registeredSpanProcessors)
+        if registeredSpanProcessors.count > 1 {
+            activeSpanProcessor = MultiSpanProcessor(spanProcessors: registeredSpanProcessors)
+        } else {
+            activeSpanProcessor = registeredSpanProcessors[0]
+        }
     }
 
     /// Stops tracing, including shutting down processors and set to true isStopped.

Tests/OpenTelemetrySdkTests/Trace/Export/BatchSpansProcessorTests.swift

@@ -14,7 +14,7 @@
 //
 
 import OpenTelemetryApi
-import OpenTelemetrySdk
+@testable import OpenTelemetrySdk
 import XCTest
 
 class BatchSpansProcessorTests: XCTestCase {

Tests/OpenTelemetrySdkTests/Trace/Export/SimpleSpansProcessorTests.swift

@@ -14,7 +14,7 @@
 //
 
 import OpenTelemetryApi
-import OpenTelemetrySdk
+@testable import OpenTelemetrySdk
 import XCTest
 
 class SimpleSpansProcessorTests: XCTestCase {

Tests/OpenTelemetrySdkTests/Trace/NoopSpanProcessorTests.swift

@@ -13,7 +13,7 @@
 // limitations under the License.
 //
 
-import OpenTelemetrySdk
+@testable import OpenTelemetrySdk
 import XCTest
 
 class NoopSpanProcessorTest: XCTestCase {

Tests/OpenTelemetrySdkTests/Trace/TracerProviderSdkTests.swift

@@ -0,0 +1,45 @@
+// Copyright 2020, OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+@testable import OpenTelemetrySdk
+import XCTest
+
+class TracerProviderSdkTests: XCTestCase {
+    var tracerProviderSdk = TracerProviderSdk()
+
+    func testDefaultGet() {
+        XCTAssert(tracerProviderSdk.get(instrumentationName: "test") is TracerSdk)
+    }
+
+    func testgGtSameInstanceForSameName_WithoutVersion() {
+        XCTAssert(tracerProviderSdk.get(instrumentationName: "test") === tracerProviderSdk.get(instrumentationName: "test"))
+        XCTAssert(tracerProviderSdk.get(instrumentationName: "test") === tracerProviderSdk.get(instrumentationName: "test", instrumentationVersion: nil))
+    }
+
+    func testPropagatesInstrumentationLibraryInfoToTracer() {
+        let expected = InstrumentationLibraryInfo(name: "theName", version: "theVersion")
+        let tracer = tracerProviderSdk.get(instrumentationName: expected.name, instrumentationVersion: expected.version) as! TracerSdk
+        XCTAssertEqual(tracer.instrumentationLibraryInfo, expected)
+    }
+
+    func testGetSameInstanceForSameName_WithVersion() {
+        XCTAssert(tracerProviderSdk.get(instrumentationName: "test", instrumentationVersion: "version") === tracerProviderSdk.get(instrumentationName: "test", instrumentationVersion: "version"))
+    }
+
+    func testGetWithoutName() {
+        let tracer = tracerProviderSdk.get(instrumentationName: "") as! TracerSdk
+        XCTAssertEqual(tracer.instrumentationLibraryInfo.name, TracerProviderSdk.emptyName)
+    }
+}

Tests/OpenTracingShim/SpanShimTests.swift

@@ -14,12 +14,12 @@
 //
 
 import OpenTelemetryApi
-import OpenTelemetrySdk
+@testable import OpenTelemetrySdk
 @testable import OpenTracingShim
 import XCTest
 
 class SpanShimTests: XCTestCase {
-    let tracerSdkProvider = TracerProviderSdk()
+    let tracerProviderSdk = TracerProviderSdk()
     var tracer: Tracer!
     var telemetryInfo: TelemetryInfo!
     var span: Span!
@@ -28,7 +28,7 @@ class SpanShimTests: XCTestCase {
     let spanName = "Span"
 
     override func setUp() {
-        tracer = tracerSdkProvider.get(instrumentationName: "SpanShimTest")
+        tracer = tracerProviderSdk.get(instrumentationName: "SpanShimTest")
         telemetryInfo = TelemetryInfo(tracer: tracer, baggageManager: OpenTelemetrySDK.instance.baggageManager, propagators: OpenTelemetrySDK.instance.propagators)
         span = tracer.spanBuilder(spanName: spanName).startSpan()
         tracerShim = TracerShim(telemetryInfo: telemetryInfo)