opentelemetry-propagator-b3 0.12.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f212ff563d85c68d5787630985fb11dd85060623b3ccbf8bc2428d0a89bcffa
-  data.tar.gz: 1fc8784924979ff8f1fa9d6a2055891e3203ba2f048cece323939bae95e8e2b5
+  metadata.gz: d8bb36f87a6d784d8889edf5d733410b48567f33d4a4c41d40f750e5a36ac989
+  data.tar.gz: ebd953a02b5045be4a44bb18c5d6094cf3198523b8b905b86023bb6732c0e695
 SHA512:
-  metadata.gz: 722a7b442e739fd50721c64009b40b47804de194db11712575b309b9bc84fbd01a1209e0caa5e8b2bb8535cb2452e9b0f773c69161fb4eafeec23e588f64868e
-  data.tar.gz: 3f06ac4b6ed19714c8c0be76a1532f96b597047e97a140638509f8499e20756254ba3e2dc94c704bf657c7bd8e7d411d54f8ebb09c4d93aa43d182c439f0b365
+  metadata.gz: 2ddfc1c88bd19aa81b049d9ef832de04bc321dd0219a44b01937a656f6d6b14061b0a7b452067b9844dea537c9d73ba5e26ad5301870262cb82af05cafcbbeec
+  data.tar.gz: 31e80b987d02727a2daba0fd489605daed15881890726eec64422d77842700e7dc8ba00d49d0318bddc95427a0855366a72bdcfc2bea1fbb41615e13d1da2a04

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release History: opentelemetry-propagator-b3
 
