opentelemetry-propagator-b3 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3570b2000ae0b517565514277cc6c86a4bf67b0fde6c618c2f163b5c48df449c
-  data.tar.gz: 96503278713f32ded98d089540e6c02265a78d22bff1b36f73382e620f9fb3e7
+  metadata.gz: 8d91ca9b41681fbaafa63c1090c806fc543c20fed191f023dae9716550352073
+  data.tar.gz: e4a29d5020b91f3cf4471a000ac26cf6eb6e257a1f4b9db529e038e17bf6878c
 SHA512:
-  metadata.gz: d5111bfbfe710e20f3ee33e72bca5808efda2f7617d1dccf27be232b4b62de39c58cd06f682a483a840a1f57ff62b4dd4bfbf021e25ac3a48fef868df7f10f05
-  data.tar.gz: 2b7f0fab8add5b183372f39ec001388b7a6ac8ecd816ece7e14c6b4a5354a7578877607ec6fbff1ea5c0118eeccce5c9b588bd88387b262120dd2ec16ad696b2
+  metadata.gz: c030c835ca7f15dcc46dd6f3833b751993cfe0f85b70089bc27a2234f85764f4c8bb329114fdf2863bb3fbdb470396ffba533c55d2fbd52b8c4dcdaaa1577695
+  data.tar.gz: 7ebe75ca368447296e8d3a53cb787671846b5bf2e3ee4abac8d0c1849f7c3cd6446822258ac4f5ed5cf841e6185b23fd4792de3f3df96978769960e8ffa73d22

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-propagator-b3
 
+### 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)

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

@@ -22,19 +22,15 @@ module OpenTelemetry
       module Multi
         extend self
 
+        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'
         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)
 
-        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR, :RACK_INJECTOR,
-                         :RACK_EXTRACTOR, :RACK_KEYS
+        private_constant :B3_TRACE_ID_KEY, :B3_SPAN_ID_KEY, :B3_SAMPLED_KEY,
+                         :B3_FLAGS_KEY, :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR
 
         # Returns an extractor that extracts context in the B3 multi header
         # format
@@ -47,20 +43,6 @@ module OpenTelemetry
         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
-        end
       end
     end
   end

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

@@ -19,8 +19,6 @@ module OpenTelemetry
       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
@@ -28,21 +26,14 @@ module OpenTelemetry
           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
+          # specified getter
           #
-          # @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
+          # @param [optional Getter] default_getter The default getter used to read
+          #   headers from a carrier during extract. Defaults to a
+          #   {OpenTelemetry::Context:Propagation::TextMapGetter} instance.
           # @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
+          def initialize(default_getter = Context::Propagation.text_map_getter)
+            @default_getter = default_getter
           end
 
           # Extract b3 context from the supplied carrier and set the active span
@@ -51,24 +42,22 @@ module OpenTelemetry
           #
           # @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.
+          # @param [optional Getter] getter If the optional getter is provided, it
+          #   will be used to read the header from the carrier, otherwise the default
+          #   getter will be used.
           # @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
+          def extract(carrier, context, getter = nil)
+            getter ||= @default_getter
 
-            trace_id_hex = getter.call(carrier, @b3_trace_id_key)
+            trace_id_hex = getter.get(carrier, B3_TRACE_ID_KEY)
             return context unless valid_trace_id?(trace_id_hex)
 
-            span_id_hex = getter.call(carrier, @b3_span_id_key)
+            span_id_hex = getter.get(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)
+            sampled = getter.get(carrier, B3_SAMPLED_KEY)
+            flags = getter.get(carrier, B3_FLAGS_KEY)
 
             context = B3.context_with_debug(context) if flags == DEBUG_FLAG
 

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

@@ -12,49 +12,38 @@ module OpenTelemetry
       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
+          # Returns a new TextMapInjector that injects b3 context using the
+          # specified setter
           #
-          # @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
+          # @param [optional Setter] default_setter The default setter used to
+          #   write context into a carrier during inject. Defaults to a
+          #   {OpenTelemetry::Context:Propagation::TextMapSetter} instance.
           # @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
+          def initialize(default_setter = Context::Propagation.text_map_setter)
+            @default_setter = default_setter
           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.
