opentelemetry-propagator-ottrace 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a92304ef5e150187a19816b80c09a4b619b1c0ebcf15ea06fcf242f07355cf
-  data.tar.gz: a520eff87efdcb38cfb4f6d904bc7c1f96e5f2feb8e19f4c587377f1200e0b46
+  metadata.gz: 4665411db8f1b469735da32d19a756f490f289b8bc2780968b20490b29b43d58
+  data.tar.gz: dc0fd1103419b2cb322bc7aab68327e7084086fefe94b18bf3c337aea5aa292d
 SHA512:
-  metadata.gz: 971279dcf6f405363d25f6e1215557300a0caa5d6c757da54883acbaf04a5212241e37acfa222185758b05246e769663d088e1abf6745c2cc21f958e61747fa3
-  data.tar.gz: 6119312dec5fad82e0b8e741455c8cdfd554f2936cbac63ae822135b887a3c16d3646a7e723586e45a4fc7dcfcd2d99204033e2c75f41ed77266cbfc0a4e83a1
+  metadata.gz: 4392a5102af74a3ed5c45cdb34f46d84244da84b7b0f4e2a47ddf0ed32a1fc167af001becfd26c6bb603e018e50e38ff70e99aa35ab134c17c88c72a6a79cc41
+  data.tar.gz: 8b0211c420c8ebe892e41f874107d3ed8d829470050357ae61491e6a5ae0280148b672901b0d3ec4fe41e8f9a7aac1ee56a447afbc31438fb940c14f4829f192

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-propagator-ottrace
 
+### 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/lib/opentelemetry/propagator/ottrace.rb

@@ -6,6 +6,7 @@
 
 require 'opentelemetry-api'
 require 'opentelemetry/propagator/ottrace/version'
+require 'opentelemetry/propagator/ottrace/text_map_propagator'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -20,27 +21,15 @@ module OpenTelemetry
     module OTTrace
       extend self
 
-      TRACE_ID_HEADER = 'ot-tracer-traceid'
-      SPAN_ID_HEADER = 'ot-tracer-spanid'
-      SAMPLED_HEADER = 'ot-tracer-sampled'
-      BAGGAGE_HEADER_PREFIX = 'ot-baggage-'
+      TEXT_MAP_PROPAGATOR = TextMapPropagator.new
 
-      # https://github.com/open-telemetry/opentelemetry-specification/blob/14d123c121b6caa53bffd011292c42a181c9ca26/specification/context/api-propagators.md#textmap-propagator0
-      VALID_BAGGAGE_HEADER_NAME_CHARS = /^[\^_`a-zA-Z\-0-9!#$%&'*+.|~]+$/.freeze
-      INVALID_BAGGAGE_HEADER_VALUE_CHARS = /[^\t\u0020-\u007E\u0080-\u00FF]/.freeze
+      private_constant :TEXT_MAP_PROPAGATOR
 
-      ## Returns an extractor that extracts context from OTTrace carrier
-      def text_map_extractor
-        TextMapExtractor.new
-      end
-
-      ## Returns an injector that injects context into a carrier
-      def text_map_injector
-        TextMapInjector.new
+      # Returns a text map propagator that propagates context using the
+      # OTTrace format.
+      def text_map_propagator
+        TEXT_MAP_PROPAGATOR
       end
     end
   end
 end
-
-require_relative './ottrace/text_map_injector'
-require_relative './ottrace/text_map_extractor'

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

@@ -15,36 +15,38 @@ module OpenTelemetry
   module Propagator
     # Namespace for OpenTelemetry OTTrace propagation
     module OTTrace
-      # Extracts context from carriers using OTTrace header format
-      class TextMapExtractor
+      # Propagates context using OTTrace header format
+      class TextMapPropagator
         PADDING = '0' * 16
         VALID_TRACE_ID_REGEX = /^[0-9a-f]{32}$/.freeze
         VALID_SPAN_ID_REGEX = /^[0-9a-f]{16}$/.freeze
+        TRACE_ID_64_BIT_WIDTH = 64 / 4
+        TRACE_ID_HEADER = 'ot-tracer-traceid'
+        SPAN_ID_HEADER = 'ot-tracer-spanid'
+        SAMPLED_HEADER = 'ot-tracer-sampled'
+        BAGGAGE_HEADER_PREFIX = 'ot-baggage-'
+        FIELDS = [TRACE_ID_HEADER, SPAN_ID_HEADER, SAMPLED_HEADER].freeze
 
-        # Returns a new TextMapExtractor that extracts OTTrace context using the
-        # specified getter
-        #
-        # @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
+        # https://github.com/open-telemetry/opentelemetry-specification/blob/14d123c121b6caa53bffd011292c42a181c9ca26/specification/context/api-propagators.md#textmap-propagator0
+        VALID_BAGGAGE_HEADER_NAME_CHARS = /^[\^_`a-zA-Z\-0-9!#$%&'*+.|~]+$/.freeze
+        INVALID_BAGGAGE_HEADER_VALUE_CHARS = /[^\t\u0020-\u007E\u0080-\u00FF]/.freeze
+
+        private_constant :PADDING, :VALID_TRACE_ID_REGEX, :VALID_SPAN_ID_REGEX, :TRACE_ID_64_BIT_WIDTH, :TRACE_ID_HEADER,
+                         :SPAN_ID_HEADER, :SAMPLED_HEADER, :BAGGAGE_HEADER_PREFIX, :FIELDS, :VALID_BAGGAGE_HEADER_NAME_CHARS,
+                         :INVALID_BAGGAGE_HEADER_VALUE_CHARS
 
         # Extract OTTrace context from the supplied carrier and set the active span
         # in the given context. The original context will be returned if OTTrace
         # 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 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
+        def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
           trace_id = optionally_pad_trace_id(getter.get(carrier, TRACE_ID_HEADER))
           span_id = getter.get(carrier, SPAN_ID_HEADER)
           sampled = getter.get(carrier, SAMPLED_HEADER)
@@ -62,9 +64,30 @@ module OpenTelemetry
           Trace.context_with_span(span, parent_context: set_baggage(carrier: carrier, context: context, getter: getter))
         end
 
-        private
+        # @param [Object] carrier to update with context.
+        # @param [optional 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.
+        def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter)
+          span_context = Trace.current_span(context).context
+          return unless span_context.valid?
+
+          inject_span_context(span_context: span_context, carrier: carrier, setter: setter)
+          inject_baggage(context: context, carrier: carrier, setter: setter)
 
