opentelemetry-api 1.10.1 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 577b4d995e92df80c49e13b5995b56235170108a93fdf101b38e2de820412bee
-  data.tar.gz: 7d01b537dba1d74c3f151729511ce30c881382f7f3984fef38409678eb329aee
+  metadata.gz: 8f644a53d810a077cc3a490e49b8f4ae2b232557a51ff7764c5c137c4cf9065d
+  data.tar.gz: 5a8ce03439efaff86ae15ad66271700819b3331b94294b7e10b2a1bb8d89febe
 SHA512:
-  metadata.gz: 4ee45cb43c2e7ab4adb6ed95902d9921f63ce2cef8e4afdbea6ff24ece293f59f954a3f628d5a1d02c2a00367a2916e8034f4e2a2c5733d94603074cd1943822
-  data.tar.gz: 64e63c75db2dc7a5c7c5e0018aa4eff78d019d394026679c83fa07beb918999a037da5f3fe4b87c9b1ae5c61fc53bb8f4917c8a11949ee829cda96da54a32a10
+  metadata.gz: 64d8b2489ba3f982966be8edabaaf0d9ffb1b1e28657a5991f1abc84c06fb1228be7bee58a1d2cd432ff392a6abde2e54b6acfae7dc218b2f76f06e1d0166854
+  data.tar.gz: 1b2482b2cf3e8a6649b96a8f67c8e6fdd4da6c1ceaec08f7acd44b294763e55f0f9f6fc399738dabe476db61094a49c5bd98383d0f395d768d70b6ea63ac7ca7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History: opentelemetry-api
 
