opentelemetry-propagator-jaeger 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e309829185d53b310beb404e6db7bf7c50bf1b52638e0c2abe4316d569bcf79d
-  data.tar.gz: 1c70d8fc82e5833d8c93554662536b5b7f017d5e38367c19dd2ea9fdb07aa42e
+  metadata.gz: 7dece159e0c94c5fa48147b8ef28b92306061f4d6a2495f881ed485ab2e688eb
+  data.tar.gz: 73ba94fa32820c294d8831a06e9996f8b9b4e0ccf3f7c0faf6ed8bc9577a2834
 SHA512:
-  metadata.gz: dab712ae65175d5b4024e0879ba8bcc1ff0403af73209f7596cf05994d5b8f4e868617ac22384cb75cfc11d2469f01bad51e3f4dd340dd307c1010ff03c3ca3e
-  data.tar.gz: e607b7cd32db1fa516452084faaa9acf920a858c2d13c879ea883e86b8157b72af4ac8e901a07fbc863d26ddeb1ee58201ac6e8880ecc29dd44fef179f680c79
+  metadata.gz: 581dadd5c5b73c38c98ecd59f5be345eb956d44ddb83cdd95e6eb848e92e533e0a10b90e2f3e16d8d4fedf0809b22ec86a39cee9920cab155c59862b857664cf
+  data.tar.gz: f52229bd430039b17c031029a583fe0911e0afe69a7c1e9ae9c396e7c54c6ecf9066e5e86dd963c1bf528e9acdba92e94f4ac056313b676bc7935b08686e9311

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-propagator-jaeger
 
+### 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
 
 * Initial release.

data/README.md

@@ -1,9 +1,9 @@
 # opentelemetry-propagator-jaeger
 
-The `opentelemetry-propagator-jaeger` gem contains injectors and extractors for the
-[Jaeger native propagation format][jaeger-spec]  They can be used in
-conjunction with each other as well as with injectors and extractors for
-other formats to support a variety of context propagation scenarios.
+The `opentelemetry-propagator-jaeger` gem contains a propagator for the
+[Jaeger native propagation format][jaeger-spec]  This can be used on its
+own as well as with propagators for other formats to support a variety
+of context propagation scenarios.
 
 ## What is OpenTelemetry?
 

data/lib/opentelemetry/propagator/jaeger.rb

@@ -4,8 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require_relative './jaeger/text_map_extractor'
-require_relative './jaeger/text_map_injector'
+require_relative './jaeger/text_map_propagator'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -23,28 +22,14 @@ module OpenTelemetry
       DEBUG_CONTEXT_KEY = Context.create_key('jaeger-debug-key')
       private_constant :DEBUG_CONTEXT_KEY
 
-      TEXT_MAP_EXTRACTOR = TextMapExtractor.new
-      TEXT_MAP_INJECTOR = TextMapInjector.new
+      TEXT_MAP_PROPAGATOR = TextMapPropagator.new
 
-      private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR
+      private_constant :TEXT_MAP_PROPAGATOR
 
-      IDENTITY_KEY = 'uber-trace-id'
-      DEFAULT_FLAG_BIT = 0x0
-      SAMPLED_FLAG_BIT = 0x01
-      DEBUG_FLAG_BIT   = 0x02
-
-      private_constant :IDENTITY_KEY, :DEFAULT_FLAG_BIT, :SAMPLED_FLAG_BIT, :DEBUG_FLAG_BIT
-
-      # Returns an extractor that extracts context in the Jaeger single header
-      # format
-      def text_map_injector
-        TEXT_MAP_INJECTOR
-      end
-
-      # Returns an injector that injects context in the Jaeger single header
-      # format
-      def text_map_extractor
-        TEXT_MAP_EXTRACTOR
+      # Returns a text map propagator that propagates context in the Jaeger
+      # format.
+      def text_map_propagator
+        TEXT_MAP_PROPAGATOR
       end
 
       # @api private

data/lib/opentelemetry/propagator/jaeger/{text_map_extractor.rb → text_map_propagator.rb}

@@ -17,36 +17,33 @@ module OpenTelemetry
   module Propagator
     # Namespace for OpenTelemetry Jaeger propagation
     module Jaeger
-      # Extracts context from carriers
-      class TextMapExtractor
+      # Propagates trace context using the Jaeger format
+      class TextMapPropagator
+        IDENTITY_KEY = 'uber-trace-id'
+        DEFAULT_FLAG_BIT = 0x0
+        SAMPLED_FLAG_BIT = 0x01
+        DEBUG_FLAG_BIT   = 0x02
+        FIELDS = [IDENTITY_KEY].freeze
         TRACE_SPAN_IDENTITY_REGEX = /\A(?<trace_id>(?:[0-9a-f]){1,32}):(?<span_id>([0-9a-f]){1,16}):[0-9a-f]{1,16}:(?<sampling_flags>[0-9a-f]{1,2})\z/.freeze
         ZERO_ID_REGEX = /^0+$/.freeze
 
-        # Returns a new TextMapExtractor that extracts Jaeger context using the
-        # specified header keys
-        #
-        # @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(default_getter = Context::Propagation.text_map_getter)
-          @default_getter = default_getter
-        end
+        private_constant \
+          :IDENTITY_KEY, :DEFAULT_FLAG_BIT, :SAMPLED_FLAG_BIT, :DEBUG_FLAG_BIT,
+          :FIELDS, :TRACE_SPAN_IDENTITY_REGEX, :ZERO_ID_REGEX
 
