opentelemetry-api 0.3.0 → 0.7.0

data/lib/opentelemetry/trace/tracer.rb

@@ -8,33 +8,26 @@ module OpenTelemetry
   module Trace
     # No-op implementation of Tracer.
     class Tracer
-      EXTRACTED_SPAN_CONTEXT_KEY = Propagation::ContextKeys.extracted_span_context_key
       CURRENT_SPAN_KEY = Propagation::ContextKeys.current_span_key
 
-      private_constant :EXTRACTED_SPAN_CONTEXT_KEY, :CURRENT_SPAN_KEY
+      private_constant :CURRENT_SPAN_KEY
 
       # Returns the current span from the current or provided context
       #
       # @param [optional Context] context The context to lookup the current
       #   {Span} from. Defaults to Context.current
-      def current_span(context = Context.current)
+      def current_span(context = nil)
+        context ||= Context.current
         context.value(CURRENT_SPAN_KEY) || Span::INVALID
       end
 
-      # Returns the the active span context from the given {Context}, or current
-      # if one is not explicitly passed in. The active span context may refer to
-      # a {SpanContext} that has been extracted. If both a current {Span} and an
-      # extracted, {SpanContext} exist, the context of the current {Span} will be
-      # returned.
-      #
-      # @param [optional Context] context The context to lookup the active
-      #   {SpanContext} from.
+      # Returns a context containing the span, derived from the optional parent
+      # context, or the current context if one was not provided.
       #
-      def active_span_context(context = nil)
-        context ||= Context.current
-        context.value(CURRENT_SPAN_KEY)&.context ||
-          context.value(EXTRACTED_SPAN_CONTEXT_KEY) ||
-          SpanContext::INVALID
+      # @param [optional Context] context The context to use as the parent for
+      #  the returned context
+      def context_with_span(span, parent_context: Context.current)
+        parent_context.set_value(CURRENT_SPAN_KEY, span)
       end
 
       # This is a helper for the default use-case of extending the current trace with a span.
@@ -52,16 +45,17 @@ module OpenTelemetry
       # span and reraised.
       # @yield [span, context] yields the newly created span and a context containing the
       #   span to the block.
-      def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, with_parent: nil, with_parent_context: nil)
-        span = start_span(name, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind, with_parent: with_parent, with_parent_context: with_parent_context)
+      def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, with_parent: nil)
+        span = nil
+        span = start_span(name, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind, with_parent: with_parent)
         with_span(span) { |s, c| yield s, c }
       rescue Exception => e # rubocop:disable Lint/RescueException
-        span.record_error(e)
-        span.status = Status.new(Status::UNKNOWN_ERROR,
-                                 description: "Unhandled exception of type: #{e.class}")
+        span&.record_exception(e)
+        span&.status = Status.new(Status::ERROR,
+                                  description: "Unhandled exception of type: #{e.class}")
         raise e
       ensure
-        span.finish
+        span&.finish
       end
 
       # Activates/deactivates the Span within the current Context, which makes the "current span"
@@ -84,14 +78,12 @@ module OpenTelemetry
       #
       # Parent context can be either passed explicitly, or inferred from currently activated span.
       #
-      # @param [optional Span] with_parent Explicitly managed parent Span, overrides
-      #   +with_parent_context+.
-      # @param [optional Context] with_parent_context Explicitly managed. Overridden by
-      #   +with_parent+.
+      # @param [optional Context] with_parent Explicitly managed parent context
       #
       # @return [Span]