+          # @param [optional Setter] setter If the optional setter is provided, it
+          #   will be used to write context into the carrier, otherwise the default
+          #   setter will be used.
           # @return [Object] the carrier with context injected
-          def inject(carrier, context, &setter)
+          def inject(carrier, context, setter = nil)
             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)
+            setter ||= @default_setter
+            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.call(carrier, @b3_flags_key, '1')
+              setter.set(carrier, B3_FLAGS_KEY, '1')
             elsif span_context.trace_flags.sampled?
-              setter.call(carrier, @b3_sampled_key, '1')
+              setter.set(carrier, B3_SAMPLED_KEY, '1')
             else
-              setter.call(carrier, @b3_sampled_key, '0')
+              setter.set(carrier, B3_SAMPLED_KEY, '0')
             end
 
             carrier

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

@@ -22,17 +22,11 @@ module OpenTelemetry
       module Single
         extend self
 
+        B3_CONTEXT_KEY = 'b3'
         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'
-        )
 
-        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR, :RACK_INJECTOR,
-                         :RACK_EXTRACTOR
+        private_constant :B3_CONTEXT_KEY, :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR
 
         # Returns an extractor that extracts context in the B3 single header
         # format
@@ -45,20 +39,6 @@ module OpenTelemetry
         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
-        end
       end
     end
   end

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

@@ -19,18 +19,18 @@ module OpenTelemetry
       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
+          # specified getter
           #
-          # @param [String] b3_key The b3 header key used in the carrier
+          # @param [optional Getter] default_getter The default getter used to read
+          #   headers from a carrier during extract. Defaults to a
+          #   {OpenTelemetry::Context:Propagation::TextMapGetter} instance.
           # @return [TextMapExtractor]
-          def initialize(b3_key: 'b3')
-            @b3_key = b3_key
+          def initialize(default_getter = Context::Propagation.text_map_getter)
+            @default_getter = default_getter
           end
 
           # Extract b3 context from the supplied carrier and set the active span
@@ -39,16 +39,14 @@ module OpenTelemetry
           #
           # @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.
+          # @param [optional Getter] getter If the optional getter is provided, it
+          #   will be used to read the header from the carrier, otherwise the default
+          #   getter will be used.
           # @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)
+          def extract(carrier, context, getter = nil)
+            getter ||= @default_getter
+            header = getter.get(carrier, B3_CONTEXT_KEY)
             return context unless (match = header.match(B3_CONTEXT_REGEX))
 
             span_context = Trace::SpanContext.new(

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

@@ -12,27 +12,25 @@ module OpenTelemetry
       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
+          # Returns a new TextMapInjector that injects b3 context using the
+          # specified setter
           #
-          # @param [String] b3_key The b3 header key used in the carrier
+          # @param [optional Setter] default_setter The default setter used to
+          #   write context into a carrier during inject. Defaults to a
+          #   {OpenTelemetry::Context:Propagation::TextMapSetter} instance.
           # @return [TextMapInjector]
-          def initialize(b3_key: 'b3')
-            @b3_key = b3_key
+          def initialize(default_setter = Context::Propagation.text_map_setter)
+            @default_setter = default_setter
           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.
+          # @param [optional Setter] setter If the optional setter is provided, it
+          #   will be used to write context into the carrier, otherwise the default
+          #   setter will be used.
           # @return [Object] the carrier with context injected
-          def inject(carrier, context, &setter)
+          def inject(carrier, context, setter = nil)
             span_context = Trace.current_span(context).context
             return unless span_context.valid?
 
@@ -46,8 +44,8 @@ module OpenTelemetry
 
             b3_value = "#{span_context.hex_trace_id}-#{span_context.hex_span_id}-#{sampling_state}"
 
-            setter ||= default_setter
-            setter.call(carrier, @b3_key, b3_value)
+            setter ||= @default_setter
+            setter.set(carrier, B3_CONTEXT_KEY, b3_value)
             carrier
           end
         end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module B3
-      VERSION = '0.13.0'
+      VERSION = '0.14.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-b3
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-02-03 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.13.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -146,10 +146,10 @@ 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.13.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.14.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.13.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.14.0
 post_install_message: 
 rdoc_options: []
 require_paths: