opentelemetry-api 0.2.0 → 0.6.0

data/lib/opentelemetry/distributed_context/entry.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module DistributedContext
-    # An Entry consists of Entry::Metadata, Entry::Key, and Entry::Value.
-    class Entry
-      attr_reader :metadata, :key, :value
-
-      # Entry::Key is the name of the Entry. Entry::Key along with Entry::Value can be used to aggregate and group stats,
-      # annotate traces and logs, etc.
-      #
-      # Restrictions
-      # - Must contain only printable ASCII (codes between 32 and 126 inclusive)
-      # - Must have length greater than zero and less than 256.
-      # - Must not be empty.
-      class Key
-        attr_reader :name
-
-        def initialize(name)
-          raise ArgumentError unless Internal.printable_ascii?(name) && (1..255).include?(name.length)
-
-          @name = -name
-        end
-      end
-
-      # Entry::Value wraps a string. It MUST contain only printable ASCII (codes between 32 and 126).
-      class Value
-        def initialize(value)
-          raise ArgumentError unless Internal.printable_ascii?(value)
-
-          @value = -value
-        end
-
-        def to_s
-          @value
-        end
-      end
-
-      # Entry::Metadata contains properties associated with an Entry. For now only the property entry_ttl is defined.
-      # In future, additional properties may be added to address specific situations.
-      #
-      # The creator of entries determines metadata of an entry it creates.
-      class Metadata
-        attr_reader :entry_ttl
-
-        # An @see Entry with NO_PROPAGATION is considered to have local scope and is used within the process
-        # where it is created.
-        NO_PROPAGATION = 0
-
-        # An @see Entry with UNLIMITED_PROPAGATION can propagate unlimited hops. However, it is still subject
-        # to outgoing and incoming (on remote side) filter criteria.
-        UNLIMITED_PROPAGATION = -1
-
-        def initialize(entry_ttl)
-          raise ArgumentError unless entry_ttl.is_a?(Integer)
-
-          @entry_ttl = entry_ttl
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/distributed_context/propagation.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require 'opentelemetry/distributed_context/propagation/binary_format'
-require 'opentelemetry/distributed_context/propagation/trace_parent'
-require 'opentelemetry/distributed_context/propagation/text_format'
-
-module OpenTelemetry
-  module DistributedContext
-    # Propagation API consists of two main formats:
-    # - @see BinaryFormat is used to serialize and deserialize a value into a binary representation.
-    # - @see TextFormat is used to inject and extract a value as text into carriers that travel in-band across process boundaries.
-    module Propagation
-    end
-  end
-end

