opentelemetry-propagator-jaeger 0.16.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e309829185d53b310beb404e6db7bf7c50bf1b52638e0c2abe4316d569bcf79d
-  data.tar.gz: 1c70d8fc82e5833d8c93554662536b5b7f017d5e38367c19dd2ea9fdb07aa42e
+  metadata.gz: 7a654d390032141e29a85ed30947ca5fe8d849107716376205ea3c268c49f2f6
+  data.tar.gz: 158c5925352505f218cd4b5464b238eac2691dd268c9c59e255cabe43638485b
 SHA512:
-  metadata.gz: dab712ae65175d5b4024e0879ba8bcc1ff0403af73209f7596cf05994d5b8f4e868617ac22384cb75cfc11d2469f01bad51e3f4dd340dd307c1010ff03c3ca3e
-  data.tar.gz: e607b7cd32db1fa516452084faaa9acf920a858c2d13c879ea883e86b8157b72af4ac8e901a07fbc863d26ddeb1ee58201ac6e8880ecc29dd44fef179f680c79
+  metadata.gz: 17e1a8f17565ba610f848e63209af14a5c8d3a3e9c17559c90709a0f790a84b588118492bf0a44336ce57bb795af8a0345de8987e20d782e2a1f9d596df13a6c
+  data.tar.gz: 369d618f1efeb8d6855f14c3c66d67f11a0472667c67e2ea5036808651fb99761771f3499ed71fb08eba8a6f6d083bb5c78ec5af7539f2f142dbfa127eec9a63

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History: opentelemetry-propagator-jaeger
 
+### v0.19.1 / 2021-08-12
+
+* (No significant changes)
+
+### v0.19.0 / 2021-06-23
+
+* BREAKING CHANGE: Refactor Baggage to remove Noop* 
+
+* ADDED: Add Tracer.non_recording_span to API 
+* FIXED: Refactor Baggage to remove Noop* 
+
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+
+### 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_propagator.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'cgi'
+
+# 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 Jaeger propagation
+    module Jaeger
+      # 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
+
+        private_constant \
+          :IDENTITY_KEY, :DEFAULT_FLAG_BIT, :SAMPLED_FLAG_BIT, :DEBUG_FLAG_BIT,
+          :FIELDS, :TRACE_SPAN_IDENTITY_REGEX, :ZERO_ID_REGEX
+
+        # 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 [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)
+          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
+          return context if match['span_id'] =~ ZERO_ID_REGEX
+
+          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 = 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)
+          trace_id = to_trace_id(match['trace_id'])
+          span_context = Trace::SpanContext.new(
+            trace_id: trace_id,
+            span_id: to_span_id(match['span_id']),
+            trace_flags: to_trace_flags(sampling_flags),
+            remote: true
+          )
+          OpenTelemetry::Trace.non_recording_span(span_context)
+        end
+
+        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|
+              baggage_key = carrier_key.start_with?(baggage_key_prefix) && carrier_key[baggage_key_prefix.length..-1]
+              next unless baggage_key
+
+              raw_value = getter.get(carrier, carrier_key)
+              value = CGI.unescape(raw_value)
+              b.set_value(baggage_key, value)
+            end
+          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
+          else
+            Trace::TraceFlags::DEFAULT
+          end
+        end
+
+        def to_span_id(span_id_str)
+          [span_id_str.rjust(16, '0')].pack('H*')
+        end
+
+        def to_trace_id(trace_id_str)
+          [trace_id_str.rjust(32, '0')].pack('H*')
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module Jaeger
-      VERSION = '0.16.0'
+      VERSION = '0.19.1'
     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.19.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-08-16 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: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   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.19.1/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.19.1
 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_extractor.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require 'cgi'
-
-# 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 Jaeger propagation
-    module Jaeger
-      # Extracts context from carriers
-      class TextMapExtractor
-        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
-
-        # 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.
-        #
-        # @param [Carrier] carrier The carrier to get the header from.
-        # @param [Context] context The context to be updated with extracted
-        #   context
-        # @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
-          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
-          return context if match['span_id'] =~ ZERO_ID_REGEX
-
-          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)
-          Trace.context_with_span(span, parent_context: context)
-        end
-
-        private
-
-        def build_span(match, sampling_flags)
-          trace_id = to_trace_id(match['trace_id'])
-          span_context = Trace::SpanContext.new(
-            trace_id: trace_id,
-            span_id: to_span_id(match['span_id']),
-            trace_flags: to_trace_flags(sampling_flags),
-            remote: true
-          )
-          Trace::Span.new(span_context: span_context)
-        end
-
-        def set_baggage(carrier, context, getter)
-          baggage_key_prefix = 'uberctx-'
-          OpenTelemetry.baggage.build(context: context) do |b|
-            getter.keys(carrier).each do |carrier_key|
-              baggage_key = carrier_key.start_with?(baggage_key_prefix) && carrier_key[baggage_key_prefix.length..-1]
-              next unless baggage_key
-
-              raw_value = getter.get(carrier, carrier_key)
-              value = CGI.unescape(raw_value)
-              b.set_value(baggage_key, value)
-            end
-          end
-        end
-
-        def to_trace_flags(sampling_flags)
-          if (sampling_flags & SAMPLED_FLAG_BIT) != 0
-            Trace::TraceFlags::SAMPLED
-          else
-            Trace::TraceFlags::DEFAULT
-          end
-        end
-
-        def to_span_id(span_id_str)
-          [span_id_str.rjust(16, '0')].pack('H*')
-        end
-
-        def to_trace_id(trace_id_str)
-          [trace_id_str.rjust(32, '0')].pack('H*')
-        end
-      end
-    end
-  end
-end

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