opentelemetry-api 0.6.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538ed3a78ed2551d82e647c361b94afc77a083a1126093cb26674e324197d0a0
-  data.tar.gz: eb5a65a102585407772dcc8b57b375c83198cbddc432c97a71d9fdef97e3171a
+  metadata.gz: 5b7fecd268c9efe43c452847e831bf1456d502c8531e589691b865bd1264b53f
+  data.tar.gz: d8b33160247e5d8c94b248f607b621333112cda1a6fc7af00ce68ef1caed1cb0
 SHA512:
-  metadata.gz: '097a3f2d32207a56ba207cc2918f24e4eee28483117c54ed0412e83e617922980f385bf5c1949a91b232c4fa4a5bfccf5c66947ee65fc4ebc26460a27a33f6b6'
-  data.tar.gz: 533897d0cea9a0f731e4d7badf100089fb2bb87e95cbe28060e222aea4137272a4e71f9dd65e12ef8a8558bf3635cc512e663de2d5364fea9a1086cab3a9cef1
+  metadata.gz: 06e4bda488c11623f710a74288de802c8af5fbb879bb52edbd003dd10159ff443bde7c9d6f511915e0ecdaaf54244f7b8897c4137b466bd11bdc87f51b87d337
+  data.tar.gz: 8466f42436e3e89e0a4339699887b3eae95551dd601f66be5b3f9ffc76f3aaad2075e95cb6aeed945422e0ea998148b769dc2781d3095a67c2051c2cc52068a7

data/.yardopts

@@ -1,9 +1,9 @@
 --no-private
 --title=OpenTelemetry API
 --markup=markdown
---main=OVERVIEW.md
+--main=README.md
 ./lib/opentelemetry/**/*.rb
 ./lib/opentelemetry.rb
 -
-OVERVIEW.md
+README.md
 CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Release History: opentelemetry-api
 
+### v0.11.0 / 2020-12-11
+
+* BREAKING CHANGE: Implement tracestate 
+
+* ADDED: Implement tracestate 
+* FIXED: Missing white space from install messages 
+* FIXED: Copyright comments to not reference year 
+
+### v0.10.0 / 2020-12-03
+
+* (No significant changes)
+
+### v0.9.0 / 2020-11-27
+
+* (No significant changes)
+
+### 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 
+* DOCS: Standardize toplevel docs structure and readme 
+* DOCS: Fix param description in TextMapInjector for Baggage 
+
 ### v0.6.0 / 2020-09-10
 
 * ADDED: Add support for OTEL_LOG_LEVEL env var

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/lib/opentelemetry-api.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/baggage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/baggage/builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/baggage/manager.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/baggage/propagation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/baggage/propagation/text_map_extractor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/baggage/propagation/text_map_injector.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -16,7 +16,7 @@ module OpenTelemetry
         # Returns a new TextMapInjector that injects context using the specified
         # header key
         #
-        # @param [String] baggage_header_key The baggage header
+        # @param [String] baggage_key The baggage header
         #   key used in the carrier
         # @return [TextMapInjector]
         def initialize(baggage_key: 'baggage')

data/lib/opentelemetry/context.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/context/key.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/context/propagation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry

data/lib/opentelemetry/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/registry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -79,7 +79,7 @@ module OpenTelemetry
           OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} failed to install"
         end
       rescue => e # rubocop:disable Style/RescueStandardError
-        OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} unhandled exception" \
+        OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} unhandled exception " \
                                   "during install #{e}: #{e.backtrace}"
       end
     end

data/lib/opentelemetry/metrics.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/handles.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/instruments.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/meter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/metrics/meter_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -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,17 +36,47 @@ 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
 
 require 'opentelemetry/trace/link'
 require 'opentelemetry/trace/trace_flags'
+require 'opentelemetry/trace/tracestate'
 require 'opentelemetry/trace/span_context'
 require 'opentelemetry/trace/span_kind'
 require 'opentelemetry/trace/span'

data/lib/opentelemetry/trace/link.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -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

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # 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.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry
@@ -37,17 +37,16 @@ module OpenTelemetry
           #   context if parsing fails.
           def extract(carrier, context, &getter)
             getter ||= default_getter