-        attr_reader :default_getter
+          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
+
+        private
 
         def valid?(trace_id:, span_id:)
           !(VALID_TRACE_ID_REGEX !~ trace_id || VALID_SPAN_ID_REGEX !~ span_id)
@@ -80,7 +103,7 @@ module OpenTelemetry
 
         def set_baggage(carrier:, context:, getter:)
           baggage.build(context: context) do |builder|
-            prefix = OTTrace::BAGGAGE_HEADER_PREFIX
+            prefix = BAGGAGE_HEADER_PREFIX
             getter.keys(carrier).each do |carrier_key|
               baggage_key = carrier_key.start_with?(prefix) && carrier_key[prefix.length..-1]
               next unless baggage_key
@@ -97,6 +120,22 @@ module OpenTelemetry
         def baggage
           OpenTelemetry.baggage
         end
+
+        def inject_span_context(span_context:, carrier:, setter:)
+          setter.set(carrier, TRACE_ID_HEADER, span_context.hex_trace_id[TRACE_ID_64_BIT_WIDTH, TRACE_ID_64_BIT_WIDTH])
+          setter.set(carrier, SPAN_ID_HEADER, span_context.hex_span_id)
+          setter.set(carrier, SAMPLED_HEADER, span_context.trace_flags.sampled?.to_s)
+        end
+
+        def inject_baggage(context:, carrier:, setter:)
+          baggage.values(context: context)
+                 .select { |key, value| valid_baggage_entry?(key, value) }
+                 .each { |key, value| setter.set(carrier, "#{BAGGAGE_HEADER_PREFIX}#{key}", value) }
+        end
+
+        def valid_baggage_entry?(key, value)
+          VALID_BAGGAGE_HEADER_NAME_CHARS =~ key && INVALID_BAGGAGE_HEADER_VALUE_CHARS !~ value
+        end
       end
     end
   end

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

@@ -15,7 +15,7 @@ module OpenTelemetry
   module Propagator
     # Namespace for OpenTelemetry OTTrace propagation
     module OTTrace
-      VERSION = '0.16.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-ottrace
 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
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :development
   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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -149,17 +149,16 @@ files:
 - README.md
 - lib/opentelemetry-propagator-ottrace.rb
 - lib/opentelemetry/propagator/ottrace.rb
-- lib/opentelemetry/propagator/ottrace/text_map_extractor.rb
-- lib/opentelemetry/propagator/ottrace/text_map_injector.rb
+- lib/opentelemetry/propagator/ottrace/text_map_propagator.rb
 - lib/opentelemetry/propagator/ottrace/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-ottrace/v0.16.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.17.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/propagator/ottrace
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.16.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/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: OTTrace Context Propagation Extension for the OpenTelemetry framework

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

@@ -1,74 +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 OTTrace propagation
-    module OTTrace
-      # Injects context into carriers using the OTTrace format
-      class TextMapInjector
-        TRACE_ID_64_BIT_WIDTH = 64 / 4
-
-        # Returns a new TextMapInjector that injects context using the specified setter
-        #
-        # @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
-
-        # @param [Object] carrier to update with context.
-        # @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.
-        def inject(carrier, context, setter = nil)
-          setter ||= default_setter
-          span_context = Trace.current_span(context).context
-          return unless span_context.valid?
-
-          inject_span_context(span_context: span_context, carrier: carrier, setter: setter)
-          inject_baggage(context: context, carrier: carrier, setter: setter)
-
-          nil
-        end
-
-        private
-
-        attr_reader :default_setter
-
-        def inject_span_context(span_context:, carrier:, setter:)
-          setter.set(carrier, TRACE_ID_HEADER, span_context.hex_trace_id[TRACE_ID_64_BIT_WIDTH, TRACE_ID_64_BIT_WIDTH])
-          setter.set(carrier, SPAN_ID_HEADER, span_context.hex_span_id)
-          setter.set(carrier, SAMPLED_HEADER, span_context.trace_flags.sampled?.to_s)
-        end
-
-        def inject_baggage(context:, carrier:, setter:)
-          baggage.values(context: context)
-                 .select { |key, value| valid_baggage_entry?(key, value) }
-                 .each { |key, value| setter.set(carrier, "#{BAGGAGE_HEADER_PREFIX}#{key}", value) }
-        end
-
-        def valid_baggage_entry?(key, value)
-          VALID_BAGGAGE_HEADER_NAME_CHARS =~ key && INVALID_BAGGAGE_HEADER_VALUE_CHARS !~ value
-        end
-
-        def baggage
-          OpenTelemetry.baggage
-        end
-      end
-    end
-  end
-end