updated InstrumentationLibrary to InstrumentationScope (#336)

* changed InstrumentationLibrary to InstrumentationScope as per OTLP spec update
* Added comment for specifying otel-collector version

Co-authored-by: Bryce Buchanan <[email protected]>

Author: vvydier

.github/workflows/BuildAndTest.yml

@@ -15,5 +15,5 @@ jobs:
       run: |
         curl -Os https://uploader.codecov.io/latest/macos/codecov
         chmod +x codecov
-        xcrun llvm-cov export -format="lcov" .build/debug/opentelemetry-swiftPackageTests.xctest/Contents/MacOS/opentelemetry-swiftPackageTests -instr-profile .build/debug/codecov/default.profdata > .build/debug/codecov/coverage_report.lcov
+        xcrun llvm-cov export -ignore-filename-regex="pb\.swift|grpc\.swift" -format="lcov" .build/debug/opentelemetry-swiftPackageTests.xctest/Contents/MacOS/opentelemetry-swiftPackageTests -instr-profile .build/debug/codecov/default.profdata > .build/debug/codecov/coverage_report.lcov
         ./codecov -f .build/debug/codecov/coverage_report.lcov

Examples/Datadog Sample/main.swift

@@ -19,12 +19,12 @@ let resourceValue = "The resource"
 let sampleKey = "sampleKey"
 let sampleValue = "sampleValue"
 
-let instrumentationLibraryName = "DatadogExporter"
-let instrumentationLibraryVersion = "semver:0.1.0"
-var instrumentationLibraryInfo = InstrumentationLibraryInfo(name: instrumentationLibraryName, version: instrumentationLibraryVersion)
+let instrumentationScopeName = "DatadogExporter"
+let instrumentationScopeVersion = "semver:0.1.0"
+var instrumentationScopeInfo = InstrumentationScopeInfo(name: instrumentationScopeName, version: instrumentationScopeVersion)
 
 var tracer: TracerSdk
-tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationLibraryName, instrumentationVersion: instrumentationLibraryVersion) as! TracerSdk
+tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationScopeName, instrumentationVersion: instrumentationScopeVersion) as! TracerSdk
 
 #if targetEnvironment(macCatalyst)
 let hostName = UIDevice.current.name

Examples/OTLP Exporter/docker-compose.yaml

@@ -2,7 +2,8 @@ version: "3"
 services:
   # Collector
   collector:
-    image: otel/opentelemetry-collector:0.50.0
+    image: otel/opentelemetry-collector:0.62.1
+#    The latest image of the otel-collector may not work, so specifying the version that works with this release
 #    image: otel/opentelemetry-collector:latest
     command: ["--config=/conf/collector-config.yaml"]
     volumes:

Examples/OTLP Exporter/main.swift

@@ -20,12 +20,12 @@ let sampleValue = "sampleValue"
 
 var resources = DefaultResources().get()
 
-let instrumentationLibraryName = "OTLPExporter"
-let instrumentationLibraryVersion = "semver:0.1.0"
-var instrumentationLibraryInfo = InstrumentationLibraryInfo(name: instrumentationLibraryName, version: instrumentationLibraryVersion)
+let instrumentationScopeName = "OTLPExporter"
+let instrumentationScopeVersion = "semver:0.1.0"
+var instrumentationScopeInfo = InstrumentationScopeInfo(name: instrumentationScopeName, version: instrumentationScopeVersion)
 
 var tracer: TracerSdk
-tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationLibraryName, instrumentationVersion: instrumentationLibraryVersion) as! TracerSdk
+tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationScopeName, instrumentationVersion: instrumentationScopeVersion) as! TracerSdk
 
 let configuration = ClientConnection.Configuration(
     target: .hostAndPort("localhost", 4317),

Examples/Simple Exporter/main.swift

@@ -17,12 +17,12 @@ let sampleValue = "sampleValue"
 
 let resources = DefaultResources().get()
 
-let instrumentationLibraryName = "SimpleExporter"
-let instrumentationLibraryVersion = "semver:0.1.0"
-var instrumentationLibraryInfo = InstrumentationLibraryInfo(name: instrumentationLibraryName, version: instrumentationLibraryVersion)
+let instrumentationScopeName = "SimpleExporter"
+let instrumentationScopeVersion = "semver:0.1.0"
+var instrumentationScopeInfo = InstrumentationScopeInfo(name: instrumentationScopeName, version: instrumentationScopeVersion)
 
 var tracer: TracerSdk
-tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationLibraryName, instrumentationVersion: instrumentationLibraryVersion) as! TracerSdk
+tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationScopeName, instrumentationVersion: instrumentationScopeVersion) as! TracerSdk
 
 func simpleSpan() {
     let span = tracer.spanBuilder(spanName: "SimpleSpan").setSpanKind(spanKind: .client).startSpan()

Package.resolved

@@ -48,14 +48,14 @@ struct CommonAdapter {
         return keyValue
     }
 
-    static func toProtoInstrumentationLibrary(instrumentationLibraryInfo: InstrumentationLibraryInfo) -> Opentelemetry_Proto_Common_V1_InstrumentationLibrary {
+    static func toProtoInstrumentationScope(instrumentationScopeInfo: InstrumentationScopeInfo) -> Opentelemetry_Proto_Common_V1_InstrumentationScope {
 
-        var instrumentationLibrary = Opentelemetry_Proto_Common_V1_InstrumentationLibrary()
-        instrumentationLibrary.name = instrumentationLibraryInfo.name
-        if let version = instrumentationLibraryInfo.version {
-            instrumentationLibrary.version = version
+        var instrumentationScope = Opentelemetry_Proto_Common_V1_InstrumentationScope()
+        instrumentationScope.name = instrumentationScopeInfo.name
+        if let version = instrumentationScopeInfo.version {
+            instrumentationScope.version = version
         }
-        return instrumentationLibrary
+        return instrumentationScope
     }
 
 }

Sources/Exporters/OpenTelemetryProtocol/common/CommonAdapter.swift

@@ -8,36 +8,36 @@ import OpenTelemetrySdk
 
 struct MetricsAdapter {
     static func toProtoResourceMetrics(metricDataList: [Metric]) -> [Opentelemetry_Proto_Metrics_V1_ResourceMetrics] {
-        let resourceAndLibraryMap = groupByResouceAndLibrary(metricDataList: metricDataList)
+        let resourceAndScopeMap = groupByResouceAndScope(metricDataList: metricDataList)
         var resourceMetrics = [Opentelemetry_Proto_Metrics_V1_ResourceMetrics]()
 
-        resourceAndLibraryMap.forEach { resMap in
-            var instrumentationLibraryMetrics = [Opentelemetry_Proto_Metrics_V1_InstrumentationLibraryMetrics]()
-            resMap.value.forEach { instLibrary in
+        resourceAndScopeMap.forEach { resMap in
+            var instrumentationScopeMetrics = [Opentelemetry_Proto_Metrics_V1_ScopeMetrics]()
+            resMap.value.forEach { instScope in
                 var protoInst =
-                    Opentelemetry_Proto_Metrics_V1_InstrumentationLibraryMetrics()
-                protoInst.instrumentationLibrary =
-                    CommonAdapter.toProtoInstrumentationLibrary(instrumentationLibraryInfo: instLibrary.key)
-                instLibrary.value.forEach {
+                Opentelemetry_Proto_Metrics_V1_ScopeMetrics()
+                protoInst.scope =
+                    CommonAdapter.toProtoInstrumentationScope(instrumentationScopeInfo: instScope.key)
+                instScope.value.forEach {
                     protoInst.metrics.append($0)
                 }
-                instrumentationLibraryMetrics.append(protoInst)
+                instrumentationScopeMetrics.append(protoInst)
             }
             var resourceMetric = Opentelemetry_Proto_Metrics_V1_ResourceMetrics()
             resourceMetric.resource = ResourceAdapter.toProtoResource(resource: resMap.key)
-            resourceMetric.instrumentationLibraryMetrics.append(contentsOf: instrumentationLibraryMetrics)
+            resourceMetric.scopeMetrics.append(contentsOf: instrumentationScopeMetrics)
             resourceMetrics.append(resourceMetric)
         }
 
         return resourceMetrics
     }
 
-    private static func groupByResouceAndLibrary(metricDataList: [Metric]) -> [Resource: [InstrumentationLibraryInfo: [Opentelemetry_Proto_Metrics_V1_Metric]]] {
-        var results = [Resource: [InstrumentationLibraryInfo: [Opentelemetry_Proto_Metrics_V1_Metric]]]()
+    private static func groupByResouceAndScope(metricDataList: [Metric]) -> [Resource: [InstrumentationScopeInfo: [Opentelemetry_Proto_Metrics_V1_Metric]]] {
+        var results = [Resource: [InstrumentationScopeInfo: [Opentelemetry_Proto_Metrics_V1_Metric]]]()
 
         metricDataList.forEach {
             if let metric = toProtoMetric(metric: $0) {
-                results[$0.resource, default: [InstrumentationLibraryInfo: [Opentelemetry_Proto_Metrics_V1_Metric]]()][$0.instrumentationLibraryInfo, default: [Opentelemetry_Proto_Metrics_V1_Metric]()]
+                results[$0.resource, default: [InstrumentationScopeInfo: [Opentelemetry_Proto_Metrics_V1_Metric]]()][$0.instrumentationScopeInfo, default: [Opentelemetry_Proto_Metrics_V1_Metric]()]
                     .append(metric)
             }
         }

Sources/Exporters/OpenTelemetryProtocol/metric/MetricsAdapter.swift

@@ -13,7 +13,7 @@ import OpenTelemetrySdk
 
 public class OtlpMetricExporter: MetricExporter {
     let channel: GRPCChannel
-    let metricClient: Opentelemetry_Proto_Collector_Metrics_V1_MetricsServiceClient
+    var metricClient: Opentelemetry_Proto_Collector_Metrics_V1_MetricsServiceNIOClient
     let config : OtlpConfiguration
     var callOptions : CallOptions? = nil
 
@@ -22,7 +22,7 @@ public class OtlpMetricExporter: MetricExporter {
     public init(channel: GRPCChannel, config: OtlpConfiguration = OtlpConfiguration(), logger: Logger = Logger(label: "io.grpc", factory: { _ in SwiftLogNoOpLogHandler() }), envVarHeaders: [(String,String)]? = EnvVarHeaders.attributes) {
         self.channel = channel
         self.config = config
-        self.metricClient = Opentelemetry_Proto_Collector_Metrics_V1_MetricsServiceClient(channel: self.channel)
+        self.metricClient = Opentelemetry_Proto_Collector_Metrics_V1_MetricsServiceNIOClient(channel: self.channel)
         if let headers = envVarHeaders {
             callOptions = CallOptions(customMetadata: HPACKHeaders(headers), logger: logger)
         } else if let headers = config.headers {

Sources/Exporters/OpenTelemetryProtocol/metric/OtlpMetricExporter.swift

@@ -219,26 +219,6 @@ public struct Opentelemetry_Proto_Common_V1_KeyValue {
   fileprivate var _value: Opentelemetry_Proto_Common_V1_AnyValue? = nil
 }
 
-/// InstrumentationLibrary is a message representing the instrumentation library information
-/// such as the fully qualified name and version.
-/// InstrumentationLibrary is wire-compatible with InstrumentationScope for binary
-/// Protobuf format.
-/// This message is deprecated and will be removed on June 15, 2022.
-public struct Opentelemetry_Proto_Common_V1_InstrumentationLibrary {
-  // SwiftProtobuf.Message conformance is added in an extension below. See the
-  // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
-  // methods supported on all messages.
-
-  /// An empty instrumentation library name means the name is unknown.
-  public var name: String = String()
-
-  public var version: String = String()
-
-  public var unknownFields = SwiftProtobuf.UnknownStorage()
-
-  public init() {}
-}
-
 /// InstrumentationScope is a message representing the instrumentation scope information
 /// such as the fully qualified name and version. 
 public struct Opentelemetry_Proto_Common_V1_InstrumentationScope {
@@ -251,6 +231,10 @@ public struct Opentelemetry_Proto_Common_V1_InstrumentationScope {
 
   public var version: String = String()
 
+  public var attributes: [Opentelemetry_Proto_Common_V1_KeyValue] = []
+
+  public var droppedAttributesCount: UInt32 = 0
+
   public var unknownFields = SwiftProtobuf.UnknownStorage()
 
   public init() {}
@@ -262,7 +246,6 @@ extension Opentelemetry_Proto_Common_V1_AnyValue.OneOf_Value: @unchecked Sendabl
 extension Opentelemetry_Proto_Common_V1_ArrayValue: @unchecked Sendable {}
 extension Opentelemetry_Proto_Common_V1_KeyValueList: @unchecked Sendable {}
 extension Opentelemetry_Proto_Common_V1_KeyValue: @unchecked Sendable {}
-extension Opentelemetry_Proto_Common_V1_InstrumentationLibrary: @unchecked Sendable {}
 extension Opentelemetry_Proto_Common_V1_InstrumentationScope: @unchecked Sendable {}
 #endif  // swift(>=5.5) && canImport(_Concurrency)
 
@@ -511,49 +494,13 @@ extension Opentelemetry_Proto_Common_V1_KeyValue: SwiftProtobuf.Message, SwiftPr
   }
 }
 
-extension Opentelemetry_Proto_Common_V1_InstrumentationLibrary: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
-  public static let protoMessageName: String = _protobuf_package + ".InstrumentationLibrary"
-  public static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
-    1: .same(proto: "name"),
-    2: .same(proto: "version"),
-  ]
-
-  public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
-    while let fieldNumber = try decoder.nextFieldNumber() {
-      // The use of inline closures is to circumvent an issue where the compiler
-      // allocates stack space for every case branch when no optimizations are
-      // enabled. https://github.com/apple/swift-protobuf/issues/1034
-      switch fieldNumber {
-      case 1: try { try decoder.decodeSingularStringField(value: &self.name) }()
-      case 2: try { try decoder.decodeSingularStringField(value: &self.version) }()
-      default: break
-      }
-    }
-  }
-
-  public func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
-    if !self.name.isEmpty {
-      try visitor.visitSingularStringField(value: self.name, fieldNumber: 1)
-    }
-    if !self.version.isEmpty {
-      try visitor.visitSingularStringField(value: self.version, fieldNumber: 2)
-    }
-    try unknownFields.traverse(visitor: &visitor)
-  }
-
-  public static func ==(lhs: Opentelemetry_Proto_Common_V1_InstrumentationLibrary, rhs: Opentelemetry_Proto_Common_V1_InstrumentationLibrary) -> Bool {
-    if lhs.name != rhs.name {return false}
-    if lhs.version != rhs.version {return false}
-    if lhs.unknownFields != rhs.unknownFields {return false}
-    return true
-  }
-}
-
 extension Opentelemetry_Proto_Common_V1_InstrumentationScope: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
   public static let protoMessageName: String = _protobuf_package + ".InstrumentationScope"
   public static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
     1: .same(proto: "name"),
     2: .same(proto: "version"),
+    3: .same(proto: "attributes"),
+    4: .standard(proto: "dropped_attributes_count"),
   ]
 
   public mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
@@ -564,6 +511,8 @@ extension Opentelemetry_Proto_Common_V1_InstrumentationScope: SwiftProtobuf.Mess
       switch fieldNumber {
       case 1: try { try decoder.decodeSingularStringField(value: &self.name) }()
       case 2: try { try decoder.decodeSingularStringField(value: &self.version) }()
+      case 3: try { try decoder.decodeRepeatedMessageField(value: &self.attributes) }()
+      case 4: try { try decoder.decodeSingularUInt32Field(value: &self.droppedAttributesCount) }()
       default: break
       }
     }
@@ -576,12 +525,20 @@ extension Opentelemetry_Proto_Common_V1_InstrumentationScope: SwiftProtobuf.Mess
     if !self.version.isEmpty {
       try visitor.visitSingularStringField(value: self.version, fieldNumber: 2)
     }
+    if !self.attributes.isEmpty {
+      try visitor.visitRepeatedMessageField(value: self.attributes, fieldNumber: 3)
+    }
+    if self.droppedAttributesCount != 0 {
+      try visitor.visitSingularUInt32Field(value: self.droppedAttributesCount, fieldNumber: 4)
+    }
     try unknownFields.traverse(visitor: &visitor)
   }
 
   public static func ==(lhs: Opentelemetry_Proto_Common_V1_InstrumentationScope, rhs: Opentelemetry_Proto_Common_V1_InstrumentationScope) -> Bool {
     if lhs.name != rhs.name {return false}
     if lhs.version != rhs.version {return false}
+    if lhs.attributes != rhs.attributes {return false}
+    if lhs.droppedAttributesCount != rhs.droppedAttributesCount {return false}
     if lhs.unknownFields != rhs.unknownFields {return false}
     return true
   }