+### v0.17.0 / 2021-04-22
+
+* BREAKING CHANGE: Replace TextMapInjector/TextMapExtractor pairs with a TextMapPropagator.
+
+  [Check the propagator documentation](https://open-telemetry.github.io/opentelemetry-ruby/) for the new usage.
+
+* FIXED: Refactor propagators to add #fields 
+
+### v0.16.0 / 2021-03-17
+
+* DOCS: Replace Gitter with GitHub Discussions 
+
+### v0.15.0 / 2021-02-18
+
+* (No significant changes)
+
+### v0.14.0 / 2021-02-03
+
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators 
+
+* ADDED: Replace getter and setter callables and remove rack specific propagators 
+
+### v0.13.0 / 2021-01-29
+
+* (No significant changes)
+
 ### v0.12.0 / 2020-12-24
 
 * (No significant changes)

data/README.md

@@ -30,7 +30,7 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-b3` in
 
 The `opentelemetry-propagator-b3` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -39,8 +39,8 @@ The `opentelemetry-propagator-b3` gem is distributed under the Apache 2.0 licens
 [opentelemetry-home]: https://opentelemetry.io
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
 [b3-spec]: https://github.com/openzipkin/b3-propagation

data/lib/opentelemetry/propagator/b3.rb

@@ -31,28 +31,11 @@ module OpenTelemetry
       def debug?(context)
         context.value(DEBUG_CONTEXT_KEY)
       end
-
-      # @api private
-      # Convert an id from a hex encoded string to byte array, optionally left
-      # padding to the correct length. Assumes the input id has already been
-      # validated to be 16 or 32 characters in length.
-      def to_trace_id(hex_id)
-        if hex_id.length == 32
-          Array(hex_id).pack('H*')
-        else
-          [0, hex_id].pack('qH*')
-        end
-      end
-
-      # @api private
-      # Convert an id from a hex encoded string to byte array.
-      def to_span_id(hex_id)
-        Array(hex_id).pack('H*')
-      end
     end
   end
 end
 
 require_relative './b3/version'
+require_relative './b3/text_map_extractor'
 require_relative './b3/multi'
 require_relative './b3/single'

data/lib/opentelemetry/propagator/b3/multi.rb

@@ -4,8 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require_relative './multi/text_map_extractor'
-require_relative './multi/text_map_injector'
+require_relative './multi/text_map_propagator'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -18,48 +17,18 @@ module OpenTelemetry
   module Propagator
     # Namespace for OpenTelemetry B3 propagation
     module B3
-      # Namespace for OpenTelemetry b3 multi header encoding
+      # Namespace for OpenTelemetry B3 multi header encoding
       module Multi
         extend self
 
-        TEXT_MAP_EXTRACTOR = TextMapExtractor.new
-        TEXT_MAP_INJECTOR = TextMapInjector.new
-        RACK_KEYS = {
-          b3_trace_id_key: 'HTTP_X_B3_TRACEID',
-          b3_span_id_key: 'HTTP_X_B3_SPANID',
-          b3_sampled_key: 'HTTP_X_B3_SAMPLED',
-          b3_flags_key: 'HTTP_X_B3_FLAGS'
-        }.freeze
-        RACK_EXTRACTOR = TextMapExtractor.new(**RACK_KEYS)
-        RACK_INJECTOR = TextMapInjector.new(**RACK_KEYS)
+        TEXT_MAP_PROPAGATOR = TextMapPropagator.new
 
-        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR, :RACK_INJECTOR,
-                         :RACK_EXTRACTOR, :RACK_KEYS
+        private_constant :TEXT_MAP_PROPAGATOR
 
-        # Returns an extractor that extracts context in the B3 multi header
-        # format
-        def text_map_injector
-          TEXT_MAP_INJECTOR
-        end
-
-        # Returns an injector that injects context in the B3 multi header
-        # format
-        def text_map_extractor
-          TEXT_MAP_EXTRACTOR
-        end
-
-        # Returns an extractor that extracts context in the B3 multi header
-        # format with Rack normalized keys (upcased and prefixed with
-        # HTTP_)
-        def rack_injector
-          RACK_INJECTOR
-        end
-
-        # Returns an injector that injects context in the B3 multi header
-        # format with Rack normalized keys (upcased and prefixed with
-        # HTTP_)
-        def rack_extractor
-          RACK_EXTRACTOR
+        # Returns a text map propagator that propagates context using the
+        # B3 multi header format.
+        def text_map_propagator
+          TEXT_MAP_PROPAGATOR
         end
       end
     end

data/lib/opentelemetry/propagator/b3/multi/text_map_propagator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  # Namespace for OpenTelemetry propagator extension libraries
+  module Propagator
+    # Namespace for OpenTelemetry B3 propagation
+    module B3
+      # Namespace for OpenTelemetry B3 multi header encoding
+      module Multi
+        # Propagates trace context using the B3 multi header format
+        class TextMapPropagator
+          include TextMapExtractor
+
+          FIELDS = [B3_TRACE_ID_KEY, B3_SPAN_ID_KEY, B3_SAMPLED_KEY, B3_FLAGS_KEY].freeze
+
+          private_constant :FIELDS
+
+          # Inject trace context into the supplied carrier.
+          #
+          # @param [Carrier] carrier The mutable carrier to inject trace context into
+          # @param [Context] context The context to read trace context from
+          # @param [optional Setter] setter If the optional setter is provided, it
+          #   will be used to write context into the carrier, otherwise the default
+          #   text map setter will be used.
+          def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter)
+            span_context = Trace.current_span(context).context
+            return unless span_context.valid?
+
+            setter.set(carrier, B3_TRACE_ID_KEY, span_context.hex_trace_id)
+            setter.set(carrier, B3_SPAN_ID_KEY, span_context.hex_span_id)
+
+            if B3.debug?(context)
+              setter.set(carrier, B3_FLAGS_KEY, '1')
+            elsif span_context.trace_flags.sampled?
+              setter.set(carrier, B3_SAMPLED_KEY, '1')
+            else
+              setter.set(carrier, B3_SAMPLED_KEY, '0')
+            end
+
+            nil
+          end
+
+          # Returns the predefined propagation fields. If your carrier is reused, you
+          # should delete the fields returned by this method before calling +inject+.
+          #
+          # @return [Array<String>] a list of fields that will be used by this propagator.
+          def fields
+            FIELDS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/single.rb

@@ -4,8 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require_relative './single/text_map_extractor'
-require_relative './single/text_map_injector'
+require_relative './single/text_map_propagator'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -18,46 +17,18 @@ module OpenTelemetry
   module Propagator
     # Namespace for OpenTelemetry B3 propagation
     module B3
-      # Namespace for OpenTelemetry b3 single header encoding
+      # Namespace for OpenTelemetry B3 single header encoding
       module Single
         extend self
 
-        TEXT_MAP_EXTRACTOR = TextMapExtractor.new
-        TEXT_MAP_INJECTOR = TextMapInjector.new
-        RACK_EXTRACTOR = TextMapExtractor.new(
-          b3_key: 'HTTP_B3'
-        )
-        RACK_INJECTOR = TextMapInjector.new(
-          b3_key: 'HTTP_B3'
-        )
+        TEXT_MAP_PROPAGATOR = TextMapPropagator.new
 
-        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR, :RACK_INJECTOR,
-                         :RACK_EXTRACTOR
+        private_constant :TEXT_MAP_PROPAGATOR
 
-        # Returns an extractor that extracts context in the B3 single header
-        # format
-        def text_map_injector
-          TEXT_MAP_INJECTOR
-        end
-
-        # Returns an injector that injects context in the B3 single header
-        # format
-        def text_map_extractor
-          TEXT_MAP_EXTRACTOR
-        end
-
-        # Returns an extractor that extracts context in the B3 single header
-        # format with Rack normalized keys (upcased and prefixed with
-        # HTTP_)
-        def rack_injector
-          RACK_INJECTOR
-        end
-
-        # Returns an injector that injects context in the B3 single header
-        # format with Rack normalized keys (upcased and prefixed with
-        # HTTP_)
-        def rack_extractor
-          RACK_EXTRACTOR
+        # Returns a text map propagator that propagates context using the
+        # B3 single header format.
+        def text_map_propagator
+          TEXT_MAP_PROPAGATOR
         end
       end
     end

data/lib/opentelemetry/propagator/b3/single/text_map_propagator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  # Namespace for OpenTelemetry propagator extension libraries
+  module Propagator
+    # Namespace for OpenTelemetry B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 single header encoding
+      module Single
+        # Propagates trace context using the b3 single header format
+        class TextMapPropagator
+          include TextMapExtractor
+
+          FIELDS = [B3_CONTEXT_KEY].freeze
+
+          private_constant :FIELDS
+
+          # Inject trace context into the supplied carrier.
+          #
+          # @param [Carrier] carrier The mutable carrier to inject trace context into
+          # @param [Context] context The context to read trace context from
+          # @param [optional Setter] setter If the optional setter is provided, it
+          #   will be used to write context into the carrier, otherwise the default
+          #   text map setter will be used.
+          def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter)
+            span_context = Trace.current_span(context).context
+            return unless span_context.valid?
+
+            sampling_state = if B3.debug?(context)
+                               'd'
+                             elsif span_context.trace_flags.sampled?
+                               '1'
+                             else
+                               '0'
+                             end
+
+            b3_value = "#{span_context.hex_trace_id}-#{span_context.hex_span_id}-#{sampling_state}"
+
+            setter.set(carrier, B3_CONTEXT_KEY, b3_value)
+            nil
+          end
+
+          # Returns the predefined propagation fields. If your carrier is reused, you
+          # should delete the fields returned by this method before calling +inject+.
+          #
+          # @return [Array<String>] a list of fields that will be used by this propagator.
+          def fields
+            FIELDS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/text_map_extractor.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  # Namespace for OpenTelemetry propagator extension libraries
+  module Propagator
+    # Namespace for OpenTelemetry B3 propagation
+    module B3
+      # Extracts trace context using the b3 single or multi header formats, favouring b3 single header.
+      module TextMapExtractor
+        B3_CONTEXT_REGEX = /\A(?<trace_id>(?:[0-9a-f]{16}){1,2})-(?<span_id>[0-9a-f]{16})(?:-(?<sampling_state>[01d](?![0-9a-f])))?(?:-(?<parent_span_id>[0-9a-f]{16}))?\z/.freeze
+        B3_TRACE_ID_REGEX = /\A(?:[0-9a-f]{16}){1,2}\z/.freeze
+        B3_SPAN_ID_REGEX = /\A[0-9a-f]{16}\z/.freeze
+        SAMPLED_VALUES = %w[1 true].freeze
+
+        B3_CONTEXT_KEY = 'b3'
+        B3_TRACE_ID_KEY = 'X-B3-TraceId'
+        B3_SPAN_ID_KEY = 'X-B3-SpanId'
+        B3_SAMPLED_KEY = 'X-B3-Sampled'
+        B3_FLAGS_KEY = 'X-B3-Flags'
+
+        private_constant :B3_CONTEXT_REGEX, :B3_TRACE_ID_REGEX, :B3_SPAN_ID_REGEX, :SAMPLED_VALUES
+        private_constant :B3_CONTEXT_KEY, :B3_TRACE_ID_KEY, :B3_SPAN_ID_KEY, :B3_SAMPLED_KEY, :B3_FLAGS_KEY
+
+        # Extract trace context from the supplied carrier. The b3 single header takes
+        # precedence over the multi-header format.
+        # If extraction fails, the original context will be returned.
+        #
+        # @param [Carrier] carrier The carrier to get the header from
+        # @param [optional Context] context Context to be updated with the trace context
+        #   extracted from the carrier. Defaults to +Context.current+.
+        # @param [optional Getter] getter If the optional getter is provided, it
+        #   will be used to read the header from the carrier, otherwise the default
+        #   text map getter will be used.
+        #
+        # @return [Context] context updated with extracted baggage, or the original context
+        #   if extraction fails
+        def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
+          extract_b3_single_header(carrier, context, getter) || extract_b3_multi_header(carrier, context, getter) || context
+        end
+
+        private
+
+        def extract_b3_single_header(carrier, context, getter)
+          match = getter.get(carrier, B3_CONTEXT_KEY)&.match(B3_CONTEXT_REGEX)
+          return unless match
+
+          debug = match['sampling_state'] == 'd'
+          sampled = debug || match['sampling_state'] == '1'
+          extracted_context(match['trace_id'], match['span_id'], sampled, debug, context)
+        end
+
+        def extract_b3_multi_header(carrier, context, getter)
+          trace_id_hex = getter.get(carrier, B3_TRACE_ID_KEY)
+          return unless B3_TRACE_ID_REGEX.match?(trace_id_hex)
+
+          span_id_hex = getter.get(carrier, B3_SPAN_ID_KEY)
+          return unless B3_SPAN_ID_REGEX.match?(span_id_hex)
+
+          sampled = getter.get(carrier, B3_SAMPLED_KEY)
+          flags = getter.get(carrier, B3_FLAGS_KEY)
+
+          debug = flags == '1'
+          sampled = debug || SAMPLED_VALUES.include?(sampled)
+          extracted_context(trace_id_hex, span_id_hex, sampled, debug, context)
+        end
+
+        def extracted_context(trace_id_hex, span_id_hex, sampled, debug, context)
+          span_context = Trace::SpanContext.new(
+            trace_id: to_trace_id(trace_id_hex),
+            span_id: to_span_id(span_id_hex),
+            trace_flags: to_trace_flags(sampled),
+            remote: true
+          )
+
+          span = Trace::Span.new(span_context: span_context)
+          context = B3.context_with_debug(context) if debug
+          Trace.context_with_span(span, parent_context: context)
+        end
+
+        def to_trace_flags(sampled)
+          if sampled
+            Trace::TraceFlags::SAMPLED
+          else
+            Trace::TraceFlags::DEFAULT
+          end
+        end
+
+        # Convert an id from a hex encoded string to byte array, optionally left
+        # padding to the correct length. Assumes the input id has already been
+        # validated to be 16 or 32 characters in length.
+        def to_trace_id(hex_id)
+          if hex_id.length == 32
+            Array(hex_id).pack('H*')
+          else
+            [0, hex_id].pack('qH*')
+          end
+        end
+
+        # Convert an id from a hex encoded string to byte array.
+        def to_span_id(hex_id)
+          Array(hex_id).pack('H*')
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module B3
-      VERSION = '0.12.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-b3
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-24 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +136,19 @@ files:
 - lib/opentelemetry-propagator-b3.rb
 - lib/opentelemetry/propagator/b3.rb
 - lib/opentelemetry/propagator/b3/multi.rb
-- lib/opentelemetry/propagator/b3/multi/text_map_extractor.rb
-- lib/opentelemetry/propagator/b3/multi/text_map_injector.rb
+- lib/opentelemetry/propagator/b3/multi/text_map_propagator.rb
 - lib/opentelemetry/propagator/b3/single.rb
-- lib/opentelemetry/propagator/b3/single/text_map_extractor.rb
-- lib/opentelemetry/propagator/b3/single/text_map_injector.rb
+- lib/opentelemetry/propagator/b3/single/text_map_propagator.rb
+- lib/opentelemetry/propagator/b3/text_map_extractor.rb
 - lib/opentelemetry/propagator/b3/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.12.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/propagator/b3
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.17.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/propagator/b3
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.12.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.17.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -165,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: B3 Context Propagation Extension for the OpenTelemetry framework

data/lib/opentelemetry/propagator/b3/multi/text_map_extractor.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-# OpenTelemetry is an open source observability framework, providing a
-# general-purpose API, SDK, and related tools required for the instrumentation
-# of cloud-native software, frameworks, and libraries.
-#
-# The OpenTelemetry module provides global accessors for telemetry objects.
-# See the documentation for the `opentelemetry-api` gem for details.
-module OpenTelemetry
-  # Namespace for OpenTelemetry propagator extension libraries
-  module Propagator
-    # Namespace for OpenTelemetry B3 propagation
-    module B3
-      # Namespace for OpenTelemetry b3 multi header encoding
-      module Multi
-        # Extracts context from carriers in the b3 single header format
-        class TextMapExtractor
-          include Context::Propagation::DefaultGetter
-
-          B3_TRACE_ID_REGEX = /\A(?:[0-9a-f]{16}){1,2}\z/.freeze
-          B3_SPAN_ID_REGEX = /\A[0-9a-f]{16}\z/.freeze
-          SAMPLED_VALUES = %w[1 true].freeze
-          DEBUG_FLAG = '1'
-          private_constant :B3_TRACE_ID_REGEX, :B3_SPAN_ID_REGEX, :SAMPLED_VALUES, :DEBUG_FLAG
-
-          # Returns a new TextMapExtractor that extracts b3 context using the
-          # specified header keys
-          #
-          # @param [String] b3_trace_id_key The b3 trace id key used in the carrier
-          # @param [String] b3_span_id_key The b3 span id key used in the carrier
-          # @param [String] b3_sampled_key The b3 sampled key used in the carrier
-          # @param [String] b3_flags_key The b3 flags key used in the carrier
-          # @return [TextMapExtractor]
-          def initialize(b3_trace_id_key: 'X-B3-TraceId',
-                         b3_span_id_key: 'X-B3-SpanId',
-                         b3_sampled_key: 'X-B3-Sampled',
-                         b3_flags_key: 'X-B3-Flags')
-            @b3_trace_id_key = b3_trace_id_key
-            @b3_span_id_key = b3_span_id_key
-            @b3_sampled_key = b3_sampled_key
-            @b3_flags_key = b3_flags_key
-          end
-
-          # Extract b3 context from the supplied carrier and set the active span
-          # in the given context. The original context will be returned if b3
-          # cannot be extracted from the carrier.
-          #
-          # @param [Carrier] carrier The carrier to get the header from.
-          # @param [Context] context The context to be updated with extracted context
-          # @param [optional Callable] getter An optional callable that takes a carrier and a key and
-          #   returns the value associated with the key. If omitted the default getter will be used
-          #   which expects the carrier to respond to [] and []=.
-          # @yield [Carrier, String] if an optional getter is provided, extract will yield the carrier
-          #   and the header key to the getter.
-          # @return [Context] Updated context with active span derived from the header, or the original
-          #   context if parsing fails.
-          def extract(carrier, context, &getter)
-            getter ||= default_getter
-
-            trace_id_hex = getter.call(carrier, @b3_trace_id_key)
-            return context unless valid_trace_id?(trace_id_hex)
-
-            span_id_hex = getter.call(carrier, @b3_span_id_key)
-            return context unless valid_span_id?(span_id_hex)
-
-            sampled = getter.call(carrier, @b3_sampled_key)
-            flags = getter.call(carrier, @b3_flags_key)
-
-            context = B3.context_with_debug(context) if flags == DEBUG_FLAG
-
-            span_context = Trace::SpanContext.new(
-              trace_id: B3.to_trace_id(trace_id_hex),
-              span_id: B3.to_span_id(span_id_hex),
-              trace_flags: to_trace_flags(sampled, flags),
-              remote: true
-            )
-
-            span = Trace::Span.new(span_context: span_context)
-            Trace.context_with_span(span, parent_context: context)
-          rescue OpenTelemetry::Error
-            context
-          end
-
-          private
-
-          def to_trace_flags(sampled, b3_flags)
-            if b3_flags == DEBUG_FLAG || SAMPLED_VALUES.include?(sampled)
-              Trace::TraceFlags::SAMPLED
-            else
-              Trace::TraceFlags::DEFAULT
-            end
-          end
-
-          def valid_trace_id?(trace_id)
-            B3_TRACE_ID_REGEX.match?(trace_id)
-          end
-
-          def valid_span_id?(span_id)
-            B3_SPAN_ID_REGEX.match?(span_id)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/propagator/b3/multi/text_map_injector.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-module OpenTelemetry
-  # Namespace for OpenTelemetry propagator extension libraries
-  module Propagator
-    # Namespace for OpenTelemetry B3 propagation
-    module B3
-      # Namespace for OpenTelemetry b3 single header encoding
-      module Multi
-        # Injects context into carriers using the b3 single header format
-        class TextMapInjector
-          include Context::Propagation::DefaultSetter
-
-          # Returns a new TextMapInjector that extracts b3 context using the
-          # specified header keys
-          #
-          # @param [String] b3_trace_id_key The b3 trace id key used in the carrier
-          # @param [String] b3_span_id_key The b3 span id key used in the carrier
-          # @param [String] b3_sampled_key The b3 sampled key used in the carrier
-          # @param [String] b3_flags_key The b3 flags key used in the carrier
-          # @return [TextMapInjector]
-          def initialize(b3_trace_id_key: 'X-B3-TraceId',
-                         b3_span_id_key: 'X-B3-SpanId',
-                         b3_sampled_key: 'X-B3-Sampled',
-                         b3_flags_key: 'X-B3-Flags')
-            @b3_trace_id_key = b3_trace_id_key
-            @b3_span_id_key = b3_span_id_key
-            @b3_sampled_key = b3_sampled_key
-            @b3_flags_key = b3_flags_key
-          end
-
-          # Set the span context on the supplied carrier.
-          #
-          # @param [Context] context The active Context.
-          # @param [optional Callable] setter An optional callable that takes a carrier and a key and
-          #   a value and assigns the key-value pair in the carrier. If omitted the default setter
-          #   will be used which expects the carrier to respond to [] and []=.
-          # @yield [Carrier, String, String] if an optional setter is provided, inject will yield
-          #   carrier, header key, header value to the setter.
-          # @return [Object] the carrier with context injected
-          def inject(carrier, context, &setter)
-            span_context = Trace.current_span(context).context
-            return unless span_context.valid?
-
-            setter ||= default_setter
-            setter.call(carrier, @b3_trace_id_key, span_context.hex_trace_id)
-            setter.call(carrier, @b3_span_id_key, span_context.hex_span_id)
-
-            if B3.debug?(context)
-              setter.call(carrier, @b3_flags_key, '1')
-            elsif span_context.trace_flags.sampled?
-              setter.call(carrier, @b3_sampled_key, '1')
-            else
-              setter.call(carrier, @b3_sampled_key, '0')
-            end
-
-            carrier
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/propagator/b3/single/text_map_extractor.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-# OpenTelemetry is an open source observability framework, providing a
-# general-purpose API, SDK, and related tools required for the instrumentation
-# of cloud-native software, frameworks, and libraries.
-#
-# The OpenTelemetry module provides global accessors for telemetry objects.
-# See the documentation for the `opentelemetry-api` gem for details.
-module OpenTelemetry
-  # Namespace for OpenTelemetry propagator extension libraries
-  module Propagator
-    # Namespace for OpenTelemetry B3 propagation
-    module B3
-      # Namespace for OpenTelemetry b3 single header encoding
-      module Single
-        # Extracts context from carriers in the b3 single header format
-        class TextMapExtractor
-          include Context::Propagation::DefaultGetter
-
-          B3_CONTEXT_REGEX = /\A(?<trace_id>(?:[0-9a-f]{16}){1,2})-(?<span_id>[0-9a-f]{16})(?:-(?<sampling_state>[01d](?![0-9a-f])))?(?:-(?<parent_span_id>[0-9a-f]{16}))?\z/.freeze
-          SAMPLED_VALUES = %w[1 d].freeze
-
-          # Returns a new TextMapExtractor that extracts b3 context using the
-          # specified header keys
-          #
-          # @param [String] b3_key The b3 header key used in the carrier
-          # @return [TextMapExtractor]
-          def initialize(b3_key: 'b3')
-            @b3_key = b3_key
-          end
-
-          # Extract b3 context from the supplied carrier and set the active span
-          # in the given context. The original context will be returned if b3
-          # cannot be extracted from the carrier.
-          #
-          # @param [Carrier] carrier The carrier to get the header from.
-          # @param [Context] context The context to be updated with extracted context
-          # @param [optional Callable] getter An optional callable that takes a carrier and a key and
-          #   returns the value associated with the key. If omitted the default getter will be used
-          #   which expects the carrier to respond to [] and []=.
-          # @yield [Carrier, String] if an optional getter is provided, extract will yield the carrier
-          #   and the header key to the getter.
-          # @return [Context] Updated context with active span derived from the header, or the original
-          #   context if parsing fails.
-          def extract(carrier, context, &getter)
-            getter ||= default_getter
-            header = getter.call(carrier, @b3_key)
-            return context unless (match = header.match(B3_CONTEXT_REGEX))
-
-            span_context = Trace::SpanContext.new(
-              trace_id: B3.to_trace_id(match['trace_id']),
-              span_id: B3.to_span_id(match['span_id']),
-              trace_flags: to_trace_flags(match['sampling_state']),
-              remote: true
-            )
-
-            span = Trace::Span.new(span_context: span_context)
-            context = B3.context_with_debug(context) if match['sampling_state'] == 'd'
-            Trace.context_with_span(span, parent_context: context)
-          rescue OpenTelemetry::Error
-            context
-          end
-
-          private
-
-          def to_trace_flags(sampling_state)
-            if SAMPLED_VALUES.include?(sampling_state)
-              Trace::TraceFlags::SAMPLED
-            else
-              Trace::TraceFlags::DEFAULT
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/propagator/b3/single/text_map_injector.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-module OpenTelemetry
-  # Namespace for OpenTelemetry propagator extension libraries
-  module Propagator
-    # Namespace for OpenTelemetry B3 propagation
-    module B3
-      # Namespace for OpenTelemetry b3 single header encoding
-      module Single
-        # Injects context into carriers using the b3 single header format
-        class TextMapInjector
-          include Context::Propagation::DefaultSetter
-
-          # Returns a new TextMapInjector that extracts b3 context using the
-          # specified header keys
-          #
-          # @param [String] b3_key The b3 header key used in the carrier
-          # @return [TextMapInjector]
-          def initialize(b3_key: 'b3')
-            @b3_key = b3_key
-          end
-
-          # Set the span context on the supplied carrier.
-          #
-          # @param [Context] context The active Context.
-          # @param [optional Callable] setter An optional callable that takes a carrier and a key and
-          #   a value and assigns the key-value pair in the carrier. If omitted the default setter
-          #   will be used which expects the carrier to respond to [] and []=.
-          # @yield [Carrier, String, String] if an optional setter is provided, inject will yield
-          #   carrier, header key, header value to the setter.
-          # @return [Object] the carrier with context injected
-          def inject(carrier, context, &setter)
-            span_context = Trace.current_span(context).context
-            return unless span_context.valid?
-
-            sampling_state = if B3.debug?(context)
-                               'd'
-                             elsif span_context.trace_flags.sampled?
-                               '1'
-                             else
-                               '0'
-                             end
-
-            b3_value = "#{span_context.hex_trace_id}-#{span_context.hex_span_id}-#{sampling_state}"
-
-            setter ||= default_setter
-            setter.call(carrier, @b3_key, b3_value)
-            carrier
-          end
-        end
-      end
-    end
-  end
-end