opentelemetry-api 0.10.0 → 0.14.0

data/lib/opentelemetry/context/propagation/noop_injector.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/context/propagation/propagator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -28,13 +28,13 @@ module OpenTelemetry
         #   context into
         # @param [optional Context] context Context to be injected into carrier. Defaults
         #   to +Context.current+
-        # @param [optional Callable] setter An optional callable that takes a carrier, 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 []=.
+        # @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] carrier
-        def inject(carrier, context = Context.current, &setter)
-          @injector.inject(carrier, context, &setter)
+        def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter)
+          @injector.inject(carrier, context, setter)
         rescue => e # rubocop:disable Style/RescueStandardError
           OpenTelemetry.logger.warn "Error in Propagator#inject #{e.message}"
           carrier
@@ -46,14 +46,14 @@ module OpenTelemetry
         # @param [Object] carrier The carrier to extract context from
         # @param [optional Context] context Context to be updated with the state
         #   extracted from the carrier. Defaults to +Context.current+
-        # @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 []=.
+        # @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] a new context updated with state extracted from the
         #   carrier
-        def extract(carrier, context = Context.current, &getter)
-          @extractor.extract(carrier, context, &getter)
+        def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
+          @extractor.extract(carrier, context, getter)
         rescue => e # rubocop:disable Style/RescueStandardError
           OpenTelemetry.logger.warn "Error in Propagator#extract #{e.message}"
           context

data/lib/opentelemetry/context/propagation/rack_env_getter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # The RackEnvGetter class provides a common methods for reading
+      # keys from a rack environment. It abstracts away the rack-normalization
+      # process so that keys can be looked up without having to transform them
+      # first. With this class you can get +traceparent+ instead of
+      # +HTTP_TRACEPARENT+
+      class RackEnvGetter
+        # Converts key into a rack-normalized key and reads it from the carrier.
+        # Useful for extract operations.
+        def get(carrier, key)
+          carrier[to_rack_key(key)]
+        end
+
+        # Reads all keys from a carrier and converts them from the rack-normalized
+        # form to the original. The resulting keys will be lowercase and
+        # underscores will be replaced with dashes.
+        def keys(carrier)
+          carrier.keys.map(&method(:from_rack_key))
+        end
+
+        private
+
+        def to_rack_key(key)
+          ret = 'HTTP_' + key
+          ret.tr!('-', '_')
+          ret.upcase!
+        end
+
+        def from_rack_key(key)
+          start = key.start_with?('HTTP_') ? 5 : 0
+          ret = key[start..-1]
+          ret.tr!('_', '-')
+          ret.downcase!
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/context/propagation/text_map_getter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # The default getter module provides a common methods for reading
+      # key from a carrier that implements +[]+ and a +keys+ method
+      class TextMapGetter
+        # Reads a key from a carrier that implements +[]+. Useful for extract
+        # operations.
+        def get(carrier, key)
+          carrier[key]
+        end
+
+        # Reads all keys from a carrier. Useful for iterating over a carrier's
+        # keys.
+        def keys(carrier)
+          carrier.keys
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/context/propagation/text_map_setter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # The default setter module provides a common method for writing
+      # a key into a carrier that implements +[]=+
+      class TextMapSetter
+        # Writes key into a carrier that implements +[]=+. Useful for inject
+        # operations.
+        def set(carrier, key, value)
+          carrier[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry

data/lib/opentelemetry/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/registry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -79,8 +79,7 @@ module OpenTelemetry
           OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} failed to install"
         end
       rescue => e # rubocop:disable Style/RescueStandardError
-        OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} unhandled exception" \
-                                  "during install #{e}: #{e.backtrace}"
+        OpenTelemetry.handle_error(exception: e, message: "Instrumentation: #{instrumentation.name} unhandled exception during install: #{e.backtrace}")
       end
     end
   end

data/lib/opentelemetry/metrics.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/handles.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/instruments.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/meter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/meter_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -13,7 +13,17 @@ module OpenTelemetry
 
     CURRENT_SPAN_KEY = Context.create_key('current-span')
 
-    private_constant :CURRENT_SPAN_KEY
+    # Random number generator for generating IDs. This is an object that can
+    # respond to `#bytes` and uses the system PRNG. The current logic is
+    # compatible with Ruby 2.5 (which does not implement the `Random.bytes`
+    # class method) and with Ruby 3.0+ (which deprecates `Random::DEFAULT`).
+    # When we drop support for Ruby 2.5, this can simply be replaced with
+    # the class `Random`.
+    #
+    # @return [#bytes]
+    RANDOM = Random.respond_to?(:bytes) ? Random : Random::DEFAULT
+
+    private_constant :CURRENT_SPAN_KEY, :RANDOM
 
     # An invalid trace identifier, a 16-byte string with all zero bytes.
     INVALID_TRACE_ID = ("\0" * 16).b
@@ -27,7 +37,7 @@ module OpenTelemetry
     # @return [String] a valid trace ID.
     def generate_trace_id
       loop do
-        id = Random::DEFAULT.bytes(16)
+        id = RANDOM.bytes(16)
         return id unless id == INVALID_TRACE_ID
       end
     end
@@ -38,7 +48,7 @@ module OpenTelemetry
     # @return [String] a valid span ID.
     def generate_span_id
       loop do
