opentelemetry-api 0.2.0 → 0.6.0

data/lib/opentelemetry/context.rb

@@ -4,28 +4,151 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'opentelemetry/context/key'
+require 'opentelemetry/context/propagation'
+
 module OpenTelemetry
-  # The Context module provides per-thread storage.
-  module Context
-    extend self
+  # Manages context on a per-fiber basis
+  class Context
+    KEY = :__opentelemetry_context__
+    EMPTY_ENTRIES = {}.freeze
+
+    class << self
+      # Returns a key used to index a value in a Context
+      #
+      # @param [String] name The key name
+      # @return [Context::Key]
+      def create_key(name)
+        Key.new(name)
+      end
+
+      # Returns current context, which is never nil
+      #
+      # @return [Context]
+      def current
+        Thread.current[KEY] ||= ROOT
+      end
+
+      # Sets the current context
+      #
+      # @param [Context] ctx The context to be made active
+      def current=(ctx)
+        Thread.current[KEY] = ctx
+      end
+
+      # Executes a block with ctx as the current context. It restores
+      # the previous context upon exiting.
+      #
+      # @param [Context] ctx The context to be made active
+      # @yield [context] Yields context to the block
+      def with_current(ctx)
+        prev = ctx.attach
+        yield ctx
+      ensure
+        ctx.detach(prev)
+      end
+
+      # Execute a block in a new context with key set to value. Restores the
+      # previous context after the block executes.
+
+      # @param [String] key The lookup key
+      # @param [Object] value The object stored under key
+      # @param [Callable] Block to execute in a new context
+      # @yield [context, value] Yields the newly created context and value to
+      #   the block
+      def with_value(key, value)
+        ctx = current.set_value(key, value)
+        prev = ctx.attach
+        yield ctx, value
+      ensure
+        ctx.detach(prev)
+      end
+
+      # Execute a block in a new context where its values are merged with the
+      # incoming values. Restores the previous context after the block executes.
+
+      # @param [String] key The lookup key
+      # @param [Hash] values Will be merged with values of the current context
+      #  and returned in a new context
+      # @param [Callable] Block to execute in a new context
+      # @yield [context, values] Yields the newly created context and values
+      #   to the block
+      def with_values(values)
+        ctx = current.set_values(values)
+        prev = ctx.attach
+        yield ctx, values
+      ensure
+        ctx.detach(prev)
+      end
+
+      # Returns the value associated with key in the current context
+      #
+      # @param [String] key The lookup key
+      def value(key)
+        current.value(key)
+      end
+
+      def clear
+        self.current = ROOT
+      end
 
-    def get(key)
-      storage[key]
+      def empty
+        new(nil, EMPTY_ENTRIES)
+      end
     end
 
-    def with(key, value)
-      store = storage
-      previous = store[key]
-      store[key] = value
-      yield value
-    ensure
-      store[key] = previous
+    def initialize(parent, entries)
+      @parent = parent
+      @entries = entries.freeze
     end
 
-    private
+    # Returns the corresponding value (or nil) for key
+    #
+    # @param [Key] key The lookup key
+    # @return [Object]
+    def value(key)
+      @entries[key]
+    end
+
+    alias [] value
+
+    # Returns a new Context where entries contains the newly added key and value
+    #
+    # @param [Key] key The key to store this value under
+    # @param [Object] value Object to be stored under key
+    # @return [Context]
+    def set_value(key, value)
+      new_entries = @entries.dup
+      new_entries[key] = value
+      Context.new(self, new_entries)
+    end
+
+    # Returns a new Context with the current context's entries merged with the
+    #   new entries
+    #
+    # @param [Hash] values The values to be merged with the current context's
+    #   entries.
+    # @param [Object] value Object to be stored under key
+    # @return [Context]
+    def set_values(values) # rubocop:disable Naming/AccessorMethodName:
+      Context.new(self, @entries.merge(values))
+    end
 
-    def storage
-      Thread.current[:__opentelemetry__] ||= {}
+    # @api private
+    def attach
+      prev = self.class.current
+      self.class.current = self
+      prev
     end
+
+    # @api private
+    def detach(ctx_to_attach = nil)
+      OpenTelemetry.logger.warn 'Calls to detach should match corresponding calls to attach' if self.class.current != self
+
+      ctx_to_attach ||= @parent || ROOT
+      ctx_to_attach.attach
+    end
+
+    ROOT = empty.freeze
   end
 end

data/lib/opentelemetry/context/key.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    # The Key class provides mechanisms to index and access values from a
+    # Context
+    class Key
+      attr_reader :name
+
+      # @api private
+      # Use Context.create_key to obtain a Key instance.
+      def initialize(name)
+        @name = name
+      end
+
+      # Returns the value indexed by this Key in the specified context
+      #
+      # @param [optional Context] context The Context to lookup the key from.
+      #   Defaults to +Context.current+.
+      def get(context = Context.current)
+        context[self]
+      end
+    end
+  end
+end