data/lib/opentelemetry/distributed_context/propagation/binary_format.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module DistributedContext
-    module Propagation
-      # Formatter for serializing and deserializing a SpanContext into a binary format.
-      class BinaryFormat
-        EMPTY_BYTE_ARRAY = [].freeze
-
-        private_constant(:EMPTY_BYTE_ARRAY)
-
-        def to_bytes(span_context)
-          EMPTY_BYTE_ARRAY
-        end
-
-        def from_bytes(bytes)
-          Trace::SpanContext.invalid
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/distributed_context/propagation/text_format.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-module OpenTelemetry
-  module DistributedContext
-    module Propagation
-      # TextFormat is a formatter that injects and extracts a value as text into carriers that travel in-band across
-      # process boundaries.
-      # Encoding is expected to conform to the HTTP Header Field semantics. Values are often encoded as RPC/HTTP request
-      # headers.
-      #
-      # The carrier of propagated data on both the client (injector) and server (extractor) side is usually an http request.
-      # Propagation is usually implemented via library-specific request interceptors, where the client-side injects values
-      # and the server-side extracts them.
-      class TextFormat
-        DEFAULT_GETTER = ->(carrier, key) { carrier[key] }
-        DEFAULT_SETTER = ->(carrier, key, value) { carrier[key] = value }
-        private_constant(:DEFAULT_GETTER, :DEFAULT_SETTER)
-
-        # Returns an array with the trace context header keys used by this formatter
-        attr_reader :fields
-
-        # Returns a new TextFormat that injects and extracts using the specified trace context
-        # header keys
-        #
-        # @param [String] traceparent_header_key The traceparent header key used in the carrier
-        # @param [String] tracestate_header_key The tracestate header key used in the carrier
-        # @return [TextFormatter]
-        def initialize(traceparent_header_key:, tracestate_header_key:)
-          @traceparent_header_key = traceparent_header_key
-          @tracestate_header_key = tracestate_header_key
-          @fields = [traceparent_header_key, tracestate_header_key].freeze
-        end
-
-        # Return a remote {Trace::SpanContext} extracted from the supplied carrier. Expects the
-        # the supplied carrier to have keys in rack normalized format (HTTP_#{UPPERCASE_KEY}).
-        # Invalid headers will result in a new, valid, non-remote {Trace::SpanContext}.
-        #
-        # @param [Carrier] carrier The carrier to get the header from.
-        # @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.
-        # @return [SpanContext] the span context from the header, or a new one if parsing fails.
-        def extract(carrier, &getter)
-          getter ||= DEFAULT_GETTER
-          header = getter.call(carrier, @traceparent_header_key)
-          tp = TraceParent.from_string(header)
-
-          tracestate = getter.call(carrier, @tracestate_header_key)
-
-          Trace::SpanContext.new(trace_id: tp.trace_id, span_id: tp.span_id, trace_flags: tp.flags, tracestate: tracestate, remote: true)
-        rescue OpenTelemetry::Error
-          Trace::SpanContext.new
-        end
-
-        # Set the span context on the supplied carrier.
-        #
-        # @param [SpanContext] context The active {Trace::SpanContext}.
-        # @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.
-        def inject(context, carrier, &setter)
-          setter ||= DEFAULT_SETTER
-          setter.call(carrier, @traceparent_header_key, TraceParent.from_context(context).to_s)
-          setter.call(carrier, @tracestate_header_key, context.tracestate) unless context.tracestate.nil?
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/distributed_context/propagation/trace_parent.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-module OpenTelemetry
-  module DistributedContext
-    module Propagation
-      # A TraceParent is an implementation of the W3C trace context specification
-      # https://www.w3.org/TR/trace-context/
-      # {Trace::SpanContext}
-      class TraceParent
-        InvalidFormatError = Class.new(Error)
-        InvalidVersionError = Class.new(Error)
-        InvalidTraceIDError = Class.new(Error)
-        InvalidSpanIDError = Class.new(Error)
-
-        TRACE_PARENT_HEADER = 'traceparent'
-        SUPPORTED_VERSION = 0
-        private_constant :SUPPORTED_VERSION
-        MAX_VERSION = 254
-        private_constant :MAX_VERSION
-
-        REGEXP = /^(?<version>[A-Fa-f0-9]{2})-(?<trace_id>[A-Fa-f0-9]{32})-(?<span_id>[A-Fa-f0-9]{16})-(?<flags>[A-Fa-f0-9]{2})(?<ignored>-.*)?$/.freeze
-        private_constant :REGEXP
-
-        class << self
-          # Creates a new {TraceParent} from a supplied {Trace::SpanContext}
-          # @param [SpanContext] ctx The context
-          # @return [TraceParent] a trace parent
-          def from_context(ctx)
-            new(trace_id: ctx.trace_id, span_id: ctx.span_id, flags: ctx.trace_flags)
-          end
-
-          # Deserializes the {TraceParent} from the string representation
-          # @param [String] string The serialized trace parent
-          # @return [TraceParent] a trace_parent
-          # @raise [InvalidFormatError] on an invalid format
-          # @raise [InvalidVerionError] on an invalid version
-          # @raise [InvalidTraceIDError] on an invalid trace_id
-          # @raise [InvalidSpanIDError] on an invalid span_id
-          def from_string(string)
-            matches = match_input(string)
-
-            version = parse_version(matches[:version])
-            raise InvalidFormatError if version > SUPPORTED_VERSION && string.length < 55
-
-            trace_id = parse_trace_id(matches[:trace_id])
-            span_id = parse_span_id(matches[:span_id])
-            flags = parse_flags(matches[:flags])
-
-            new(trace_id: trace_id, span_id: span_id, flags: flags)
-          end
-
-          private
-
-          def match_input(string)
-            matches = REGEXP.match(string)
-            raise InvalidFormatError, 'regexp match failed' if !matches || matches.length < 6
-
-            matches
-          end
-
-          def parse_version(string)
-            v = string.to_i(16)
-            raise InvalidFormatError, string unless v
-            raise InvalidVersionError, v if v > MAX_VERSION
-
-            v
-          end
-
-          def parse_trace_id(string)
-            raise InvalidTraceIDError, string if string == OpenTelemetry::Trace::INVALID_TRACE_ID
-
-            string.downcase!
-            string
-          end
-
-          def parse_span_id(string)
-            raise InvalidSpanIDError, string if string == OpenTelemetry::Trace::INVALID_SPAN_ID
-
-            string.downcase!
-            string
-          end
-
-          def parse_flags(string)
-            OpenTelemetry::Trace::TraceFlags.from_byte(string.to_i(16))
-          end
-        end
-
-        attr_reader :version, :trace_id, :span_id, :flags
-
-        private_class_method :new
-
-        # Returns the sampling choice from the trace_flags
-        # @return [Boolean] the sampling choice
-        def sampled?
-          flags.sampled?
-        end
-
-        # converts this object into a string according to the w3c spec
-        # @return [String] the serialized trace_parent
-        def to_s
-          "00-#{trace_id}-#{span_id}-#{flag_string}"
-        end
-
-        private
-
-        def flag_string
-          # the w3c standard only dictates the one flag for this version
-          # therefore we can only output the one flag.
-          flags.sampled? ? '01' : '00'
-        end
-
-        def initialize(trace_id: nil, span_id: nil, version: SUPPORTED_VERSION, flags: Trace::TraceFlags::DEFAULT)
-          @trace_id = trace_id
-          @span_id = span_id
-          @version = version
-          @flags = flags
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/internal.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  # @api private
-  #
-  # Internal contains helpers used by the no-op API implementation.
-  module Internal
-    extend self
-
-    def printable_ascii?(string)
-      return false unless string.is_a?(String)
-
-      r = 32..126
-      string.each_codepoint { |c| return false unless r.include?(c) }
-      true
-    end
-  end
-end

