opentelemetry-api 0.10.0 → 0.14.0

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

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
 
@@ -85,9 +85,13 @@ module OpenTelemetry
       # can be recorded on a span.
       #
       # @param [Exception] exception The exception to recorded
+      # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
+      #   attributes One or more key:value pairs, where the keys must be
+      #   strings and the values may be (array of) string, boolean or numeric
+      #   type.
       #
       # @return [void]
-      def record_exception(exception); end
+      def record_exception(exception, attributes: nil); end
 
       # Sets the Status to the Span
       #

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
 

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
 

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
 

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.10.0'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-api
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.14.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ipsa
@@ -160,12 +160,12 @@ files:
 - lib/opentelemetry/context/key.rb
 - lib/opentelemetry/context/propagation.rb
 - lib/opentelemetry/context/propagation/composite_propagator.rb
-- lib/opentelemetry/context/propagation/default_getter.rb
-- lib/opentelemetry/context/propagation/default_setter.rb
 - lib/opentelemetry/context/propagation/noop_extractor.rb
 - lib/opentelemetry/context/propagation/noop_injector.rb
-- lib/opentelemetry/context/propagation/propagation.rb
 - lib/opentelemetry/context/propagation/propagator.rb
+- lib/opentelemetry/context/propagation/rack_env_getter.rb
+- lib/opentelemetry/context/propagation/text_map_getter.rb
+- lib/opentelemetry/context/propagation/text_map_setter.rb
 - lib/opentelemetry/error.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/base.rb
@@ -189,16 +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:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v0.10.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/api
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v0.14.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/api
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v0.10.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v0.14.0
 post_install_message: 
 rdoc_options: []
 require_paths:

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  class Context
-    module Propagation
-      # The default getter module provides a common method for reading
-      # a key from a carrier that implements +[]+
-      module DefaultGetter
-        DEFAULT_GETTER = ->(carrier, key) { carrier[key] }
-        private_constant :DEFAULT_GETTER
-
-        # Returns a callable that can read a key from a carrier that implements
-        # +[]+. Useful for extract operations.
-        #
-        # @return [Callable]
-        def default_getter
-          DEFAULT_GETTER
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  class Context
-    module Propagation
-      # The default setter module provides a common method for writing
-      # a key into a carrier that implements +[]=+
-      module DefaultSetter
-        DEFAULT_SETTER = ->(carrier, key, value) { carrier[key] = value }
-        private_constant :DEFAULT_SETTER
-
-        # Returns a callable that can write a key into a carrier that implements
-        # +[]=+. Useful for inject operations.
-        #
-        # @return [Callable]
-        def default_setter
-          DEFAULT_SETTER
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  class Context
-    module Propagation
-      # The Propagation class provides methods to inject and extract context
-      # to pass across process boundaries
-      class Propagation
-        # Get or set the global http propagator. Use a CompositePropagator
-        # to propagate multiple formats.
-        attr_accessor :http
-
-        # Get or set the global text propagator. Use a CompositePropagator
-        # to propagate multiple formats.
-        attr_accessor :text
-
-        def initialize
-          @http = @text = Propagator.new(NoopInjector.new, NoopExtractor.new)
-        end
-      end
-    end
-  end
-end