-      def start_span(name, with_parent: nil, with_parent_context: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
-        span_context = with_parent&.context || active_span_context(with_parent_context)
+      def start_span(name, with_parent: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
+        span_context = current_span(with_parent).context
+
         if span_context.valid?
           Span.new(span_context: span_context)
         else

data/lib/opentelemetry/trace/util/http_to_status.rb

@@ -9,36 +9,17 @@ module OpenTelemetry
     module Util
       # Convenience methods, not necessarily required by the API specification.
       module HttpToStatus
-        # Implemented according to
-        # https://github.com/open-telemetry/opentelemetry-specification/issues/306
-        # https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-http.md#status
+        # Maps numeric HTTP status codes to Trace::Status. This module is a mixin for Trace::Status
+        # and is not intended for standalone use.
         #
         # @param code Numeric HTTP status
         # @return Status
-        def http_to_status(code) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        def http_to_status(code)
           case code.to_i
           when 100..399
             new(const_get(:OK))
-          when 401
-            new(const_get(:UNAUTHENTICATED))
-          when 403
-            new(const_get(:PERMISSION_DENIED))
-          when 404
-            new(const_get(:NOT_FOUND))
-          when 429
-            new(const_get(:RESOURCE_EXHAUSTED))
-          when 400..499
-            new(const_get(:INVALID_ARGUMENT))
-          when 501
-            new(const_get(:UNIMPLEMENTED))
-          when 503
-            new(const_get(:UNAVAILABLE))
-          when 504
-            new(const_get(:DEADLINE_EXCEEDED))
-          when 500..599
-            new(const_get(:INTERNAL_ERROR))
           else
-            new(const_get(:UNKNOWN_ERROR))
+            new(const_get(:ERROR))
           end
         end
       end

data/lib/opentelemetry/version.rb

@@ -6,5 +6,5 @@
 
 module OpenTelemetry
   ## Current OpenTelemetry version
-  VERSION = '0.3.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ipsa
@@ -146,9 +146,16 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE
-- OVERVIEW.md
+- README.md
 - lib/opentelemetry-api.rb
 - lib/opentelemetry.rb
+- lib/opentelemetry/baggage.rb
+- lib/opentelemetry/baggage/builder.rb
+- lib/opentelemetry/baggage/manager.rb
+- lib/opentelemetry/baggage/propagation.rb
+- lib/opentelemetry/baggage/propagation/context_keys.rb
+- lib/opentelemetry/baggage/propagation/text_map_extractor.rb
+- lib/opentelemetry/baggage/propagation/text_map_injector.rb
 - lib/opentelemetry/context.rb
 - lib/opentelemetry/context/key.rb
 - lib/opentelemetry/context/propagation.rb
@@ -159,31 +166,22 @@ files:
 - lib/opentelemetry/context/propagation/noop_injector.rb
 - lib/opentelemetry/context/propagation/propagation.rb
 - lib/opentelemetry/context/propagation/propagator.rb
-- lib/opentelemetry/correlation_context.rb
-- lib/opentelemetry/correlation_context/builder.rb
-- lib/opentelemetry/correlation_context/manager.rb
-- lib/opentelemetry/correlation_context/propagation.rb
-- lib/opentelemetry/correlation_context/propagation/context_keys.rb
-- lib/opentelemetry/correlation_context/propagation/text_extractor.rb
-- lib/opentelemetry/correlation_context/propagation/text_injector.rb
 - lib/opentelemetry/error.rb
 - lib/opentelemetry/instrumentation.rb
-- lib/opentelemetry/instrumentation/adapter.rb
+- lib/opentelemetry/instrumentation/base.rb
 - lib/opentelemetry/instrumentation/registry.rb
-- lib/opentelemetry/internal.rb
 - lib/opentelemetry/metrics.rb
 - lib/opentelemetry/metrics/handles.rb
 - lib/opentelemetry/metrics/instruments.rb
 - lib/opentelemetry/metrics/meter.rb
 - lib/opentelemetry/metrics/meter_provider.rb
 - lib/opentelemetry/trace.rb
-- lib/opentelemetry/trace/event.rb
 - lib/opentelemetry/trace/link.rb
 - lib/opentelemetry/trace/propagation.rb
 - lib/opentelemetry/trace/propagation/context_keys.rb
 - lib/opentelemetry/trace/propagation/trace_context.rb
-- lib/opentelemetry/trace/propagation/trace_context/text_extractor.rb
-- lib/opentelemetry/trace/propagation/trace_context/text_injector.rb
+- lib/opentelemetry/trace/propagation/trace_context/text_map_extractor.rb
+- lib/opentelemetry/trace/propagation/trace_context/text_map_injector.rb
 - lib/opentelemetry/trace/propagation/trace_context/trace_parent.rb
 - lib/opentelemetry/trace/span.rb
 - lib/opentelemetry/trace/span_context.rb
@@ -206,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework

data/lib/opentelemetry/correlation_context.rb

@@ -1,16 +0,0 @@
-# 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/propagation.rb

@@ -1,57 +0,0 @@
-# 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_CORRELATION_CONTEXT'
-      )
-      RACK_INJECTOR = TextInjector.new(
-        correlation_context_key: 'HTTP_CORRELATION_CONTEXT'
-      )
-
-      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

data/lib/opentelemetry/correlation_context/propagation/context_keys.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module CorrelationContext
-    module Propagation
-      # The ContextKeys module contains the keys used to index correlations
-      # in a {Context} instance
-      module ContextKeys
-        extend self
-
-        CORRELATION_CONTEXT_KEY = Context.create_key('correlation-context')
-        private_constant :CORRELATION_CONTEXT_KEY
-
-        # Returns the context key that correlations are indexed by
-        #
-        # @return [Context::Key]
-        def correlation_context_key
-          CORRELATION_CONTEXT_KEY
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/correlation_context/propagation/text_injector.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require 'cgi'
-
-module OpenTelemetry
-  module CorrelationContext
-    module Propagation
-      # Injects correlation context using the W3C Correlation Context format
-      class TextInjector
-        include Context::Propagation::DefaultSetter
-
-        # Returns a new TextInjector that injects context using the specified
-        # header key
-        #
-        # @param [String] correlation_context_header_key The correlation context header
-        #   key used in the carrier
-        # @return [TextInjector]
-        def initialize(correlation_context_key: 'Correlation-Context')
-          @correlation_context_key = correlation_context_key
-        end
-
-        # Inject in-process correlations into the supplied carrier.
-        #
-        # @param [Carrier] carrier The carrier to inject correlations into
-        # @param [Context] context The context to read correlations 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, inject will yield the carrier
-        #   and the header key to the getter.
-        # @return [Object] carrier with injected correlations
-        def inject(carrier, context, &setter)
-          return carrier unless (correlations = context[ContextKeys.correlation_context_key]) && !correlations.empty?
-
-          setter ||= default_setter
-          setter.call(carrier, @correlation_context_key, encode(correlations))
-
-          carrier
-        end
-
-        private
-
-        def encode(correlations)
-          correlations.inject(+'') do |memo, (k, v)|
-            memo << CGI.escape(k.to_s) << '=' << CGI.escape(v.to_s) << ','
-          end.chop!
-        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,46 +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 => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
-      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 => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
-      #   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