opentelemetry-api 0.17.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d983ae124f8d6da3e8fa92560912718bdbbc9a3ea89f2012cb2d51e6d80873d
-  data.tar.gz: 75bc11d4296b0a21a136b3ada57d6a5cf59c736d61d6d113ab4bbd6195dacb8c
+  metadata.gz: b25f500e6cfa87fe641a3db001ae9f6adf772a9a742761ccdc21c43c8e78ea96
+  data.tar.gz: 7344a0ae9cdc4030634e28bb21ce19a6369a509b8fb0c56dc085e9ce586fd8e5
 SHA512:
-  metadata.gz: 2c051831f433ca25fbbdf4662d7ac8e156804bdb98e6dd5d2476597baac55561edc46d32bb3a02d23f7a316e20aee88b6ea5dfae608813933d8d08d5fdbb7afb
-  data.tar.gz: 9bd812321d5d84960a4e866a50b1a6b483a6742a4a909118792a72859e7123df0f945fea4476eeb9e5eca6e2b120cfd09eee55475a7ef36f11bafb4e124f1258
+  metadata.gz: 7a489fb55dc89f48a164c646bc94ec1f5e63a19329a61bf5461b1d1474e6d2b0e9f606d40f85aa2cafdcff377b3cae5b4b9f2d5b62a9965c42577e61aa0122df
+  data.tar.gz: 8fb44ad73536ca545b7f7a61c0e2f37fccc29fc5676abd4ca4eaf0572054f0bb77c70c8bb9220af64c7ff23364b662b2f3212a562569e3bc68c645c71ae447b2

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Release History: opentelemetry-api
 
