opentelemetry-api 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aa5a0850640df96314f3fd539394f878d899b47e1a95e725abc6c0afd6b5a68
-  data.tar.gz: c64e3676eb965f77f64a14dd5b515128644d79e8337df46c49ddf652496c8384
+  metadata.gz: dde8070adb35e548bd260c9a647783d3e240080b58be84712bf8f7dd45bb08a9
+  data.tar.gz: 21b7d0fb202e5ff7f4dc4546b422628494b1a6f683297e66a4fcc2ea93e1b784
 SHA512:
-  metadata.gz: e72ba6591aa9c38b2036c1c27994f280d331fca28817d19fba52991f4477afde6f1bbca040eeb8d4049f084e63ca1e7666f1ff7eed86a1ce43fd79995b4d0fa4
-  data.tar.gz: 903010838dae911df19e9f06dc41080bce7640eb7caab03b6b4c9ca36a9a65105f9b58ef68f3bb5258e66d30015286cb8b9d18ca9ae600c9e31b124412ce2872
+  metadata.gz: 628d5cb01f3ca3b681648aba7341c7a94035d076546f1ddd64fb2cef69a1620ad20a40e258689da1b096fbdfb447f8bce0b2216ec1ed6cad4a6edd907b13fef0
+  data.tar.gz: aabaabb7a44c0bdf48d55b86bfd04e51b3f837f628c361d457b593600dfb82e05a02976e34265bce49348ba91f39f1086d62e927f52587c047d1470f1eae83eb

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-api
 
+### v0.8.0 / 2020-10-27
+
+* BREAKING CHANGE: Move context/span methods to Trace module 
+* BREAKING CHANGE: Remove 'canonical' from status codes 
+* BREAKING CHANGE: Assorted SpanContext fixes 
+
+* ADDED: B3 support 
+* FIXED: Move context/span methods to Trace module 
+* FIXED: Remove 'canonical' from status codes 
+* FIXED: Assorted SpanContext fixes 
+
 ### v0.7.0 / 2020-10-07
 
 * FIXED: Safely navigate span variable during error cases 

data/lib/opentelemetry/trace.rb

@@ -9,6 +9,12 @@ module OpenTelemetry
   # single logical operation, consolidated across various components of an
   # application.
   module Trace
+    extend self
+
+    CURRENT_SPAN_KEY = Context.create_key('current-span')
+
+    private_constant :CURRENT_SPAN_KEY
+
     # An invalid trace identifier, a 16-byte string with all zero bytes.
     INVALID_TRACE_ID = ("\0" * 16).b
 
@@ -19,7 +25,7 @@ module OpenTelemetry
     # non-zero byte.
     #
     # @return [String] a valid trace ID.
-    def self.generate_trace_id
+    def generate_trace_id
       loop do
         id = Random::DEFAULT.bytes(16)
         return id unless id == INVALID_TRACE_ID
@@ -30,12 +36,41 @@ module OpenTelemetry
     # non-zero byte.
     #
     # @return [String] a valid span ID.
-    def self.generate_span_id
+    def generate_span_id
       loop do
         id = Random::DEFAULT.bytes(8)
         return id unless id == INVALID_SPAN_ID
       end
     end
+
+    # 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 = nil)
+      context ||= Context.current
+      context.value(CURRENT_SPAN_KEY) || Span::INVALID
+    end
+
+    # Returns a context containing the span, derived from the optional parent
+    # context, or the current context if one was not provided.
+    #
+    # @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
+
+    # Activates/deactivates the Span within the current Context, which makes the "current span"
+    # available implicitly.
+    #
+    # On exit, the Span that was active before calling this method will be reactivated.
+    #
+    # @param [Span] span the span to activate
+    # @yield [span, context] yields span and a context containing the span to the block.
+    def with_span(span)
+      Context.with_value(CURRENT_SPAN_KEY, span) { |c, s| yield s, c }
+    end
   end
 end
 

data/lib/opentelemetry/trace/link.rb

@@ -18,7 +18,7 @@ module OpenTelemetry
       # Returns the {SpanContext} for this link
       #
       # @return [SpanContext]
-      attr_reader :context
+      attr_reader :span_context
 
       # Returns the frozen attributes for this link.
       #
@@ -33,13 +33,13 @@ module OpenTelemetry
       #   frozen during Link initialization.
       # @return [Link]
       def initialize(span_context, attributes = nil)
-        @context = span_context
+        @span_context = span_context
         @attributes = attributes.freeze || EMPTY_ATTRIBUTES
       end
 
       # Returns true if two {Link}s are equal.
       def ==(other)
-        other.context == @context && other.attributes == @attributes
+        other.span_context == @span_context && other.attributes == @attributes
       end
     end
   end

data/lib/opentelemetry/trace/propagation.rb

@@ -4,7 +4,6 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require 'opentelemetry/trace/propagation/context_keys'
 require 'opentelemetry/trace/propagation/trace_context'
 
 module OpenTelemetry

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

@@ -48,7 +48,7 @@ module OpenTelemetry
                                                   tracestate: tracestate,
                                                   remote: true)
             span = Trace::Span.new(span_context: span_context)
-            context.set_value(ContextKeys.current_span_key, span)
+            OpenTelemetry::Trace.context_with_span(span)
           rescue OpenTelemetry::Error
             context
           end

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

@@ -36,7 +36,7 @@ module OpenTelemetry
             return carrier unless (span_context = span_context_from(context))
 
             setter ||= DEFAULT_SETTER
-            setter.call(carrier, @traceparent_key, TraceParent.from_context(span_context).to_s)
+            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?
 
             carrier
