updated instrument scope to include 'attributes' (#753)

* updated instrument scope to include 'attributes'

* removed errant comma

---------

Co-authored-by: Ignacio Bonafonte <[email protected]>

Author: bryce-b

Examples/Logging Tracer/LoggingTracerProvider.swift

@@ -7,11 +7,18 @@ import Foundation
 import OpenTelemetryApi
 
 class LoggingTracerProvider: TracerProvider {
-  func get(instrumentationName: String, instrumentationVersion: String?) -> Tracer {
-    Logger.log("TracerFactory.get(\(instrumentationName), \(instrumentationVersion ?? ""))")
+  func get(instrumentationName: String, instrumentationVersion: String?,
+           schemaUrl: String? = nil,
+           attributes: [String: AttributeValue]? = nil) -> any Tracer {
+    Logger
+      .log(
+        "TracerFactory.get(\(instrumentationName), \(instrumentationVersion ?? ""), \(schemaUrl ?? ""), \(attributes ?? [:])"
+      )
     var labels = [String: String]()
     labels["instrumentationName"] = instrumentationName
     labels["instrumentationVersion"] = instrumentationVersion
+    labels["schemaUrl"] = schemaUrl
+    labels["attributes"] = attributes?.description
     return LoggingTracer()
   }
 }

Sources/Exporters/OpenTelemetryProtocolCommon/common/CommonAdapter.swift

@@ -95,6 +95,12 @@ public enum CommonAdapter {
     if let version = instrumentationScopeInfo.version {
       instrumentationScope.version = version
     }
-    return instrumentationScope
+
+    if let attributes = instrumentationScopeInfo.attributes {
+      attributes.forEach {
+        instrumentationScope.attributes.append(CommonAdapter.toProtoAttribute(key: $0.key, attributeValue: $0.value))
+      }
+    }
+  return instrumentationScope
   }
 }

Sources/Importers/OpenTracingShim/TraceShim.swift

@@ -30,6 +30,6 @@ public class TraceShim {
   }
 
   private static func getTracer(tracerProvider: TracerProvider) -> Tracer {
-    tracerProvider.get(instrumentationName: "opentracingshim", instrumentationVersion: nil)
+    tracerProvider.get(instrumentationName: "opentracingshim")
   }
 }

Sources/OpenTelemetryApi/Metrics/Stable/DefaultStableMeterProvider.swift

@@ -31,6 +31,10 @@ public class DefaultStableMeterProvider: StableMeterProvider {
       self
     }
 
+    func setAttributes(attributes: [String: AttributeValue]) -> Self {
+      self
+    }
+
     func build() -> StableMeter {
       Self.noopMeter
     }

Sources/OpenTelemetryApi/Metrics/Stable/MeterBuilder.swift

