opentelemetry-api 0.5.1

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

data/lib/opentelemetry/correlation_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/correlation_context/builder'
+require 'opentelemetry/correlation_context/manager'
+require 'opentelemetry/correlation_context/propagation'
+
+module OpenTelemetry
+  # The CorrelationContext module provides functionality to record and propagate
+  # correlations in a distributed trace
+  module CorrelationContext
+  end
+end

data/lib/opentelemetry/correlation_context/builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module CorrelationContext
+    # No op implementation of CorrelationContext::Builder
+    class Builder
+      def set_value(key, value); end
+
+      def remove_value(key); end
+
+      def clear; end
+    end
+  end
+end

data/lib/opentelemetry/correlation_context/manager.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module CorrelationContext
+    # No op implementation of CorrelationContext::Manager
+    class Manager
+      NOOP_BUILDER = Builder.new
+      private_constant :NOOP_BUILDER
+
+      def build(context: Context.current)
+        yield NOOP_BUILDER
+        context
+      end
+
+      def set_value(key, value, context: Context.current)
+        context
+      end
+
+      def value(key, context: Context.current)
+        nil
+      end
+
+      def remove_value(key, context: Context.current)
+        context
+      end
+
+      def clear(context: Context.current)
+        context
+      end
+    end
+  end
+end

data/lib/opentelemetry/correlation_context/propagation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/correlation_context/propagation/context_keys'
+require 'opentelemetry/correlation_context/propagation/text_injector'
+require 'opentelemetry/correlation_context/propagation/text_extractor'
+
+module OpenTelemetry
+  module CorrelationContext
+    # The Correlation::Propagation module contains injectors and
+    # extractors for sending and receiving correlation context over the wire
+    module Propagation
+      extend self
+
+      TEXT_EXTRACTOR = TextExtractor.new
+      TEXT_INJECTOR = TextInjector.new
+      RACK_EXTRACTOR = TextExtractor.new(
+        correlation_context_key: 'HTTP_OTCORRELATIONS'
+      )
+      RACK_INJECTOR = TextInjector.new(
+        correlation_context_key: 'HTTP_OTCORRELATIONS'
+      )
+
+      private_constant :TEXT_INJECTOR, :TEXT_EXTRACTOR, :RACK_INJECTOR,
+                       :RACK_EXTRACTOR
+
+      # Returns an extractor that extracts context using the W3C Correlation
+      # Context format
+      def text_injector
+        TEXT_INJECTOR
+      end
+
+      # Returns an injector that injects context using the W3C Correlation
+      # Context format
+      def text_extractor
+        TEXT_EXTRACTOR
+      end
+
+      # Returns an extractor that extracts context using the W3C Correlation
+      # Context format with Rack normalized keys (upcased and prefixed with
+      # HTTP_)
+      def rack_injector
+        RACK_INJECTOR
+      end
+
+      # Returns an injector that injects context using the W3C Correlation
+      # Context format with Rack normalized keys (upcased and prefixed with
+      # HTTP_)
+      def rack_extractor
+        RACK_EXTRACTOR
+      end
+    end
+  end
+end