opentelemetry-api 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538ed3a78ed2551d82e647c361b94afc77a083a1126093cb26674e324197d0a0
-  data.tar.gz: eb5a65a102585407772dcc8b57b375c83198cbddc432c97a71d9fdef97e3171a
+  metadata.gz: 9aa5a0850640df96314f3fd539394f878d899b47e1a95e725abc6c0afd6b5a68
+  data.tar.gz: c64e3676eb965f77f64a14dd5b515128644d79e8337df46c49ddf652496c8384
 SHA512:
-  metadata.gz: '097a3f2d32207a56ba207cc2918f24e4eee28483117c54ed0412e83e617922980f385bf5c1949a91b232c4fa4a5bfccf5c66947ee65fc4ebc26460a27a33f6b6'
-  data.tar.gz: 533897d0cea9a0f731e4d7badf100089fb2bb87e95cbe28060e222aea4137272a4e71f9dd65e12ef8a8558bf3635cc512e663de2d5364fea9a1086cab3a9cef1
+  metadata.gz: e72ba6591aa9c38b2036c1c27994f280d331fca28817d19fba52991f4477afde6f1bbca040eeb8d4049f084e63ca1e7666f1ff7eed86a1ce43fd79995b4d0fa4
+  data.tar.gz: 903010838dae911df19e9f06dc41080bce7640eb7caab03b6b4c9ca36a9a65105f9b58ef68f3bb5258e66d30015286cb8b9d18ca9ae600c9e31b124412ce2872

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,11 @@
 # Release History: opentelemetry-api
 
+### 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/lib/opentelemetry/baggage/propagation/text_map_injector.rb

@@ -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/trace/propagation/trace_context/text_map_extractor.rb

@@ -47,7 +47,8 @@ module OpenTelemetry
                                                   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)
+            context.set_value(ContextKeys.current_span_key, span)
           rescue OpenTelemetry::Error
             context
           end

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

@@ -45,8 +45,7 @@ module OpenTelemetry
           private
 
           def span_context_from(context)
-            context[ContextKeys.current_span_key]&.context ||
-              context[ContextKeys.extracted_span_context_key]
+            context[ContextKeys.current_span_key]&.context
           end
         end
       end

data/lib/opentelemetry/trace/status.rb

@@ -26,7 +26,7 @@ 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] canonical_code One of the canonical status codes below
       # @param [String] description
       def initialize(canonical_code, description: '')
         @canonical_code = canonical_code
@@ -37,78 +37,20 @@ module OpenTelemetry
       #
       # @return [Boolean]
       def ok?
-        @canonical_code == OK
+        @canonical_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
+      # 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/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_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
+        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.6.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.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-10-08 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
@@ -211,7 +211,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