data/lib/opentelemetry/trace/event.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Trace
-    # A text annotation with a set of attributes and a timestamp.
-    class Event
-      EMPTY_ATTRIBUTES = {}.freeze
-
-      private_constant :EMPTY_ATTRIBUTES
-
-      # Returns the name of this event
-      #
-      # @return [String]
-      attr_reader :name
-
-      # Returns the frozen attributes for this event
-      #
-      # @return [Hash<String, Object>]
-      attr_reader :attributes
-
-      # Returns the timestamp for this event
-      #
-      # @return [Time]
-      attr_reader :timestamp
-
-      # Returns a new immutable {Event}.
-      #
-      # @param [String] name The name of this event
-      # @param [optional Hash<String, Object>] attributes A hash of attributes for this
-      #   event. Attributes will be frozen during Event initialization.
-      # @param [optional Time] timestamp The timestamp for this event.
-      #   Defaults to Time.now.
-      # @return [Event]
-      def initialize(name:, attributes: nil, timestamp: nil)
-        @name = name
-        @attributes = attributes.freeze || EMPTY_ATTRIBUTES
-        @timestamp = timestamp || Time.now
-      end
-    end
-  end
-end

data/lib/opentelemetry/trace/sampling_hint.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Trace
-    # Hints to influence sampling decisions. The default option for span
-    # creation is to not provide any suggestion.
-    module SamplingHint
-      # Suggest to not record events and not sample.
-      NOT_RECORD = :__not_record__
-
-      # Suggest to record events and not sample.
-      RECORD = :__record__
-
-      # Suggest to record events and sample.
-      RECORD_AND_SAMPLED = :__record_and_sampled__
-    end
-  end
-end

data/lib/opentelemetry/trace/tracer_factory.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Trace
-    # No-op implementation of a tracer factory.
-    class TracerFactory
-      HTTP_TEXT_FORMAT = DistributedContext::Propagation::TextFormat.new(
-        traceparent_header_key: 'traceparent',
-        tracestate_header_key: 'tracestate'
-      )
-      RACK_HTTP_TEXT_FORMAT = DistributedContext::Propagation::TextFormat.new(
-        traceparent_header_key: 'HTTP_TRACEPARENT',
-        tracestate_header_key: 'HTTP_TRACESTATE'
-      )
-      BINARY_FORMAT = DistributedContext::Propagation::BinaryFormat.new
-      private_constant(:HTTP_TEXT_FORMAT, :RACK_HTTP_TEXT_FORMAT, :BINARY_FORMAT)
-
-      # Returns a {Tracer} instance.
-      #
-      # @param [optional String] name Instrumentation package name
-      # @param [optional String] version Instrumentation package version
-      #
-      # @return [Tracer]
-      def tracer(name = nil, version = nil)
-        @tracer ||= Tracer.new
-      end
-
-      def binary_format
-        BINARY_FORMAT
-      end
-
-      def http_text_format
-        HTTP_TEXT_FORMAT
-      end
-
-      def rack_http_text_format
-        RACK_HTTP_TEXT_FORMAT
-      end
-    end
-  end
-end