@@ -18,6 +18,12 @@ public protocol MeterBuilder: AnyObject {
   /// - Returns: self
   func setInstrumentationVersion(instrumentationVersion: String) -> Self
 
+  /// Assign a set of attributes that will be applied to the Meter.
+  ///
+  /// - Parameter attributes: key/value-pair of attributes
+  /// - Returns: self
+  func setAttributes(attributes: [String: AttributeValue]) -> Self
+
   /// gets or creates a Meter
   ///
   /// - Returns: a Meter configured with the provided options.

Sources/OpenTelemetryApi/Trace/DefaultTracerProvider.swift

@@ -8,7 +8,10 @@ import Foundation
 public class DefaultTracerProvider: TracerProvider {
   public static let instance = DefaultTracerProvider()
 
-  public func get(instrumentationName: String, instrumentationVersion: String? = nil) -> Tracer {
+  public func get(instrumentationName: String,
+                  instrumentationVersion: String? = nil,
+                  schemaUrl: String? = nil,
+                  attributes: [String: AttributeValue]? = nil) -> any Tracer {
     return DefaultTracer.instance
   }
 }

Sources/OpenTelemetryApi/Trace/TracerProvider.swift

@@ -11,11 +11,26 @@ public protocol TracerProvider {
   /// - Parameters:
   ///   - instrumentationName: the name of the instrumentation library, not the name of the instrumented library
   ///   - instrumentationVersion:  The version of the instrumentation library (e.g., "semver:1.0.0"). Optional
-  func get(instrumentationName: String, instrumentationVersion: String?) -> Tracer
+  ///   - schemaUrl: The schema url. Optional
+  ///   - attributes: attributes to be associated with span created by this tracer. Optional
+  func get(
+    instrumentationName: String,
+    instrumentationVersion: String?,
+    schemaUrl: String?,
+    attributes: [String: AttributeValue]?
+  ) -> any Tracer
 }
 
-extension TracerProvider {
-  func get(instrumentationName: String) -> Tracer {
-    return get(instrumentationName: instrumentationName, instrumentationVersion: nil)
+public extension TracerProvider {
+  func get(instrumentationName: String,
+           instrumentationVersion: String? = nil,
+           schemaUrl: String? = nil,
+           attributes: [String: AttributeValue]? = nil) -> any Tracer {
+    return get(
+      instrumentationName: instrumentationName,
+      instrumentationVersion: instrumentationVersion,
+      schemaUrl: schemaUrl,
+      attributes: attributes
+    )
   }
 }

Sources/OpenTelemetryConcurrency/OpenTelemetry.swift

@@ -23,8 +23,19 @@ public struct TracerProviderWrapper {
   /// The inner `TracerProvider` used to construct a `Tracer`. Be careful when accessing this property, as it may make it easier to use API's that don't function properly with your configuration.
   public let inner: TracerProvider
 
-  public func get(instrumentationName: String, instrumentationVersion: String?) -> TracerWrapper {
-    TracerWrapper(inner: inner.get(instrumentationName: instrumentationName, instrumentationVersion: instrumentationVersion))
+  public func get(instrumentationName: String,
+                  instrumentationVersion: String? = nil,
+                  schemaUrl: String? = nil,
+                  attributes: [String: AttributeValue]? = nil) -> TracerWrapper {
+    TracerWrapper(
+      inner: inner
+        .get(
+          instrumentationName: instrumentationName,
+          instrumentationVersion: instrumentationVersion,
+          schemaUrl: schemaUrl,
+          attributes: attributes
+        )
+    )
   }
 }
 

Sources/OpenTelemetrySdk/Common/ComponentRegistry.swift

@@ -20,7 +20,7 @@ class ComponentRegistry<T> {
     self.builder = builder
   }
 
-  public func get(name: String, version: String? = nil, schemaUrl: String? = nil) -> T {
+  public func get(name: String, version: String? = nil, schemaUrl: String? = nil, attributes: [String: AttributeValue]? = nil) -> T {
     lock.lock()
     defer {
       lock.unlock()
@@ -35,7 +35,7 @@ class ComponentRegistry<T> {
       }
 
       if componentByNameVersionSchema[name]![version]![schemaUrl] == nil {
-        componentByNameVersionSchema[name]![version]![schemaUrl] = buildComponent(InstrumentationScopeInfo(name: name, version: version, schemaUrl: schemaUrl))
+        componentByNameVersionSchema[name]![version]![schemaUrl] = buildComponent(InstrumentationScopeInfo(name: name, version: version, schemaUrl: schemaUrl, attributes: attributes))
       }
       return componentByNameVersionSchema[name]![version]![schemaUrl]!
     } else if let version {
@@ -44,7 +44,13 @@ class ComponentRegistry<T> {
       }
 
       if componentByNameVersion[name]![version] == nil {
-        componentByNameVersion[name]![version] = buildComponent(InstrumentationScopeInfo(name: name, version: version))
+        componentByNameVersion[name]![version] = buildComponent(
+          InstrumentationScopeInfo(
+            name: name,
+            version: version,
+            attributes: attributes
+          )
+        )
       }
 
       return componentByNameVersion[name]![version]!
@@ -55,14 +61,22 @@ class ComponentRegistry<T> {
       }
 
       if componentByNameSchema[name]![schemaUrl] == nil {
-        componentByNameSchema[name]![schemaUrl] = buildComponent(InstrumentationScopeInfo(name: name, schemaUrl: schemaUrl))
+        componentByNameSchema[name]![schemaUrl] = buildComponent(
+          InstrumentationScopeInfo(
+            name: name,
+            schemaUrl: schemaUrl,
+            attributes: attributes
+          )
+        )
       }
 
       return componentByNameSchema[name]![schemaUrl]!
 
     } else {
       if componentByName[name] == nil {
-        componentByName[name] = buildComponent(InstrumentationScopeInfo(name: name))
+        componentByName[name] = buildComponent(
+          InstrumentationScopeInfo(name: name, attributes: attributes)
+        )
       }
       return componentByName[name]!
     }

Sources/OpenTelemetrySdk/Common/InstrumentationLibraryInfo.swift

@@ -4,13 +4,15 @@
  */
 
 import Foundation
+import OpenTelemetryApi
 
 /// Holds information about the instrumentation library specified when creating an instance of
 /// TracerSdk using TracerProviderSdk.
 public struct InstrumentationScopeInfo: Hashable, Codable, Equatable {
   public private(set) var name: String = ""
   public private(set) var version: String?
   public private(set) var schemaUrl: String?
+  public private(set) var attributes: [String: AttributeValue]?
 
   ///  Creates a new empty instance of InstrumentationScopeInfo.
   public init() {}
@@ -19,9 +21,10 @@ public struct InstrumentationScopeInfo: Hashable, Codable, Equatable {
   ///  - Parameters:
   ///    - name: name of the instrumentation library
   ///    - version: version of the instrumentation library (e.g., "semver:1.0.0"), might be nil
-  public init(name: String, version: String? = nil, schemaUrl: String? = nil) {
+  public init(name: String, version: String? = nil, schemaUrl: String? = nil, attributes: [String: AttributeValue]? = nil) {
     self.name = name
     self.version = version
     self.schemaUrl = schemaUrl
+    self.attributes = attributes
   }
 }