@@ -45,7 +45,7 @@ module OpenTelemetry
           private
 
           def span_context_from(context)
-            context[ContextKeys.current_span_key]&.context
+            OpenTelemetry::Trace.current_span(context).context
           end
         end
       end

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

@@ -31,9 +31,9 @@ module OpenTelemetry
 
           class << self
             # Creates a new {TraceParent} from a supplied {Trace::SpanContext}
-            # @param [SpanContext] ctx The context
+            # @param [SpanContext] ctx The span context
             # @return [TraceParent] a trace parent
-            def from_context(ctx)
+            def from_span_context(ctx)
               new(trace_id: ctx.trace_id, span_id: ctx.span_id, flags: ctx.trace_flags)
             end
 

data/lib/opentelemetry/trace/status.rb

@@ -9,15 +9,15 @@ require 'opentelemetry/trace/util/http_to_status'
 module OpenTelemetry
   module Trace
     # Status represents the status of a finished {Span}. It is composed of a
-    # canonical code in conjunction with an optional descriptive message.
+    # status code in conjunction with an optional descriptive message.
     class Status
       # Convenience utility, not in API spec:
       extend Util::HttpToStatus
 
-      # Retrieve the canonical code of this Status.
+      # Retrieve the status code of this Status.
       #
       # @return [Integer]
-      attr_reader :canonical_code
+      attr_reader :code
 
       # Retrieve the description of this Status.
       #
@@ -26,10 +26,10 @@ module OpenTelemetry
 
       # Initialize a Status.
       #
-      # @param [Integer] canonical_code One of the canonical status codes below
+      # @param [Integer] code One of the status codes below
       # @param [String] description
-      def initialize(canonical_code, description: '')
-        @canonical_code = canonical_code
+      def initialize(code, description: '')
+        @code = code
         @description = description
       end
 
@@ -37,10 +37,10 @@ module OpenTelemetry
       #
       # @return [Boolean]
       def ok?
-        @canonical_code != ERROR
+        @code != ERROR
       end
 
-      # The following represents the canonical set of status codes of a
+      # The following represents the set of status codes of a
       # finished {Span}
 
       # The operation completed successfully.

data/lib/opentelemetry/trace/tracer.rb

@@ -8,28 +8,6 @@ module OpenTelemetry
   module Trace
     # No-op implementation of Tracer.
     class Tracer
-      CURRENT_SPAN_KEY = Propagation::ContextKeys.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 = nil)
-        context ||= Context.current
-        context.value(CURRENT_SPAN_KEY) || Span::INVALID
-      end
-
-      # Returns a context containing the span, derived from the optional parent
-      # context, or the current context if one was not provided.
-      #
-      # @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.
       #
       # With this helper:
@@ -38,7 +16,7 @@ module OpenTelemetry
       #
       # Equivalent without helper:
       #
-      #   OpenTelemetry.tracer.with_span(OpenTelemetry.tracer.start_span('do-the-thing')) do ... end
+      #   OpenTelemetry::Trace.with_span(tracer.start_span('do-the-thing')) do ... end
       #
       # On exit, the Span that was active before calling this method will be reactivated. If an
       # exception occurs during the execution of the provided block, it will be recorded on the
@@ -48,7 +26,7 @@ module OpenTelemetry
       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 }
+        Trace.with_span(span) { |s, c| yield s, c }
       rescue Exception => e # rubocop:disable Lint/RescueException
         span&.record_exception(e)
         span&.status = Status.new(Status::ERROR,
@@ -58,17 +36,6 @@ module OpenTelemetry
         span&.finish
       end
 
-      # Activates/deactivates the Span within the current Context, which makes the "current span"
-      # available implicitly.
-      #
-      # On exit, the Span that was active before calling this method will be reactivated.
-      #
-      # @param [Span] span the span to activate
-      # @yield [span, context] yields span and a context containing the span to the block.
-      def with_span(span)
-        Context.with_value(CURRENT_SPAN_KEY, span) { |c, s| yield s, c }
-      end
-
       def start_root_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
         Span.new
       end
@@ -82,7 +49,7 @@ module OpenTelemetry
       #
       # @return [Span]
       def start_span(name, with_parent: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
-        span_context = current_span(with_parent).context
+        span_context = OpenTelemetry::Trace.current_span(with_parent).context
 
         if span_context.valid?
           Span.new(span_context: span_context)

data/lib/opentelemetry/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ipsa
@@ -178,7 +178,6 @@ files:
 - lib/opentelemetry/trace.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_map_extractor.rb
 - lib/opentelemetry/trace/propagation/trace_context/text_map_injector.rb
@@ -195,7 +194,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v0.8.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/api
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v0.8.0
 post_install_message: 
 rdoc_options: []
 require_paths:

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Trace
-    module Propagation
-      # Contains the keys used to index the current span, or extracted span
-      # context in a {Context} instance
-      module ContextKeys
-        extend self
-
-        EXTRACTED_SPAN_CONTEXT_KEY = Context.create_key('extracted-span-context')
-        CURRENT_SPAN_KEY = Context.create_key('current-span')
-        private_constant :EXTRACTED_SPAN_CONTEXT_KEY, :CURRENT_SPAN_KEY
-
-        # Returns the context key that an extracted span context is indexed by
-        #
-        # @return [Context::Key]
-        def extracted_span_context_key
-          EXTRACTED_SPAN_CONTEXT_KEY
-        end
-
-        # Returns the context key that the current span is indexed by
-        #
-        # @return [Context::Key]
-        def current_span_key
-          CURRENT_SPAN_KEY
-        end
-      end
-    end
-  end
-end