Merge remote-tracking branch 'upstream/main' into main

# Conflicts:
#	Package.swift

Author: ktoso

.dockerignore

@@ -0,0 +1,4 @@
+.build/
+.swiftpm/
+UseCases/.build/
+UseCases/.swiftpm/

.swiftformat

@@ -1,8 +1,10 @@
 # file options
 
---swiftversion 5.2
+--swiftversion 5.0
 --exclude .build
 --exclude UseCases/.build
+--exclude Tests/LinuxMain.swift
+--exclude **/*Tests+XCTest.swift
 
 # format options
 

Package.resolved

@@ -5,19 +5,16 @@ let package = Package(
     name: "gsoc-swift-tracing",
     products: [
         .library(name: "Instrumentation", targets: ["Instrumentation"]),
-        .library(name: "TracingInstrumentation", targets: ["TracingInstrumentation"]),
+        .library(name: "Tracing", targets: ["Tracing"]),
         .library(name: "NIOInstrumentation", targets: ["NIOInstrumentation"]),
-        .library(name: "OpenTelemetryInstrumentationSupport", targets: ["OpenTelemetryInstrumentationSupport"])
+        .library(name: "OpenTelemetryInstrumentationSupport", targets: ["OpenTelemetryInstrumentationSupport"]),
     ],
     dependencies: [
-//        .package(
-//            name: "swift-baggage-context",
-//            url: "https://github.com/slashmo/gsoc-swift-baggage-context.git",
-//            from: "0.2.0"
-//        ),
-        // .package(url: "https://github.com/slashmo/gsoc-swift-baggage-context.git", from: "0.2.0"),
-        .package(url: "file:///users/ktoso/code/gsoc-swift-baggage-context", .branch("main")),
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.17.0")
+        .package(
+            url: "https://github.com/slashmo/gsoc-swift-baggage-context.git",
+            from: "0.3.0"
+        ),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.17.0"),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
@@ -37,16 +34,16 @@ let package = Package(
         ),
 
         .target(
-            name: "TracingInstrumentation",
+            name: "Tracing",
             dependencies: [
-                "Instrumentation"
+                "Instrumentation",
             ]
         ),
         .testTarget(
-            name: "TracingInstrumentationTests",
+            name: "TracingTests",
             dependencies: [
                 "Instrumentation",
-                "TracingInstrumentation",
+                "Tracing",
                 "BaggageLogging",
             ]
         ),
@@ -69,28 +66,28 @@ let package = Package(
         .target(
             name: "OpenTelemetryInstrumentationSupport",
             dependencies: [
-                .target(name: "TracingInstrumentation")
+                .target(name: "Tracing")
             ]
         ),
         .testTarget(
             name: "OpenTelemetryInstrumentationSupportTests",
             dependencies: [
-                "OpenTelemetryInstrumentationSupport"
+                "OpenTelemetryInstrumentationSupport",
             ]
         ),
 
         // ==== --------------------------------------------------------------------------------------------------------
         // MARK: Performance / Benchmarks
 
         .target(
-            name: "Benchmarks",
+            name: "TracingBenchmarks",
             dependencies: [
                 "Baggage",
-                "SwiftBenchmarkTools",
+                "TracingBenchmarkTools",
             ]
         ),
         .target(
-            name: "SwiftBenchmarkTools",
+            name: "TracingBenchmarkTools",
             dependencies: []
         ),
     ]

Package.swift

@@ -65,7 +65,7 @@ public enum InstrumentationSystem {
     ///
     /// Defaults to a no-op `Instrument` if `boostrap` wasn't called before.
     public static var instrument: Instrument {
-        self.lock.withReaderLock { self._instrument }
+        return self.lock.withReaderLock { self._instrument }
     }
 
     /// Get an `Instrument` instance of the given type.
@@ -75,14 +75,14 @@ public enum InstrumentationSystem {
     /// - Parameter instrumentType: The type of `Instrument` you want to retrieve an instance for.
     /// - Returns: An `Instrument` instance of the given type or `nil` if no `Instrument` of that type has been bootstrapped.
     public static func instrument<I>(of instrumentType: I.Type) -> I? where I: Instrument {
-        self._findInstrument(where: { $0 is I }) as? I
+        return self._findInstrument(where: { $0 is I }) as? I
     }
 }
 
 extension InstrumentationSystem {
     /// :nodoc: INTERNAL API: Do Not Use
     public static func _findInstrument(where predicate: (Instrument) -> Bool) -> Instrument? {
-        self.lock.withReaderLock {
+        return self.lock.withReaderLock {
             if let multiplex = self._instrument as? MultiplexInstrument {
                 return multiplex.firstInstrument(where: predicate)
             } else if predicate(self._instrument) {

Sources/Instrumentation/InstrumentationSystem.swift

@@ -29,7 +29,7 @@ public struct MultiplexInstrument {
 
 extension MultiplexInstrument {
     func firstInstrument(where predicate: (Instrument) -> Bool) -> Instrument? {
-        self.instruments.first(where: predicate)
+        return self.instruments.first(where: predicate)
     }
 }
 
@@ -39,7 +39,8 @@ extension MultiplexInstrument: Instrument {
     )
         where
         Injector: InjectorProtocol,
-        Carrier == Injector.Carrier {
+        Carrier == Injector.Carrier
+    {
         self.instruments.forEach { $0.inject(context, into: &carrier, using: injector) }
     }
 
@@ -48,7 +49,8 @@ extension MultiplexInstrument: Instrument {
     )
         where
         Carrier == Extractor.Carrier,
-        Extractor: ExtractorProtocol {
+        Extractor: ExtractorProtocol
+    {
         self.instruments.forEach { $0.extract(carrier, into: &context, using: extractor) }
     }
 }

Sources/Instrumentation/MultiplexInstrument.swift

@@ -18,7 +18,7 @@ public struct HTTPHeadersExtractor: ExtractorProtocol {
     public init() {}
 
     public func extract(key: String, from headers: HTTPHeaders) -> String? {
-        headers.first(name: key)
+        return headers.first(name: key)
     }
 }
 

Sources/NIOInstrumentation/HTTPHeadersCarrier.swift

@@ -11,8 +11,21 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
+extension SpanAttributeName {
+    /// - See: EndUserAttributes
+    public enum EndUser {
+        /// - See: EndUserAttributes
+        public static let id = "enduser.id"
+        /// - See: EndUserAttributes
+        public static let role = "enduser.role"
+        /// - See: EndUserAttributes
+        public static let scope = "enduser.scope"
+    }
+}
+
+#if swift(>=5.2)
 extension SpanAttributes {
     /// Semantic end-user attributes.
     public var endUser: EndUserAttributes {
@@ -26,6 +39,8 @@ extension SpanAttributes {
 }
 
 /// End-user-related semantic conventions as defined in the OpenTelemetry spec.
+///
+/// - SeeAlso: [OpenTelemetry: General identity attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md#general-identity-attributes) (as of August 2020)
 @dynamicMemberLookup
 public struct EndUserAttributes: SpanAttributeNamespace {
     public var attributes: SpanAttributes
@@ -38,13 +53,14 @@ public struct EndUserAttributes: SpanAttributeNamespace {
         public init() {}
 
         /// Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system.
-        public var id: SpanAttributeKey<String> { "enduser.id" }
+        public var id: SpanAttributeKey<String> { .init(name: SpanAttributeName.EndUser.id) }
 
         /// Actual/assumed role the client is making the request under extracted from token or application security context.
-        public var role: SpanAttributeKey<String> { "enduser.role" }
+        public var role: SpanAttributeKey<String> { .init(name: SpanAttributeName.EndUser.role) }
 
         /// Scopes or granted authorities the client currently possesses extracted from token or application security context.
         /// The value would come from the scope associated with an OAuth 2.0 Access Token or an attribute value in a SAML 2.0 Assertion.
-        public var scope: SpanAttributeKey<String> { "enduser.scope" }
+        public var scope: SpanAttributeKey<String> { .init(name: SpanAttributeName.EndUser.scope) }
     }
 }
+#endif

Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+EndUser.swift

@@ -0,0 +1,74 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Distributed Tracing open source project
+//
+// Copyright (c) 2020 Moritz Lang and the Swift Tracing project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Tracing
+
+extension SpanAttributeName {
+    /// - See: GRPCAttributes
+    public enum GRPC {
+        /// - See: GRPCAttributes
+        public static let messageType = "message.type"
+        /// - See: GRPCAttributes
+        public static let messageID = "message.id"
+        /// - See: GRPCAttributes
+        public static let messageCompressedSize = "message.compressed_size"
+        /// - See: GRPCAttributes
+        public static let messageUncompressedSize = "message.uncompressed_size"
+    }
+}
+
+#if swift(>=5.2)
+extension SpanAttributes {
+    /// Semantic conventions for gRPC spans.
+    public var gRPC: GRPCAttributes {
+        get {
+            .init(attributes: self)
+        }
+        set {
+            self = newValue.attributes
+        }
+    }
+}
+
+/// Semantic conventions for gRPC spans as defined in the OpenTelemetry spec.
+///
+/// - SeeAlso: [OpenTelemetry: Semantic conventions for gRPC spans](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/rpc.md#grpc) (as of August 2020)
+@dynamicMemberLookup
+public struct GRPCAttributes: SpanAttributeNamespace {
+    public var attributes: SpanAttributes
+
+    public init(attributes: SpanAttributes) {
+        self.attributes = attributes
+    }
+
+    public struct NestedAttributes: NestedSpanAttributesProtocol {
+        public init() {}
+
+        /// The type of message, e.g. "SENT" or "RECEIVED".
+        public var messageType: SpanAttributeKey<String> { .init(name: SpanAttributeName.GRPC.messageType) }
+
+        /// The message id calculated as two different counters starting from 1, one for sent messages and one for received messages.
+        public var messageID: SpanAttributeKey<Int> { .init(name: SpanAttributeName.GRPC.messageID) }
+
+        /// The compressed message size in bytes.
+        public var messageCompressedSize: SpanAttributeKey<Int> {
+            .init(name: SpanAttributeName.GRPC.messageCompressedSize)
+        }
+
+        /// The uncompressed message size in bytes.
+        public var messageUncompressedSize: SpanAttributeKey<Int> {
+            .init(name: SpanAttributeName.GRPC.messageUncompressedSize)
+        }
+    }
+}
+#endif