data/lib/opentelemetry/context/propagation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/context/propagation/composite_propagator'
+require 'opentelemetry/context/propagation/default_getter'
+require 'opentelemetry/context/propagation/default_setter'
+require 'opentelemetry/context/propagation/noop_extractor'
+require 'opentelemetry/context/propagation/noop_injector'
+require 'opentelemetry/context/propagation/propagation'
+require 'opentelemetry/context/propagation/propagator'
+
+module OpenTelemetry
+  class Context
+    # The propagation module contains APIs and utilities to interact with context
+    # and propagate across process boundaries.
+    module Propagation
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # A composite propagator composes a list of injectors and extractors into
+      # single interface exposing inject and extract methods. Injection and
+      # extraction will preserve the order of the injectors and extractors
+      # passed in during initialization.
+      class CompositePropagator
+        # Returns a Propagator that extracts using the provided extractors
+        # and injectors.
+        #
+        # @param [Array<#inject>] injectors
+        # @param [Array<#extract>] extractors
+        def initialize(injectors, extractors)
+          @injectors = injectors
+          @extractors = extractors
+        end
+
+        # Runs injectors in order and returns a carrier. If an injection fails
+        # a warning will be logged and remaining injectors will be executed.
+        # Always returns a valid carrier.
+        #
+        # @param [Object] carrier A carrier to inject context into
+        #   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 []=.
+        #
+        # @return [Object] carrier
+        def inject(carrier, context = Context.current, &setter)
+          @injectors.inject(carrier) do |memo, injector|
+            injector.inject(memo, context, &setter)
+          rescue => e # rubocop:disable Style/RescueStandardError
+            OpenTelemetry.logger.warn "Error in CompositePropagator#inject #{e.message}"
+            carrier
+          end
+        end
+
+        # Runs extractors in order and returns a Context updated with the
+        # results of each extraction. If an extraction fails, a warning will be
+        # logged and remaining extractors will continue to be executed. Always
+        # returns a valid context.
+        #
+        # @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 []=.
+        #
+        # @return [Context] a new context updated with state extracted from the
+        #   carrier
+        def extract(carrier, context = Context.current, &getter)
+          @extractors.inject(context) do |ctx, extractor|
+            extractor.extract(carrier, ctx, &getter)
+          rescue => e # rubocop:disable Style/RescueStandardError
+            OpenTelemetry.logger.warn "Error in CompositePropagator#extract #{e.message}"
+            ctx
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # The default getter module provides a common method for reading
+      # a key from a carrier that implements +[]+
+      module DefaultGetter
+        DEFAULT_GETTER = ->(carrier, key) { carrier[key] }
+        private_constant :DEFAULT_GETTER
+
+        # Returns a callable that can read a key from a carrier that implements
+        # +[]+. Useful for extract operations.
+        #
+        # @return [Callable]
+        def default_getter
+          DEFAULT_GETTER
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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 +[]=+
+      module DefaultSetter
+        DEFAULT_SETTER = ->(carrier, key, value) { carrier[key] = value }
+        private_constant :DEFAULT_SETTER
+
+        # Returns a callable that can write a key into a carrier that implements
+        # +[]=+. Useful for inject operations.
+        #
+        # @return [Callable]
+        def default_setter
+          DEFAULT_SETTER
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # A no-op extractor implementation
+      class NoopExtractor
+        # Extract a context from the given carrier
+        #
+        # @param [Object] carrier The carrier to extract the context from
+        # @param [Context] context The context to be upated with the extracted
+        #   context
+        # @param [optional Callable] getter An optional callable that takes a carrier and a key and
+        #   and returns the value associated with the key
+        # @return [Context]
+        def extract(carrier, context, &getter)
+          context
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # A no-op injector implementation
+      class NoopInjector
+        # Inject the given context into the specified carrier
+        #
+        # @param [Object] carrier The carrier to inject the provided context
+        #   into
+        # @param [Context] context The context to be injected
+        # @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
+        # @return [Object] carrier
+        def inject(carrier, context, &setter)
+          carrier
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # The Propagation class provides methods to inject and extract context
+      # to pass across process boundaries
+      class Propagation
+        # Get or set the global http propagator. Use a CompositePropagator
+        # to propagate multiple formats.
+        attr_accessor :http
+
+        # Get or set the global text propagator. Use a CompositePropagator
+        # to propagate multiple formats.
+        attr_accessor :text
+
+        def initialize
+          @http = @text = Propagator.new(NoopInjector.new, NoopExtractor.new)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  class Context
+    module Propagation
+      # A propagator composes an extractor and injector into a single interface
+      # exposing inject and extract methods
+      class Propagator
+        # Returns a Propagator that delegates inject and extract to the provided
+        # injector and extractor
+        #
+        # @param [#inject] injector
+        # @param [#extract] extractor
+        def initialize(injector, extractor)
+          @injector = injector
+          @extractor = extractor
+        end
+
+        # Returns a carrier with the provided context injected according the
+        # underlying injector. Returns the carrier and logs a warning if
+        # injection fails.
+        #
+        # @param [Object] carrier A carrier to inject context into
+        #   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 []=.
+        #
+        # @return [Object] carrier
+        def inject(carrier, context = Context.current, &setter)
+          @injector.inject(carrier, context, &setter)
+        rescue => e # rubocop:disable Style/RescueStandardError
+          OpenTelemetry.logger.warn "Error in Propagator#inject #{e.message}"
+          carrier
+        end
+
+        # Extracts and returns context from a carrier. Returns the provided
+        # context and logs a warning if an error if extraction fails.
+        #
+        # @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 []=.
+        #
+        # @return [Context] a new context updated with state extracted from the
+        #   carrier
+        def extract(carrier, context = Context.current, &getter)
+          @extractor.extract(carrier, context, &getter)
+        rescue => e # rubocop:disable Style/RescueStandardError
+          OpenTelemetry.logger.warn "Error in Propagator#extract #{e.message}"
+          context
+        end
+      end
+    end
+  end
+end