+### v1.0.0 / 2021-09-29
+
+* (No significant changes)
+
+### v1.0.0.rc3 / 2021-08-12
+
+* BREAKING CHANGE: Remove optional parent_context from in_span
+* BREAKING CHANGE: Refactor Baggage to remove Noop*
+* BREAKING CHANGE: Total order constraint on span.status=
+
+* ADDED: Add Tracer.non_recording_span to API
+* ADDED: Make API's NoopTextMapPropagator private
+* FIXED: Remove optional parent_context from in_span
+* FIXED: Reduce span allocation in API
+* FIXED: Refactor Baggage to remove Noop*
+* FIXED: Total order constraint on span.status=
+* FIXED: Return early if carrier is nil
+* FIXED: Update context to match spec
+* FIXED: Return the original context if the baggage header value is empty
+* DOCS: Update docs to rely more on environment variable configuration
+
+### v1.0.0.rc2 / 2021-06-23
+
+* BREAKING CHANGE: Remove optional parent_context from in_span [729](https://github.com/open-telemetry/opentelemetry-ruby/pull/729)
+* BREAKING CHANGE: Refactor Baggage to remove Noop* [800](https://github.com/open-telemetry/opentelemetry-ruby/pull/800)
+  - The noop baggage manger has been removed.
+  - The baggage management methods are now available through OpenTelemetry::Baggage#method, previously OpenTelemetry.baggage#method
+* BREAKING CHANGE: Total order constraint on span.status= [805](https://github.com/open-telemetry/opentelemetry-ruby/pull/805)
+  - The OpenTelemetry::Trace::Util::HttpToStatus module has been removed as it was incorrectly setting the span status to OK for codes codes in the range 100..399
+  - The HttpToStatus module can be replaced inline as follows `span.status = OpenTelemetry::Trace::Status.error unless (100..399).include?(response_code.to_i)`
+  - The `Status.new(code, description:)` initializer has been hidden in favour of simpler constructors for each status code: `Status.ok`, `Status.error` and `Status.unset`. Each constructor takes an optional description.
+
+* ADDED: Add Tracer.non_recording_span to API [799](https://github.com/open-telemetry/opentelemetry-ruby/pull/799)
+* FIXED: Reduce span allocation in API [795](https://github.com/open-telemetry/opentelemetry-ruby/pull/795)
+* FIXED: Return early if carrier is nil [835](https://github.com/open-telemetry/opentelemetry-ruby/pull/835)
+* FIXED: Update context to match spec [807](https://github.com/open-telemetry/opentelemetry-ruby/pull/807)
+  - The `Context.current` setter has been removed and the previously private attach/detach methods are now available as class methods on the context module.
+
+### v1.0.0.rc1 / 2021-05-21
+
+* BREAKING CHANGE: Remove optional parent_context from in_span 
+
+* FIXED: Remove optional parent_context from in_span
+
 ### v0.17.0 / 2021-04-22
 
 * BREAKING CHANGE: Replace TextMapInjector/TextMapExtractor pairs with a TextMapPropagator.

data/README.md

@@ -29,11 +29,11 @@ Then, use the OpenTelemetry interfaces to produces traces and other telemetry da
 ```ruby
 require 'opentelemetry'
 
-# Obtain the current default tracer factory
-factory = OpenTelemetry.tracer_factory
+# Obtain the current default tracer provider
+provider = OpenTelemetry.tracer_provider
 
 # Create a trace
-tracer = factory.tracer('my_app', '1.0')
+tracer = provider.tracer('my_app', '1.0')
 
 # Record spans
 tracer.in_span('my_task') do |task_span|

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

@@ -29,7 +29,7 @@ module OpenTelemetry
         #   will be used to write context into the carrier, otherwise the default
         #   text map setter will be used.
         def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter)
-          baggage = OpenTelemetry.baggage.raw_entries(context: context)
+          baggage = OpenTelemetry::Baggage.raw_entries(context: context)
 
           return if baggage.nil? || baggage.empty?
 
@@ -39,7 +39,8 @@ module OpenTelemetry
         end
 
         # Extract remote baggage from the supplied carrier.
-        # If extraction fails, the original context will be returned
+        # If extraction fails or there is no baggage to extract,
+        # then the original context will be returned
         #
         # @param [Carrier] carrier The carrier to get the header from
         # @param [optional Context] context Context to be updated with the baggage
@@ -52,10 +53,11 @@ module OpenTelemetry
         #   if extraction fails
         def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
           header = getter.get(carrier, BAGGAGE_KEY)
+          return context if header.nil? || header.empty?
 
           entries = header.gsub(/\s/, '').split(',')
 
-          OpenTelemetry.baggage.build(context: context) do |builder|
+          OpenTelemetry::Baggage.build(context: context) do |builder|
             entries.each do |entry|
               # Note metadata is currently unused in OpenTelemetry, but is part
               # the W3C spec where it's referred to as properties. We preserve

data/lib/opentelemetry/baggage.rb

@@ -7,13 +7,103 @@
 require 'opentelemetry/baggage/propagation'
 require 'opentelemetry/baggage/builder'
 require 'opentelemetry/baggage/entry'
-require 'opentelemetry/baggage/manager'
-require 'opentelemetry/baggage/noop_builder'
-require 'opentelemetry/baggage/noop_manager'
 
 module OpenTelemetry
   # The Baggage module provides functionality to record and propagate
   # baggage in a distributed trace
   module Baggage
+    extend self
+
+    BAGGAGE_KEY = OpenTelemetry::Baggage::Propagation::ContextKeys.baggage_key
+    EMPTY_BAGGAGE = {}.freeze
+    private_constant(:BAGGAGE_KEY, :EMPTY_BAGGAGE)
+
+    # Used to chain modifications to baggage. The result is a
+    # context with an updated baggage. If only a single
+    # modification is being made to baggage, use the other
+    # methods on +Baggage+, if multiple modifications are being made, use
+    # this one.
+    #
+    # @param [optional Context] context The context to update with with new
+    #   modified baggage. Defaults to +Context.current+
+    # @return [Context]
+    def build(context: Context.current)
+      builder = Builder.new(baggage_for(context).dup)
+      yield builder
+      context.set_value(BAGGAGE_KEY, builder.entries)
+    end
+
+    # Returns a new context with empty baggage
+    #
+    # @param [optional Context] context Context to clear baggage from. Defaults
+    #   to +Context.current+
+    # @return [Context]
+    def clear(context: Context.current)
+      context.set_value(BAGGAGE_KEY, EMPTY_BAGGAGE)
+    end
+
+    # Returns the corresponding baggage.entry (or nil) for key
+    #
+    # @param [String] key The lookup key
+    # @param [optional Context] context The context from which to retrieve
+    #   the key.
+    #   Defaults to +Context.current+
+    # @return [String]
+    def value(key, context: Context.current)
+      baggage_for(context)[key]&.value
+    end
+
+    # Returns the baggage
+    #
+    # @param [optional Context] context The context from which to retrieve
+    #   the baggage.
+    #   Defaults to +Context.current+
+    # @return [Hash]
+    def values(context: Context.current)
+      baggage_for(context).transform_values(&:value)
+    end
+
+    # @api private
+    def raw_entries(context: Context.current)
+      baggage_for(context).dup.freeze
+    end
+
+    # Returns a new context with new key-value pair
+    #
+    # @param [String] key The key to store this value under
+    # @param [String] value String value to be stored under key
+    # @param [optional String] metadata This is here to store properties
+    #   received from other W3C Baggage impelmentations but is not exposed in
+    #   OpenTelemetry. This is condsidered private API and not for use by
+    #   end-users.
+    # @param [optional Context] context The context to update with new
+    #   value. Defaults to +Context.current+
+    # @return [Context]
+    def set_value(key, value, metadata: nil, context: Context.current)
+      new_baggage = baggage_for(context).dup
+      new_baggage[key] = Entry.new(value, metadata)
+      context.set_value(BAGGAGE_KEY, new_baggage)
+    end
+
+    # Returns a new context with value at key removed
+    #
+    # @param [String] key The key to remove
+    # @param [optional Context] context The context to remove baggage
+    #   from. Defaults to +Context.current+
+    # @return [Context]
+    def remove_value(key, context: Context.current)
+      baggage = baggage_for(context)
+      return context unless baggage.key?(key)
+
+      new_baggage = baggage.dup
+      new_baggage.delete(key)
+      context.set_value(BAGGAGE_KEY, new_baggage)
+    end
+
+    private
+
+    def baggage_for(context)
+      context.value(BAGGAGE_KEY) || EMPTY_BAGGAGE
+    end
   end
 end

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

@@ -7,41 +7,17 @@
 module OpenTelemetry
   class Context
     module Propagation
-      # A no-op text map propagator implementation
+      # @api private
       class NoopTextMapPropagator
         EMPTY_LIST = [].freeze
         private_constant(:EMPTY_LIST)
 
-        # Injects the provided context into a carrier.
-        #
-        # @param [Object] carrier A mutable carrier to inject context into.
-        # @param [optional Context] context Context to be injected into carrier. Defaults
-        #   to +Context.current+.
-        # @param [optional Setter] setter If the optional setter is provided, it
-        #   will be used to write context into the carrier, otherwise the default
-        #   setter will be used.
         def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter); end
 
-        # Extracts and returns context from a carrier. Returns the provided
-        # context and logs a warning if an error if extraction fails.
-        #
-        # @param [Object] carrier The carrier to extract context from.
-        # @param [optional Context] context Context to be updated with the state
-        #   extracted from the carrier. Defaults to +Context.current+.
-        # @param [optional Getter] getter If the optional getter is provided, it
-        #   will be used to read the header from the carrier, otherwise the default
-        #   getter will be used.
-        #
-        # @return [Context] a new context updated with state extracted from the
-        #   carrier
         def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
           context
         end
 
-        # Returns the predefined propagation fields. If your carrier is reused, you
-        # should delete the fields returned by this method before calling +inject+.
-        #
-        # @return [Array<String>] a list of fields that will be used by this propagator.
         def fields
           EMPTY_LIST
         end

data/lib/opentelemetry/context.rb

@@ -10,8 +10,11 @@ require 'opentelemetry/context/propagation'
 module OpenTelemetry
   # Manages context on a per-fiber basis
   class Context
-    KEY = :__opentelemetry_context__
     EMPTY_ENTRIES = {}.freeze
+    STACK_KEY = :__opentelemetry_context_storage__
+    private_constant :EMPTY_ENTRIES, :STACK_KEY
+
+    DetachError = Class.new(OpenTelemetry::Error)
 
     class << self
       # Returns a key used to index a value in a Context
@@ -26,14 +29,36 @@ module OpenTelemetry
       #
       # @return [Context]
       def current
-        Thread.current[KEY] ||= ROOT
+        stack.last || ROOT
       end
 
-      # Sets the current context
+      # Associates a Context with the caller's current Fiber. Every call to
+      # this operation should be paired with a corresponding call to detach.
       #
-      # @param [Context] ctx The context to be made active
-      def current=(ctx)
-        Thread.current[KEY] = ctx
+      # Returns a token to be used with the matching call to detach
+      #
+      # @param [Context] context The new context
+      # @return [Object] A token to be used when detaching
+      def attach(context)
+        s = stack
+        s.push(context)
+        s.size
+      end
+
+      # Restores the previous Context associated with the current Fiber.
+      # The supplied token is used to check if the call to detach is balanced
+      # with a corresponding attach call. A warning is logged if the
+      # calls are unbalanced.
+      #
+      # @param [Object] token The token provided by the matching call to attach
+      # @return [Boolean] True if the calls matched, false otherwise
+      def detach(token)
+        s = stack
+        calls_matched = (token == s.size)
+        OpenTelemetry.handle_error(exception: DetachError.new('calls to detach should match corresponding calls to attach.')) unless calls_matched
+
+        s.pop
+        calls_matched
       end
 
       # Executes a block with ctx as the current context. It restores
@@ -42,10 +67,10 @@ module OpenTelemetry
       # @param [Context] ctx The context to be made active
       # @yield [context] Yields context to the block
       def with_current(ctx)
-        prev = ctx.attach
+        token = attach(ctx)
         yield ctx
       ensure
-        ctx.detach(prev)
+        detach(token)
       end
 
       # Execute a block in a new context with key set to value. Restores the
@@ -58,10 +83,10 @@ module OpenTelemetry
       #   the block
       def with_value(key, value)
         ctx = current.set_value(key, value)
-        prev = ctx.attach
+        token = attach(ctx)
         yield ctx, value
       ensure
-        ctx.detach(prev)
+        detach(token)
       end
 
       # Execute a block in a new context where its values are merged with the
@@ -75,10 +100,10 @@ module OpenTelemetry
       #   to the block
       def with_values(values)
         ctx = current.set_values(values)
-        prev = ctx.attach
+        token = attach(ctx)
         yield ctx, values
       ensure
-        ctx.detach(prev)
+        detach(token)
       end
 
       # Returns the value associated with key in the current context
@@ -89,16 +114,21 @@ module OpenTelemetry
       end
 
       def clear
-        self.current = ROOT
+        stack.clear
       end
 
       def empty
-        new(nil, EMPTY_ENTRIES)
+        new(EMPTY_ENTRIES)
+      end
+
+      private
+
+      def stack
+        Thread.current[STACK_KEY] ||= []
       end
     end
 
-    def initialize(parent, entries)
-      @parent = parent
+    def initialize(entries)
       @entries = entries.freeze
     end
 
@@ -120,7 +150,7 @@ module OpenTelemetry
     def set_value(key, value)
       new_entries = @entries.dup
       new_entries[key] = value
-      Context.new(self, new_entries)
+      Context.new(new_entries)
     end
 
     # Returns a new Context with the current context's entries merged with the
@@ -131,22 +161,7 @@ module OpenTelemetry
     # @param [Object] value Object to be stored under key
     # @return [Context]
     def set_values(values) # rubocop:disable Naming/AccessorMethodName:
-      Context.new(self, @entries.merge(values))
-    end
-
-    # @api private
-    def attach
-      prev = self.class.current
-      self.class.current = self
-      prev
-    end
-
-    # @api private
-    def detach(ctx_to_attach = nil)
-      OpenTelemetry.logger.warn 'Calls to detach should match corresponding calls to attach' if self.class.current != self
-
-      ctx_to_attach ||= @parent || ROOT
-      ctx_to_attach.attach
+      Context.new(@entries.merge(values))
     end
 
     ROOT = empty.freeze

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

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Trace
     module Propagation
       module TraceContext
-        # Propagates baggage using the W3C Trace Context format
+        # Propagates trace context using the W3C Trace Context format
         class TextMapPropagator
           TRACEPARENT_KEY = 'traceparent'
           TRACESTATE_KEY = 'tracestate'
@@ -53,7 +53,7 @@ module OpenTelemetry
                                                   trace_flags: tp.flags,
                                                   tracestate: tracestate,
                                                   remote: true)
-            span = Trace::Span.new(span_context: span_context)
+            span = OpenTelemetry::Trace.non_recording_span(span_context)
             OpenTelemetry::Trace.context_with_span(span)
           rescue OpenTelemetry::Error
             context

data/lib/opentelemetry/trace/status.rb

@@ -4,15 +4,41 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require 'opentelemetry/trace/util/http_to_status'
-
 module OpenTelemetry
   module Trace
     # Status represents the status of a finished {Span}. It is composed of a
     # status code in conjunction with an optional descriptive message.
     class Status
-      # Convenience utility, not in API spec:
-      extend Util::HttpToStatus
+      class << self
+        private :new # rubocop:disable Style/AccessModifierDeclarations
+
+        # Returns a newly created {Status} with code == UNSET and an optional
+        # description.
+        #
+        # @param [String] description
+        # @return [Status]
+        def unset(description = '')
+          new(UNSET, description: description)
+        end
+
+        # Returns a newly created {Status} with code == OK and an optional
+        # description.
+        #
+        # @param [String] description
+        # @return [Status]
+        def ok(description = '')
+          new(OK, description: description)
+        end
+
+        # Returns a newly created {Status} with code == ERROR and an optional
+        # description.
+        #
+        # @param [String] description
+        # @return [Status]
+        def error(description = '')
+          new(ERROR, description: description)
+        end
+      end
 
       # Retrieve the status code of this Status.
       #
@@ -24,7 +50,10 @@ module OpenTelemetry
       # @return [String]
       attr_reader :description
 
-      # Initialize a Status.
+      # @api private
+      # The constructor is private and only for use internally by the class.
+      # Users should use the {unset}, {error}, or {ok} factory methods to
+      # obtain a {Status} instance.
       #
       # @param [Integer] code One of the status codes below
       # @param [String] description

data/lib/opentelemetry/trace/tracer.rb

@@ -23,21 +23,20 @@ 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)
+      def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
         span = nil
-        span = start_span(name, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind, with_parent: with_parent)
+        span = start_span(name, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind)
         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,
-                                  description: "Unhandled exception of type: #{e.class}")
+        span&.status = Status.error("Unhandled exception of type: #{e.class}")
         raise e
       ensure
         span&.finish
       end
 
       def start_root_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
-        Span.new
+        Span::INVALID
       end
 
       # Used when a caller wants to manage the activation/deactivation and lifecycle of
@@ -49,12 +48,12 @@ module OpenTelemetry
       #
       # @return [Span]
       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
+        span = OpenTelemetry::Trace.current_span(with_parent)
 
-        if span_context.valid?
-          Span.new(span_context: span_context)
+        if span.context.valid?
+          span
         else
-          Span.new
+          Span::INVALID
         end
       end
     end

data/lib/opentelemetry/trace.rb

@@ -81,6 +81,16 @@ module OpenTelemetry
     def with_span(span)
       Context.with_value(CURRENT_SPAN_KEY, span) { |c, s| yield s, c }
     end
+
+    # Wraps a SpanContext with an object implementing the Span interface. This is done in order
+    # to expose a SpanContext as a Span in operations such as in-process Span propagation.
+    #
+    # @param [SpanContext] span_context SpanContext to be wrapped
+    #
+    # @return [Span]
+    def non_recording_span(span_context)
+      Span.new(span_context: span_context)
+    end
   end
 end
 

data/lib/opentelemetry/version.rb

@@ -6,5 +6,5 @@
 
 module OpenTelemetry
   ## Current OpenTelemetry version
-  VERSION = '0.17.0'
+  VERSION = '1.0.0'
 end

data/lib/opentelemetry.rb

@@ -24,7 +24,7 @@ module OpenTelemetry
   @mutex = Mutex.new
   @tracer_provider = Internal::ProxyTracerProvider.new
 
-  attr_writer :propagation, :baggage, :logger, :error_handler
+  attr_writer :propagation, :logger, :error_handler
 
   # @return [Object, Logger] configured Logger or a default STDOUT Logger.
   def logger
@@ -65,13 +65,6 @@ module OpenTelemetry
     @mutex.synchronize { @tracer_provider }
   end
 
-  # @return [Object, Baggage::NoopManager] registered
-  #   baggage manager or a default no-op implementation of the
-  #   manager.
-  def baggage
-    @baggage ||= Baggage::NoopManager.new
-  end
-
   # @return [Context::Propagation::Propagator] a propagator instance
   def propagation
     @propagation ||= Context::Propagation::NoopTextMapPropagator.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-api
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 1.0.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ipsa
@@ -152,9 +152,6 @@ files:
 - lib/opentelemetry/baggage.rb
 - lib/opentelemetry/baggage/builder.rb
 - lib/opentelemetry/baggage/entry.rb
-- lib/opentelemetry/baggage/manager.rb
-- lib/opentelemetry/baggage/noop_builder.rb
-- lib/opentelemetry/baggage/noop_manager.rb
 - lib/opentelemetry/baggage/propagation.rb
 - lib/opentelemetry/baggage/propagation/context_keys.rb
 - lib/opentelemetry/baggage/propagation/text_map_propagator.rb
@@ -185,16 +182,15 @@ files:
 - 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.17.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v1.0.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.17.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-api/v1.0.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/baggage/manager.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Baggage
-    # Operational Baggage Manager implementation
-    class Manager
-      BAGGAGE_KEY = OpenTelemetry::Baggage::Propagation::ContextKeys.baggage_key
-      EMPTY_BAGGAGE = {}.freeze
-      private_constant(:BAGGAGE_KEY, :EMPTY_BAGGAGE)
-
-      # Used to chain modifications to baggage. The result is a
-      # context with an updated baggage. If only a single
-      # modification is being made to baggage, use the other
-      # methods on +Manager+, if multiple modifications are being made, use
-      # this one.
-      #
-      # @param [optional Context] context The context to update with with new
-      #   modified baggage. Defaults to +Context.current+
-      # @return [Context]
-      def build(context: Context.current)
-        builder = Builder.new(baggage_for(context).dup)
-        yield builder
-        context.set_value(BAGGAGE_KEY, builder.entries)
-      end
-
-      # Returns a new context with empty baggage
-      #
-      # @param [optional Context] context Context to clear baggage from. Defaults
-      #   to +Context.current+
-      # @return [Context]
-      def clear(context: Context.current)
-        context.set_value(BAGGAGE_KEY, EMPTY_BAGGAGE)
-      end
-
-      # Returns the corresponding baggage.entry (or nil) for key
-      #
-      # @param [String] key The lookup key
-      # @param [optional Context] context The context from which to retrieve
-      #   the key.
-      #   Defaults to +Context.current+
-      # @return [String]
-      def value(key, context: Context.current)
-        baggage_for(context)[key]&.value
-      end
-
-      # Returns the baggage
-      #
-      # @param [optional Context] context The context from which to retrieve
-      #   the baggage.
-      #   Defaults to +Context.current+
-      # @return [Hash]
-      def values(context: Context.current)
-        baggage_for(context).transform_values(&:value)
-      end
-
-      # @api private
-      def raw_entries(context: Context.current)
-        baggage_for(context).dup.freeze
-      end
-
-      # Returns a new context with new key-value pair
-      #
-      # @param [String] key The key to store this value under
-      # @param [String] value String value to be stored under key
-      # @param [optional String] metadata This is here to store properties
-      #   received from other W3C Baggage impelmentations but is not exposed in
-      #   OpenTelemetry. This is condsidered private API and not for use by
-      #   end-users.
-      # @param [optional Context] context The context to update with new
-      #   value. Defaults to +Context.current+
-      # @return [Context]
-      def set_value(key, value, metadata: nil, context: Context.current)
-        new_baggage = baggage_for(context).dup
-        new_baggage[key] = Entry.new(value, metadata)
-        context.set_value(BAGGAGE_KEY, new_baggage)
-      end
-
-      # Returns a new context with value at key removed
-      #
-      # @param [String] key The key to remove
-      # @param [optional Context] context The context to remove baggage
-      #   from. Defaults to +Context.current+
-      # @return [Context]
-      def remove_value(key, context: Context.current)
-        baggage = baggage_for(context)
-        return context unless baggage.key?(key)
-
-        new_baggage = baggage.dup
-        new_baggage.delete(key)
-        context.set_value(BAGGAGE_KEY, new_baggage)
-      end
-
-      private
-
-      def baggage_for(context)
-        context.value(BAGGAGE_KEY) || EMPTY_BAGGAGE
-      end
-    end
-  end
-end

data/lib/opentelemetry/baggage/noop_builder.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Baggage
-    # No op implementation of Baggage::Builder
-    class NoopBuilder
-      def set_value(key, value, metadata: nil); end
-
-      def remove_value(key); end
-
-      def clear; end
-    end
-  end
-end

data/lib/opentelemetry/baggage/noop_manager.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Baggage
-    # No op implementation of Baggage::Manager
-    class NoopManager
-      NOOP_BUILDER = NoopBuilder.new
-      EMPTY_HASH = {}.freeze
-      private_constant(:NOOP_BUILDER, :EMPTY_HASH)
-
-      def build(context: Context.current)
-        yield NOOP_BUILDER
-        context
-      end
-
-      def set_value(key, value, metadata: nil, context: Context.current)
-        context
-      end
-
-      def value(key, context: Context.current)
-        nil
-      end
-
-      def values(context: Context.current)
-        EMPTY_HASH
-      end
-
-      def raw_entries(context: Context.current)
-        EMPTY_HASH
-      end
-
-      def remove_value(key, context: Context.current)
-        context
-      end
-
-      def clear(context: Context.current)
-        context
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Trace
-    module Util
-      # Convenience methods, not necessarily required by the API specification.
-      module HttpToStatus
-        # 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)
-          case code.to_i
-          when 100..399
-            new(const_get(:OK))
-          else
-            new(const_get(:ERROR))
-          end
-        end
-      end
-    end
-  end
-end