-            header = getter.call(carrier, @traceparent_key)
-            tp = TraceParent.from_string(header)
-
-            tracestate = getter.call(carrier, @tracestate_key)
+            tp = TraceParent.from_string(getter.call(carrier, @traceparent_key))
+            tracestate = Tracestate.from_string(getter.call(carrier, @tracestate_key))
 
             span_context = Trace::SpanContext.new(trace_id: tp.trace_id,
                                                   span_id: tp.span_id,
                                                   trace_flags: tp.flags,
                                                   tracestate: tracestate,
                                                   remote: true)
-            context.set_value(ContextKeys.extracted_span_context_key, span_context)
+            span = Trace::Span.new(span_context: span_context)
+            OpenTelemetry::Trace.context_with_span(span)
           rescue OpenTelemetry::Error
             context
           end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry
@@ -36,8 +36,8 @@ 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, @tracestate_key, span_context.tracestate) unless span_context.tracestate.nil?
+            setter.call(carrier, @traceparent_key, TraceParent.from_span_context(span_context).to_s)
+            setter.call(carrier, @tracestate_key, span_context.tracestate.to_s) unless span_context.tracestate.empty?
 
             carrier
           end
@@ -45,8 +45,7 @@ module OpenTelemetry
           private
 
           def span_context_from(context)
-            context[ContextKeys.current_span_key]&.context ||
-              context[ContextKeys.extracted_span_context_key]
+            OpenTelemetry::Trace.current_span(context).context
           end
         end
       end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 module OpenTelemetry
@@ -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/span.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace/span_context.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -18,14 +18,14 @@ module OpenTelemetry
       # @param [optional String] trace_id The trace ID associated with a {Span}.
       # @param [optional String] span_id The span ID associated with a {Span}.
       # @param [optional TraceFlags] trace_flags The trace flags associated with a {Span}.
-      # @param [optional String] tracestate The tracestate associated with a {Span}. May be nil.
+      # @param [optional Tracestate] tracestate The tracestate associated with a {Span}. May be nil.
       # @param [optional Boolean] remote Whether the {SpanContext} was extracted from the wire.
       # @return [SpanContext]
       def initialize(
         trace_id: Trace.generate_trace_id,
         span_id: Trace.generate_span_id,
         trace_flags: TraceFlags::DEFAULT,
-        tracestate: nil,
+        tracestate: Tracestate::DEFAULT,
         remote: false
       )
         @trace_id = trace_id

data/lib/opentelemetry/trace/span_kind.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace/status.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -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 standard gRPC codes: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+      # @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,78 +37,20 @@ module OpenTelemetry
       #
       # @return [Boolean]
       def ok?
-        @canonical_code == OK
+        @code != ERROR
       end
 
-      # The following represents the canonical set of status codes of a
-      # finished {Span}, following the standard gRPC codes:
-      # https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+      # The following represents the set of status codes of a
+      # finished {Span}
 
       # The operation completed successfully.
       OK = 0
 
-      # The operation was cancelled (typically by the caller).
-      CANCELLED = 1
+      # The default status.
+      UNSET = 1
 