-        id = Random::DEFAULT.bytes(8)
+        id = RANDOM.bytes(8)
         return id unless id == INVALID_SPAN_ID
       end
     end
@@ -76,6 +86,7 @@ end
 
 require 'opentelemetry/trace/link'
 require 'opentelemetry/trace/trace_flags'
+require 'opentelemetry/trace/tracestate'
 require 'opentelemetry/trace/span_context'
 require 'opentelemetry/trace/span_kind'
 require 'opentelemetry/trace/span'

data/lib/opentelemetry/trace/link.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace/propagation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace/propagation/trace_context.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -15,20 +15,13 @@ module OpenTelemetry
       # for context propagation in the W3C Trace Context format.
       module TraceContext
         extend self
-
+        TRACEPARENT_KEY = 'traceparent'
+        TRACESTATE_KEY = 'tracestate'
         TEXT_MAP_EXTRACTOR = TextMapExtractor.new
         TEXT_MAP_INJECTOR = TextMapInjector.new
-        RACK_EXTRACTOR = TextMapExtractor.new(
-          traceparent_key: 'HTTP_TRACEPARENT',
-          tracestate_key: 'HTTP_TRACESTATE'
-        )
-        RACK_INJECTOR = TextMapInjector.new(
-          traceparent_key: 'HTTP_TRACEPARENT',
-          tracestate_key: 'HTTP_TRACESTATE'
-        )
 
-        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR,
-                         :RACK_INJECTOR, :RACK_EXTRACTOR
+        private_constant :TRACEPARENT_KEY, :TRACESTATE_KEY,
+                         :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR
 
         # Returns an extractor that extracts context using the W3C Trace Context
         # format
@@ -41,18 +34,6 @@ module OpenTelemetry
         def text_map_injector
           TEXT_MAP_INJECTOR
         end
-
-        # Returns an extractor that extracts context using the W3C Trace Context
-        # with Rack normalized keys (upcased and prefixed with HTTP_)
-        def rack_extractor
-          RACK_EXTRACTOR
-        end
-
-        # Returns an injector that injects context using the W3C Trace Context
-        # format with Rack normalized keys (upcased and prefixed with HTTP_)
-        def rack_injector
-          RACK_INJECTOR
-        end
       end
     end
   end

data/lib/opentelemetry/trace/propagation/trace_context/text_map_extractor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry
@@ -9,18 +9,15 @@ module OpenTelemetry
       module TraceContext
         # Extracts context from carriers in the W3C Trace Context format
         class TextMapExtractor
-          include Context::Propagation::DefaultGetter
-
           # Returns a new TextMapExtractor that extracts context using the
-          # specified header keys
+          # specified getter
           #
-          # @param [String] traceparent_key The traceparent header key used in the carrier
-          # @param [String] tracestate_key The tracestate 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 +TextMapGetter+
+          #   instance.
           # @return [TextMapExtractor]
-          def initialize(traceparent_key: 'traceparent',
-                         tracestate_key: 'tracestate')
-            @traceparent_key = traceparent_key
-            @tracestate_key = tracestate_key
+          def initialize(default_getter = Context::Propagation.text_map_getter)
+            @default_getter = default_getter
           end
 
           # Extract a remote {Trace::SpanContext} from the supplied carrier.
@@ -28,19 +25,15 @@ 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 span context from the header, or the original
           #   context if parsing fails.
-          def extract(carrier, context, &getter)
-            getter ||= default_getter
-            header = getter.call(carrier, @traceparent_key)
-            tp = TraceParent.from_string(header)
-
-            tracestate = getter.call(carrier, @tracestate_key)
+          def extract(carrier, context, getter = nil)
+            getter ||= @default_getter
+            tp = TraceParent.from_string(getter.get(carrier, TRACEPARENT_KEY))
+            tracestate = Tracestate.from_string(getter.get(carrier, TRACESTATE_KEY))
 
             span_context = Trace::SpanContext.new(trace_id: tp.trace_id,
                                                   span_id: tp.span_id,

data/lib/opentelemetry/trace/propagation/trace_context/text_map_injector.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry
@@ -9,35 +9,30 @@ module OpenTelemetry
       module TraceContext
         # Injects context into carriers using the W3C Trace Context format
         class TextMapInjector
-          include Context::Propagation::DefaultSetter
-
           # Returns a new TextMapInjector that injects context using the
-          # specified header keys
+          # specified setter
           #
-          # @param [String] traceparent_key The traceparent header key used in the carrier
-          # @param [String] tracestate_key The tracestate 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
+          #   {TextMapSetter} instance.
           # @return [TextMapInjector]
-          def initialize(traceparent_key: 'traceparent',
-                         tracestate_key: 'tracestate')
-            @traceparent_key = traceparent_key
-            @tracestate_key = tracestate_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)
             return carrier unless (span_context = span_context_from(context))
 
-            setter ||= DEFAULT_SETTER
-            setter.call(carrier, @traceparent_key, TraceParent.from_span_context(span_context).to_s)
-            setter.call(carrier, @tracestate_key, span_context.tracestate) unless span_context.tracestate.nil?
+            setter ||= @default_setter
+            setter.set(carrier, TRACEPARENT_KEY, TraceParent.from_span_context(span_context).to_s)
+            setter.set(carrier, TRACESTATE_KEY, span_context.tracestate.to_s) unless span_context.tracestate.empty?
 
             carrier
           end