+### v1.11.1 / 2026-09-15
+
+* FIXED: Enforce W3C Baggage limits on the extract path (#2298)
+* DOCS: Document custom error handlers (#2264)
+
+### v1.11.0 / 2026-07-21
+
+* ADDED: Add attributes support to instrumentation scope for tracers (#2094)
+
 ### v1.10.1 / 2026-07-08
 
 * DOCS: Update source for gemspec links to RubyDoc (#2123)

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

@@ -55,17 +55,10 @@ module OpenTelemetry
           header = getter.get(carrier, BAGGAGE_KEY)
           return context if header.nil? || header.empty?
 
-          entries = header.gsub(/\s/, '').split(',')
+          entries = split_entries(header)
 
           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
-              # the properties (as-is) so that they can be propagated elsewhere.
-              kv, meta = entry.split(';', 2)
-              k, v = kv.split('=').map! { |part| URI.decode_uri_component(part) }
-              builder.set_value(k, v, metadata: meta)
-            end
+            decode_entries(entries, builder)
           end
         rescue StandardError => e
           OpenTelemetry.logger.debug "Error extracting W3C baggage: #{e.message}"
@@ -82,6 +75,38 @@ module OpenTelemetry
 
         private
 
+        def split_entries(header)
+          return header.split(',') if header.bytesize <= MAX_TOTAL_LENGTH
+
+          window = header.byteslice(0, MAX_TOTAL_LENGTH + 1)
+          last_separator = window.byterindex(',')
+          return [] unless last_separator
+
+          window.byteslice(0, last_separator).split(',')
+        end
+
+        def decode_entries(entries, builder)
+          decoded_length = 0
+          decoded_count = 0
+          entries.each do |raw_entry|
+            break unless decoded_count < MAX_ENTRIES
+
+            entry = raw_entry.gsub(/\s/, '')
+            next if entry.empty?
+            next unless entry.bytesize <= MAX_ENTRY_LENGTH &&
+                        entry.bytesize + decoded_length <= MAX_TOTAL_LENGTH
+
+            # Note metadata is currently unused in OpenTelemetry, but is part
+            # the W3C spec where it's referred to as properties. We preserve
+            # the properties (as-is) so that they can be propagated elsewhere.
+            kv, meta = entry.split(';', 2)
+            k, v = kv.split('=').map! { |part| URI.decode_uri_component(part) }
+            builder.set_value(k, v, metadata: meta)
+            decoded_length += entry.bytesize + 1
+            decoded_count += 1
+          end
+        end
+
         def encode(baggage)
           result = +''
           encoded_count = 0

data/lib/opentelemetry/context.rb

@@ -15,7 +15,7 @@ module OpenTelemetry # rubocop:disable Style/Documentation
     EMPTY_ENTRIES = {}.freeze
     private_constant :EMPTY_ENTRIES
 
-    DetachError = Class.new(OpenTelemetry::Error)
+    DetachError = Class.new(OpenTelemetry::Error) # rubocop:disable Style/EmptyClassDefinition
 
     class << self
       # Returns a key used to index a value in a Context
@@ -67,6 +67,7 @@ module OpenTelemetry # rubocop:disable Style/Documentation
       #
       # @param [Context] ctx The context to be made active
       # @yield [context] Yields context to the block
+      # @yieldparam [Context] context The active context
       def with_current(ctx)
         token = attach(ctx)
         yield ctx
@@ -79,9 +80,10 @@ module OpenTelemetry # rubocop:disable Style/Documentation
 
       # @param [String] key The lookup key
       # @param [Object] value The object stored under key
-      # @param [Callable] Block to execute in a new context
       # @yield [context, value] Yields the newly created context and value to
       #   the block
+      # @yieldparam [Context] context The newly created context
+      # @yieldparam [Object] value The object stored under key
       def with_value(key, value)
         ctx = current.set_value(key, value)
         token = attach(ctx)
@@ -93,12 +95,12 @@ module OpenTelemetry # rubocop:disable Style/Documentation
       # Execute a block in a new context where its values are merged with the
       # incoming values. Restores the previous context after the block executes.
 
-      # @param [String] key The lookup key
       # @param [Hash] values Will be merged with values of the current context
       #  and returned in a new context
-      # @param [Callable] Block to execute in a new context
       # @yield [context, values] Yields the newly created context and values
       #   to the block
+      # @yieldparam [Context] context The newly created context
+      # @yieldparam [Hash] values The values merged into the new context
       def with_values(values)
         ctx = current.set_values(values)
         token = attach(ctx)
@@ -119,6 +121,9 @@ module OpenTelemetry # rubocop:disable Style/Documentation
         Fiber.current.opentelemetry_context = []
       end
 
+      # Returns an empty context.
+      #
+      # @return [Context]
       def empty
         new(EMPTY_ENTRIES)
       end
@@ -160,7 +165,6 @@ module OpenTelemetry # rubocop:disable Style/Documentation
     #
     # @param [Hash] values The values to be merged with the current context's
     #   entries.
-    # @param [Object] value Object to be stored under key
     # @return [Context]
     def set_values(values) # rubocop:disable Naming/AccessorMethodName
       Context.new(@entries.merge(values))

data/lib/opentelemetry/internal/proxy_tracer_provider.rb

@@ -13,9 +13,22 @@ module OpenTelemetry
     # It delegates to a "real" TracerProvider after the global tracer provider is registered.
     # It returns {ProxyTracer} instances until the delegate is installed.
     class ProxyTracerProvider < Trace::TracerProvider
-      Key = Struct.new(:name, :version)
+      Key = Struct.new(:name, :version, :attributes)
       private_constant(:Key)
 
+      # Wraps a legacy TracerProvider whose `#tracer` method does not accept
+      # the `attributes:` keyword argument, dropping the argument on delegation.
+      class LegacyProviderWrapper
+        def initialize(legacy_provider)
+          @legacy_provider = legacy_provider
+        end
+
+        def tracer(name = nil, version = nil, attributes: nil)
+          @legacy_provider.tracer(name, version)
+        end
+      end
+      private_constant(:LegacyProviderWrapper)
+
       # Returns a new {ProxyTracerProvider} instance.
       #
       # @return [ProxyTracerProvider]
@@ -35,25 +48,45 @@ module OpenTelemetry
           return
         end
 
+        provider = LegacyProviderWrapper.new(provider) unless supports_attributes?(provider)
+
         @mutex.synchronize do
           @delegate = provider
-          @registry.each { |key, tracer| tracer.delegate = provider.tracer(key.name, key.version) }
+          @registry.each { |key, tracer| tracer.delegate = @delegate.tracer(key.name, key.version, attributes: key.attributes) }
         end
       end
 
       # Returns a {Tracer} instance.
       #
-      # @param [optional String] name Instrumentation package name
-      # @param [optional String] version Instrumentation package version
+      # Supports both positional arguments (legacy) and keyword arguments:
+      #   tracer('name', '1.0')                                    # legacy positional
+      #   tracer(name: 'name', version: '1.0', attributes: {...})  # keyword
+      #
+      # When both positional and keyword arguments are provided for the same
+      # parameter, the keyword argument takes precedence.
+      #
+      # @param [String] name Instrumentation scope name
+      # @param [String] version Instrumentation scope version
+      # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+      #   Instrumentation scope attributes
       #
       # @return [Tracer]
-      def tracer(name = nil, version = nil)
+      def tracer(deprecated_name = nil, deprecated_version = nil, name: nil, version: nil, attributes: nil)
+        name ||= deprecated_name
+        version ||= deprecated_version
         @mutex.synchronize do
-          return @delegate.tracer(name, version) unless @delegate.nil?
+          return @delegate.tracer(name, version, attributes: attributes) unless @delegate.nil?
 
-          @registry[Key.new(name, version)] ||= ProxyTracer.new
+          @registry[Key.new(name, version, attributes)] ||= ProxyTracer.new
         end
       end
+
+      private
+
+      def supports_attributes?(provider)
+        provider.respond_to?(:tracer) &&
+          provider.method(:tracer).parameters.any? { |_, n| n == :attributes }
+      end
     end
   end
 end

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

@@ -11,10 +11,12 @@ module OpenTelemetry
         # https://www.w3.org/TR/trace-context/
         # {Trace::SpanContext}
         class TraceParent
+          # rubocop:disable Style/EmptyClassDefinition
           InvalidFormatError = Class.new(Error)
           InvalidVersionError = Class.new(Error)
           InvalidTraceIDError = Class.new(Error)
           InvalidSpanIDError = Class.new(Error)
+          # rubocop:enable Style/EmptyClassDefinition
 
           TRACE_PARENT_HEADER = 'traceparent'
           SUPPORTED_VERSION = 0

data/lib/opentelemetry/trace/span.rb

@@ -93,7 +93,7 @@ module OpenTelemetry
       # documents} certain "standard attributes" that have prescribed semantic
       # meanings.
       #
-      # @param [OpenTelemetry::Trace::Link] the link object to add on the {Span}.
+      # @param [OpenTelemetry::Trace::Link] link The link object to add on the {Span}.
       #
       # @return [self] returns itself
       def add_link(link)

data/lib/opentelemetry/trace/trace_flags.rb

@@ -40,7 +40,7 @@ module OpenTelemetry
       #
       # @return [Boolean]
       def sampled?
-        (@flags & 1) != 0
+        @flags.anybits?(1)
       end
 
       DEFAULT = from_byte(0)

data/lib/opentelemetry/trace/tracer.rb

@@ -34,7 +34,7 @@ module OpenTelemetry
       def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, record_exception: true)
         span = nil
         span = start_span(name, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind)
-        Trace.with_span(span) { |s, c| yield s, c }
+        Trace.with_span(span) { |s, c| yield s, c } # rubocop:disable Style/ExplicitBlockArgument
       rescue Exception => e # rubocop:disable Lint/RescueException
         span&.record_exception(e) if record_exception
         span&.status = Status.error("Unhandled exception of type: #{e.class}")

data/lib/opentelemetry/trace/tracer_provider.rb

@@ -10,11 +10,20 @@ module OpenTelemetry
     class TracerProvider
       # Returns a {Tracer} instance.
       #
-      # @param [optional String] name Instrumentation package name
-      # @param [optional String] version Instrumentation package version
+      # Supports both positional arguments (legacy) and keyword arguments:
+      #   tracer('name', '1.0')                                    # legacy positional
+      #   tracer(name: 'name', version: '1.0', attributes: {...})  # keyword
+      #
+      # When both positional and keyword arguments are provided for the same
+      # parameter, the keyword argument takes precedence.
+      #
+      # @param [String] name Instrumentation scope name
+      # @param [String] version Instrumentation scope version
+      # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+      #   Instrumentation scope attributes
       #
       # @return [Tracer]
-      def tracer(name = nil, version = nil)
+      def tracer(deprecated_name = nil, deprecated_version = nil, name: nil, version: nil, attributes: nil)
         @tracer ||= Tracer.new
       end
     end

data/lib/opentelemetry/trace/tracestate.rb

@@ -75,7 +75,7 @@ module OpenTelemetry
       # @return [Tracestate]
       def initialize(hash)
         excess = hash.size - MAX_MEMBER_COUNT
-        hash = Hash[hash.drop(excess)] if excess.positive?
+        hash = hash.drop(excess).to_h if excess.positive?
         @hash = hash.freeze
       end
 
@@ -105,7 +105,7 @@ module OpenTelemetry
           return self
         end
 
-        h = Hash[@hash]
+        h = @hash.to_h.dup
         h[key] = value
         self.class.create(h)
       end
@@ -118,7 +118,7 @@ module OpenTelemetry
       def delete(key)
         return self unless @hash.key?(key)
 
-        h = Hash[@hash]
+        h = @hash.to_h.dup
         h.delete(key)
         self.class.create(h)
       end

data/lib/opentelemetry/trace.rb

@@ -53,8 +53,9 @@ module OpenTelemetry
     # 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
+    # @param [Span] span The span to store in the returned context.
+    # @param [Context] parent_context The optional 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

data/lib/opentelemetry/version.rb

@@ -6,5 +6,5 @@
 
 module OpenTelemetry
   ## Current OpenTelemetry version
-  VERSION = '1.10.1'
+  VERSION = '1.11.1'
 end

data/lib/opentelemetry.rb

@@ -24,13 +24,28 @@ module OpenTelemetry
   @mutex = Mutex.new
   @tracer_provider = Internal::ProxyTracerProvider.new
 
-  attr_writer :propagation, :logger, :error_handler
+  attr_writer :propagation, :logger
 
   # @return [Object, Logger] configured Logger or a default STDOUT Logger.
   def logger
     @logger ||= Logger.new($stdout, level: ENV['OTEL_LOG_LEVEL'] || Logger::INFO)
   end
 
+  # Configures error handler used by {handle_error}.
+  #
+  # Assigned object must respond to +#call+ and accept the keyword arguments
+  # +exception:+ and +message:+.
+  #
+  # @param [#call] error_handler The error handler to use
+  #
+  # @example Log OpenTelemetry errors with a custom prefix
+  #   OpenTelemetry.error_handler = lambda do |exception: nil, message: nil|
+  #     OpenTelemetry.logger.warn("otel: #{[message, exception&.message].compact.join(' - ')}")
+  #   end
+  def error_handler=(error_handler)
+    @error_handler = error_handler
+  end
+
   # @return [Callable] configured error handler or a default that logs the
   #   exception and message at ERROR level.
   def error_handler

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-api
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -88,10 +88,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-api/1.10.1/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-api/v1.10.1/api
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-api/1.11.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-api/v1.11.1/api
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-api/1.10.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-api/1.11.1
 rdoc_options: []
 require_paths:
 - lib
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A stats collection and distributed tracing framework
 test_files: []