-      # An unknown error.
-      UNKNOWN_ERROR = 2
-
-      # Client specified an invalid argument. Note that this differs from
-      # {FAILED_PRECONDITION}. {INVALID_ARGUMENT} indicates arguments that are
-      # problematic regardless of the state of the system.
-      INVALID_ARGUMENT = 3
-
-      # Deadline expired before operation could complete. For operations that
-      # change the state of the system, this error may be returned even if the
-      # operation has completed successfully.
-      DEADLINE_EXCEEDED = 4
-
-      # Some requested entity (e.g., file or directory) was not found.
-      NOT_FOUND = 5
-
-      # Some entity that we attempted to create (e.g., file or directory)
-      # already exists.
-      ALREADY_EXISTS = 6
-
-      # The caller does not have permission to execute the specified operation.
-      # {PERMISSION_DENIED} must not be used if the caller cannot be identified
-      # (use {UNAUTHENTICATED} instead for those errors).
-      PERMISSION_DENIED = 7
-
-      # Some resource has been exhausted, perhaps a per-user quota, or perhaps
-      # the entire file system is out of space.
-      RESOURCE_EXHAUSTED = 8
-
-      # Operation was rejected because the system is not in a state required
-      # for the operation's execution.
-      FAILED_PRECONDITION = 9
-
-      # The operation was aborted, typically due to a concurrency issue like
-      # sequencer check failures, transaction aborts, etc.
-      ABORTED = 10
-
-      # Operation was attempted past the valid range. E.g., seeking or reading
-      # past end of file. Unlike {INVALID_ARGUMENT}, this error indicates a
-      # problem that may be fixed if the system state changes.
-      OUT_OF_RANGE = 11
-
-      # Operation is not implemented or not supported/enabled in this service.
-      UNIMPLEMENTED = 12
-
-      # Internal errors. Means some invariants expected by underlying system
-      # has been broken.
-      INTERNAL_ERROR = 13
-
-      # The service is currently unavailable. This is a most likely a transient
-      # condition and may be corrected by retrying with a backoff.
-      UNAVAILABLE = 14
-
-      # Unrecoverable data loss or corruption.
-      DATA_LOSS = 15
-
-      # The request does not have valid authentication credentials for the
-      # operation.
-      UNAUTHENTICATED = 16
+      # An error.
+      ERROR = 2
     end
   end
 end

data/lib/opentelemetry/trace/trace_flags.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace/tracer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -8,35 +8,6 @@ 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
-
-      # 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)
-        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.
-      #
-      def active_span_context(context = nil)
-        context ||= Context.current
-        context.value(CURRENT_SPAN_KEY)&.context ||
-          context.value(EXTRACTED_SPAN_CONTEXT_KEY) ||
-          SpanContext::INVALID
-      end
-
       # This is a helper for the default use-case of extending the current trace with a span.
       #
       # With this helper:
@@ -45,34 +16,24 @@ 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
       # 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)
-        with_span(span) { |s, c| yield s, c }
+      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)
+        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::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
-      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 }
+        span&.finish
       end
 
       def start_root_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
@@ -84,14 +45,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 = OpenTelemetry::Trace.current_span(with_parent).context
+
         if span_context.valid?
           Span.new(span_context: span_context)
         else

data/lib/opentelemetry/trace/tracer_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/trace/tracestate.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Trace
+    # Tracestate is a part of SpanContext, represented by an immutable list of
+    # string key/value pairs and formally defined by the W3C Trace Context
+    # specification https://www.w3.org/TR/trace-context/
+    class Tracestate
+      class << self
+        private :new # rubocop:disable Style/AccessModifierDeclarations
+
+        # Returns a newly created Tracestate parsed from the header provided.
+        #
+        # @param [String] header Encoding of the tracestate header defined by
+        #   the W3C Trace Context specification https://www.w3.org/TR/trace-context/
+        # @return [Tracestate] A new Tracestate instance or DEFAULT
+        def from_string(header) # rubocop:disable Metrics/CyclomaticComplexity:
+          return DEFAULT if header.nil? || header.empty?
+
+          hash = header.split(',').each_with_object({}) do |member, memo|
+            member.strip!
+            kv = member.split('=')
+            k, v = *kv
+            next unless kv.length == 2 && VALID_KEY.match?(k) && VALID_VALUE.match?(v)
+
+            memo[k] = v
+          end
+          return DEFAULT if hash.empty?
+
+          new(hash)
+        end
+
+        # Returns a Tracestate created from a Hash.
+        #
+        # @param [Hash<String, String>] hash Key-value pairs to store in the
+        #   Tracestate. Keys and values are validated against the W3C Trace
+        #   Context specification, and any invalid members are logged at
+        #   DEBUG level and dropped.
+        # @return [Tracestate] A new Tracestate instance or DEFAULT
+        def from_hash(hash)
+          hash = hash.select do |k, v|
+            valid = VALID_KEY.match?(k) && VALID_VALUE.match?(v)
+            OpenTelemetry.logger.debug("Invalid Tracestate member - #{k} : #{v}") unless valid
+            valid
+          end
+          new(hash)
+        end
+
+        # @api private
+        # Returns a new Tracestate created from the Hash provided. This
+        # skips validation of the keys and values, assuming they are already
+        # valid.
+        # This method is intended only for the use of instance methods in
+        # this class.
+        def create(hash)
+          new(hash)
+        end
+      end
+
+      MAX_MEMBER_COUNT = 32 # Defined by https://www.w3.org/TR/trace-context/
+      VALID_KEY = Regexp.union(%r(^[a-z][a-z0-9_\-*/]{,255}$), %r(^[a-z0-9][a-z0-9_\-*/]{,240}@[a-z][a-z0-9_\-*/]{,13}$)).freeze
+      VALID_VALUE = /^[ -~&&[^,=]]{,255}[!-~&&[^,=]]$/.freeze
+      private_constant(:MAX_MEMBER_COUNT, :VALID_KEY, :VALID_VALUE)
+
+      # @api private
+      # The constructor is private and only for use internally by the class.
+      # Users should use the {from_hash} or {from_string} factory methods to
+      # obtain a {Tracestate} instance.
+      #
+      # @param [Hash<String, String>] hash Key-value pairs
+      # @return [Tracestate]
+      def initialize(hash)
+        excess = hash.size - MAX_MEMBER_COUNT
+        hash = Hash[hash.drop(excess)] if excess.positive?
+        @hash = hash.freeze
+      end
+
+      # Returns the value associated with the given key, or nil if the key
+      # is not present.
+      #
+      # @param [String] key The key to lookup.
+      # @return [String] The value associated with the key, or nil.
+      def value(key)
+        @hash[key]
+      end
+
+      alias [] value
+
+      # Adds a new key/value pair or updates an existing value for a given key.
+      # Keys and values are validated against the W3C Trace Context
+      # specification, and any invalid members are logged at DEBUG level and
+      # ignored.
+      #
+      # @param [String] key The key to add or update.
+      # @param [String] value The value to add or update.
+      # @return [Tracestate] self, if unchanged, or a new Tracestate containing
+      #   the new or updated key/value pair.
+      def set_value(key, value)
+        return self unless VALID_KEY.match?(key) && VALID_VALUE.match?(value)
+
+        h = Hash[@hash]
+        h[key] = value
+        self.class.create(h)
+      end
+
+      # Deletes the key/value pair associated with the given key.
+      #
+      # @param [String] key The key to remove.
+      # @return [Tracestate] self, if unchanged, or a new Tracestate without
+      #   the specified key.
+      def delete(key)
+        return self unless @hash.key?(key)
+
+        h = Hash[@hash]
+        h.delete(key)
+        self.class.create(h)
+      end
+
+      # Returns this Tracestate encoded according to the W3C Trace Context
+      # specification https://www.w3.org/TR/trace-context/
+      #
+      # @return [String] this Tracestate encoded as a string.
+      def to_s
+        @hash.inject(+'') do |memo, (k, v)|
+          memo << k << '=' << v << ','
+        end.chop! || ''
+      end
+
+      # Returns this Tracestate as a Hash.
+      #
+      # @return [Hash] the members of this Tracestate
+      def to_h
+        @hash.dup
+      end
+
+      # Returns true if this Tracestate is empty.
+      #
+      # @return [Boolean] true if this Tracestate is empty, else false.
+      def empty?
+        @hash.empty?
+      end
+
+      # Returns true if this Tracestate equals other.
+      #
+      # @param [Tracestate] other The Tracestate for comparison.
+      # @return [Boolean] true if this Tracestate == other, else false.
+      def ==(other)
+        @hash == other.to_h
+      end
+
+      DEFAULT = new({})
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   ## Current OpenTelemetry version
-  VERSION = '0.6.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ipsa
@@ -146,7 +146,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE
-- OVERVIEW.md
+- README.md
 - lib/opentelemetry-api.rb
 - lib/opentelemetry.rb
 - lib/opentelemetry/baggage.rb
@@ -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
@@ -190,12 +189,17 @@ files:
 - lib/opentelemetry/trace/trace_flags.rb
 - lib/opentelemetry/trace/tracer.rb
 - lib/opentelemetry/trace/tracer_provider.rb
+- lib/opentelemetry/trace/tracestate.rb
 - lib/opentelemetry/trace/util/http_to_status.rb
 - lib/opentelemetry/version.rb
 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.11.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.11.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -211,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework

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