-        # Extract Jaeger context from the supplied carrier and set the active
-        # span in the given context. The original context will be return if
-        # Jaeger cannot be extracted from the carrier.
+        # Extract trace context from the supplied carrier.
+        # If extraction fails, the original context will be returned
         #
-        # @param [Carrier] carrier The carrier to get the header from.
-        # @param [Context] context The context to be updated with extracted
-        #   context
+        # @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
-        #   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 = nil)
-          getter ||= @default_getter
+        #   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)
           header = getter.get(carrier, IDENTITY_KEY)
           return context unless (match = header.match(TRACE_SPAN_IDENTITY_REGEX))
           return context if match['trace_id'] =~ ZERO_ID_REGEX
@@ -55,10 +52,42 @@ module OpenTelemetry
           sampling_flags = match['sampling_flags'].to_i
           span = build_span(match, sampling_flags)
           context = Jaeger.context_with_debug(context) if sampling_flags & DEBUG_FLAG_BIT != 0
-          context = set_baggage(carrier, context, getter)
+          context = context_with_extracted_baggage(carrier, context, getter)
           Trace.context_with_span(span, parent_context: context)
         end
 
+        # 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?
+
+          flags = to_jaeger_flags(context, span_context)
+          trace_span_identity_value = [
+            span_context.hex_trace_id, span_context.hex_span_id, '0', flags
+          ].join(':')
+          setter.set(carrier, IDENTITY_KEY, trace_span_identity_value)
+          OpenTelemetry.baggage.values(context: context).each do |key, value|
+            baggage_key = 'uberctx-' + key
+            encoded_value = CGI.escape(value)
+            setter.set(carrier, baggage_key, encoded_value)
+          end
+          carrier
+        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
+
         private
 
         def build_span(match, sampling_flags)
@@ -72,7 +101,7 @@ module OpenTelemetry
           Trace::Span.new(span_context: span_context)
         end
 
-        def set_baggage(carrier, context, getter)
+        def context_with_extracted_baggage(carrier, context, getter)
           baggage_key_prefix = 'uberctx-'
           OpenTelemetry.baggage.build(context: context) do |b|
             getter.keys(carrier).each do |carrier_key|
@@ -86,6 +115,18 @@ module OpenTelemetry
           end
         end
 
+        def to_jaeger_flags(context, span_context)
+          if span_context.trace_flags == Trace::TraceFlags::SAMPLED
+            if Jaeger.debug?(context)
+              SAMPLED_FLAG_BIT | DEBUG_FLAG_BIT
+            else
+              SAMPLED_FLAG_BIT
+            end
+          else
+            DEFAULT_FLAG_BIT
+          end
+        end
+
         def to_trace_flags(sampling_flags)
           if (sampling_flags & SAMPLED_FLAG_BIT) != 0
             Trace::TraceFlags::SAMPLED

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module Jaeger
-      VERSION = '0.16.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-jaeger
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 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.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -149,17 +149,16 @@ files:
 - README.md
 - lib/opentelemetry-propagator-jaeger.rb
 - lib/opentelemetry/propagator/jaeger.rb
-- lib/opentelemetry/propagator/jaeger/text_map_extractor.rb
-- lib/opentelemetry/propagator/jaeger/text_map_injector.rb
+- lib/opentelemetry/propagator/jaeger/text_map_propagator.rb
 - lib/opentelemetry/propagator/jaeger/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-jaeger/v0.16.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-jaeger/v0.17.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/propagator/jaeger
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-jaeger/v0.16.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-jaeger/v0.17.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -175,7 +174,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: Jaeger Context Propagation Extension for the OpenTelemetry framework

data/lib/opentelemetry/propagator/jaeger/text_map_injector.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require 'cgi'
-
-module OpenTelemetry
-  # Namespace for OpenTelemetry propagator extension libraries
-  module Propagator
-    # Namespace for OpenTelemetry Jaeger propagation
-    module Jaeger
-      # Injects context into carriers
-      class TextMapInjector
-        # Returns a new TextMapInjector that extracts Jaeger context using the
-        # specified header keys
-        #
-        # @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(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 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 = nil)
-          span_context = Trace.current_span(context).context
-          return unless span_context.valid?
-
-          flags = to_flags(context, span_context)
-          trace_span_identity_value = [
-            span_context.hex_trace_id, span_context.hex_span_id, '0', flags
-          ].join(':')
-          setter ||= @default_setter
-          setter.set(carrier, IDENTITY_KEY, trace_span_identity_value)
-          OpenTelemetry.baggage.values(context: context).each do |key, value|
-            baggage_key = 'uberctx-' + key
-            encoded_value = CGI.escape(value)
-            setter.set(carrier, baggage_key, encoded_value)
-          end
-          carrier
-        end
-
-        private
-
-        def to_flags(context, span_context)
-          if span_context.trace_flags == Trace::TraceFlags::SAMPLED
-            if Jaeger.debug?(context)
-              SAMPLED_FLAG_BIT | DEBUG_FLAG_BIT
-            else
-              SAMPLED_FLAG_BIT
-            end
-          else
-            DEFAULT_FLAG_BIT
-          end
-        end
-      end
-    end
-  end
-end