opentelemetry-sdk 1.12.1 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669386368dd472621a23b59729c2f3dc99922866a87b91d88ff244803e5a8eb9
-  data.tar.gz: d7d0216e2c302e33bd021d44853b93f91b371d3a0b55049ce218cdba3ac76e95
+  metadata.gz: 96d1d6f8f41f39408208c7fa58c1ba8617bb9249106bf8391eeb266c2d38362e
+  data.tar.gz: 03b8f1119d65b37cbe3098407b46d0753adbbe52e634a328bfbd5565ab341a22
 SHA512:
-  metadata.gz: e590e765a30272482a56cf3de76ae778fbc8218648ec4b8920ae274e39f2a7e57dc501ec13cbb1bbe8dce767306f6f1250538122f7745e133d4a89a7e8b17ed6
-  data.tar.gz: 8a2d22ae1202b742a5284eddf4cc9e4cca16fd19f76abec30cef8a54cb9a242803bf1c2643a713656b1b370abd3884d74aa091dc04780ae614c3c81680749510
+  metadata.gz: b2feacbff16ce07fcbbbda0e040d08c1eb8db2fec25804d8d9a849ed4597c2e4f7f64c5c3700cad5d6fbdfcd30ca3f397e5d3341d5e318b2f6c9a74aef8dd94a
+  data.tar.gz: 007725376c74f995289bc476a34905fb0a37334ebb86b370ad5631621a8558ae25dde2e8e693b3d04bf64b45c8cce170215fb55b4381b8f56f698ff7b511867f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-sdk
 
+### v1.13.1 / 2026-09-15
+
+* DOCS: Document custom error handlers (#2264)
+
+### v1.13.0 / 2026-07-21
+
+* ADDED: Add attributes support to instrumentation scope for tracers (#2094)
+
 ### v1.12.1 / 2026-07-08
 
 * DOCS: Update source for gemspec links to RubyDoc (#2123)

data/README.md

@@ -97,5 +97,5 @@ The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LI
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
-[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[community-meetings]: https://github.com/open-telemetry/community/blob/main/README.md#calendar
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/sdk/configurator.rb

@@ -14,12 +14,15 @@ module OpenTelemetry
         EMPTY_LIST = [].freeze
         private_constant(:EMPTY_LIST)
 
+        # No-op because this propagator does not inject any values.
         def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter); end
 
+        # Returns the passed context unchanged because there is nothing to extract.
         def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
           context
         end
 
+        # Returns an empty list because this propagator does not use carrier fields.
         def fields
           EMPTY_LIST
         end
@@ -31,7 +34,7 @@ module OpenTelemetry
 
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
-      attr_writer :propagators, :error_handler, :id_generator
+      attr_writer :propagators, :id_generator
 
       def initialize
         @instrumentation_names = []
@@ -43,6 +46,7 @@ module OpenTelemetry
         @id_generator = OpenTelemetry::Trace
       end
 
+      # Returns the configured logger or the global OpenTelemetry logger.
       def logger
         @logger ||= OpenTelemetry.logger
       end
@@ -56,6 +60,26 @@ module OpenTelemetry
         @logger = ForwardingLogger.new(new_logger, level: ENV['OTEL_LOG_LEVEL'] || Logger::INFO)
       end
 
+      # Configures the error handler that will be installed on
+      # OpenTelemetry during SDK configuration.
+      #
+      # Assigned object must respond to +#call+ and accept the keyword
+      # arguments +exception:+ and +message:+.
+      #
+      # @param [#call] error_handler The error handler to install
+      #
+      # @example Configure a custom error handler during SDK setup
+      #   OpenTelemetry::SDK.configure do |c|
+      #     c.error_handler = lambda do |exception: nil, message: nil|
+      #       OpenTelemetry.logger.warn("otel: #{[message, exception&.message].compact.join(' - ')}")
+      #     end
+      #   end
+      # rubocop:disable-next Style/TrivialAccessors
+      def error_handler=(error_handler)
+        @error_handler = error_handler
+      end
+
+      # Returns the configured error handler or the global OpenTelemetry error handler.
       def error_handler
         @error_handler ||= OpenTelemetry.error_handler
       end
@@ -190,11 +214,11 @@ module OpenTelemetry
           when 'otlp'
             otlp_protocol = ENV['OTEL_EXPORTER_OTLP_TRACES_PROTOCOL'] || ENV['OTEL_EXPORTER_OTLP_PROTOCOL'] || 'http/protobuf'
 
-            if otlp_protocol != 'http/protobuf'
+            if otlp_protocol == 'http/protobuf'
+              fetch_exporter(exporter, 'OpenTelemetry::Exporter::OTLP::Exporter')
+            else
               OpenTelemetry.logger.warn "The #{otlp_protocol} transport protocol is not supported by the OTLP exporter, spans will not be exported."
               nil
-            else
-              fetch_exporter(exporter, 'OpenTelemetry::Exporter::OTLP::Exporter')
             end
           when 'jaeger' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::Jaeger::CollectorExporter')
           when 'zipkin' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::Zipkin::Exporter')

data/lib/opentelemetry/sdk/instrumentation_scope.rb

@@ -8,6 +8,7 @@ module OpenTelemetry
   module SDK
     # InstrumentationScope is a struct containing scope information for export.
     InstrumentationScope = Struct.new(:name,
-                                      :version)
+                                      :version,
+                                      :attributes)
   end
 end

data/lib/opentelemetry/sdk/internal.rb

@@ -34,7 +34,7 @@ module OpenTelemetry
 
         case value.first
         when String
-          value.all? { |v| v.instance_of?(String) }
+          value.all?(String)
         when TrueClass, FalseClass
           value.all? { |v| boolean?(v) }
         when Numeric

data/lib/opentelemetry/sdk/resources/resource.rb

@@ -13,9 +13,9 @@ module OpenTelemetry
         class << self
           private :new
 
-          # Returns a newly created {Resource} with the specified attributes
+          # Returns a newly created Resource with the specified attributes
           #
-          # @param [Hash{String => String, Numeric, Boolean} attributes Hash of key-value pairs to be used
+          # @param [Hash{String => String, Numeric, Boolean}] attributes Hash of key-value pairs to be used
           #   as attributes for this resource
           # @raise [ArgumentError] If attribute keys and values are not strings
           # @return [Resource]
@@ -30,10 +30,16 @@ module OpenTelemetry
             new(frozen_attributes)
           end
 
+          # Returns the default Resource for the current process and SDK.
+          #
+          # @return [Resource]
           def default
             @default ||= create(SemanticConventions::Resource::SERVICE_NAME => 'unknown_service').merge(process).merge(telemetry_sdk).merge(service_name_from_env)
           end
 
+          # Returns a Resource describing this telemetry SDK.
+          #
+          # @return [Resource]
           def telemetry_sdk
             resource_attributes = {
               SemanticConventions::Resource::TELEMETRY_SDK_NAME => 'opentelemetry',
@@ -53,6 +59,9 @@ module OpenTelemetry
             create(resource_attributes)
           end
 
+          # Returns a Resource describing the current process.
+          #
+          # @return [Resource]
           def process
             resource_attributes = {
               SemanticConventions::Resource::PROCESS_PID => Process.pid,
@@ -75,7 +84,7 @@ module OpenTelemetry
 
         # @api private
         # The constructor is private and only for use internally by the class.
-        # Users should use the {create} factory method to obtain a {Resource}
+        # Users should use the {create} factory method to obtain a Resource
         # instance.
         #
         # @param [Hash<String, String>] frozen_attributes Frozen-hash of frozen-string
@@ -85,15 +94,15 @@ module OpenTelemetry
           @attributes = frozen_attributes
         end
 
-        # Returns an enumerator for attributes of this {Resource}
+        # Returns an enumerator for attributes of this Resource
         #
         # @return [Enumerator]
         def attribute_enumerator
           @attribute_enumerator ||= attributes.to_enum
         end
 
-        # Returns a new, merged {Resource} by merging the current {Resource} with
-        # the other {Resource}. In case of a collision, the other {Resource}
+        # Returns a new, merged Resource by merging the current Resource with
+        # the other Resource. In case of a collision, the other Resource
         # takes precedence
         #
         # @param [Resource] other The other resource to merge

data/lib/opentelemetry/sdk/trace/export/batch_span_processor.rb

@@ -210,6 +210,7 @@ module OpenTelemetry
           end
 
           def lock
+            # rubocop:disable-next Style/ExplicitBlockArgument
             @mutex.synchronize do
               yield
             end

data/lib/opentelemetry/sdk/trace/samplers/trace_id_ratio_based.rb

@@ -39,9 +39,8 @@ module OpenTelemetry
           private
 
           def sample?(trace_id)
-            # rubocop:disable Lint/FloatComparison
+            # rubocop:disable-next Lint/FloatComparison
             @probability == 1.0 || trace_id[8, 8].unpack1('Q>') < @id_upper_bound
-            # rubocop:enable Lint/FloatComparison
           end
         end
       end

data/lib/opentelemetry/sdk/trace/span.rb

@@ -14,7 +14,7 @@ module OpenTelemetry
       # Instrumentation should use the API provided by {OpenTelemetry::Trace::Span}
       # and should consider {Span} to be write-only.
       #
-      # rubocop:disable Metrics/ClassLength
+      # rubocop:disable-next Metrics/ClassLength
       class Span < OpenTelemetry::Trace::Span
         DEFAULT_STATUS = OpenTelemetry::Trace::Status.unset
         EMPTY_ATTRIBUTES = {}.freeze
@@ -133,7 +133,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)
@@ -418,7 +418,7 @@ module OpenTelemetry
           excess_link_count = valid_links.size - link_count_limit
           valid_links.pop(excess_link_count) if excess_link_count.positive?
           valid_links.map! do |link|
-            attrs = Hash[link.attributes] # link.attributes is frozen, so we need an unfrozen copy to adjust.
+            attrs = link.attributes.to_h.dup # link.attributes is frozen, so we need an unfrozen copy to adjust.
             attrs.keep_if { |key, value| Internal.valid_key?(key) && Internal.valid_value?(value) }
             excess = attrs.size - link_attribute_count_limit
             excess.times { attrs.shift } if excess.positive?
@@ -444,7 +444,7 @@ module OpenTelemetry
 
           excess = event.attributes.size - event_attribute_count_limit
           if excess.positive? || !valid_attributes
-            attrs = Hash[event.attributes] # event.attributes is frozen, so we need an unfrozen copy to adjust.
+            attrs = event.attributes.to_h.dup # event.attributes is frozen, so we need an unfrozen copy to adjust.
             attrs.keep_if { |key, value| Internal.valid_key?(key) && Internal.valid_value?(value) }
             excess = attrs.size - event_attribute_count_limit
             excess.times { attrs.shift } if excess.positive?
@@ -475,7 +475,6 @@ module OpenTelemetry
           Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/opentelemetry/sdk/trace/tracer.rb

@@ -13,13 +13,15 @@ module OpenTelemetry
         #
         # Returns a new {Tracer} instance.
         #
-        # @param [String] name Instrumentation package name
-        # @param [String] version Instrumentation package version
+        # @param [String] name Instrumentation scope name
+        # @param [String] version Instrumentation scope version
         # @param [TracerProvider] tracer_provider TracerProvider that initialized the tracer
+        # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+        #   Instrumentation scope attributes
         #
         # @return [Tracer]
-        def initialize(name, version, tracer_provider)
-          @instrumentation_scope = InstrumentationScope.new(name, version)
+        def initialize(name, version, tracer_provider, attributes: nil)
+          @instrumentation_scope = InstrumentationScope.new(name, version, attributes || {}.freeze)
           @tracer_provider = tracer_provider
         end
 

data/lib/opentelemetry/sdk/trace/tracer_provider.rb

@@ -9,8 +9,10 @@ module OpenTelemetry
     module Trace
       # {TracerProvider} is the SDK implementation of {OpenTelemetry::Trace::TracerProvider}.
       class TracerProvider < OpenTelemetry::Trace::TracerProvider # rubocop:disable Metrics/ClassLength
-        Key = Struct.new(:name, :version)
-        private_constant(:Key)
+        Key = Struct.new(:name, :version, :attributes)
+        EMPTY_ATTRIBUTES = {}.freeze
+
+        private_constant(:Key, :EMPTY_ATTRIBUTES)
 
         attr_accessor :span_limits, :id_generator, :sampler
         attr_reader :resource
@@ -44,15 +46,28 @@ module OpenTelemetry
 
         # 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)
-          name ||= ''
-          version ||= ''
+        def tracer(deprecated_name = nil, deprecated_version = nil, name: nil, version: nil, attributes: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          name ||= deprecated_name || ''
+          version ||= deprecated_version || ''
+          attributes = attributes&.dup&.freeze || EMPTY_ATTRIBUTES
           OpenTelemetry.logger.warn 'calling TracerProvider#tracer without providing a tracer name.' if name.empty?
-          @registry_mutex.synchronize { @registry[Key.new(name, version)] ||= Tracer.new(name, version, self) }
+          @registry_mutex.synchronize do
+            @registry[Key.new(name, version, attributes)] ||=
+              Tracer.new(name, version, self, attributes: attributes)
+          end
         end
 
         # Attempts to stop all the activity for this {TracerProvider}. Calls

data/lib/opentelemetry/sdk/version.rb

@@ -7,6 +7,6 @@
 module OpenTelemetry
   module SDK
     ## Current OpenTelemetry version
-    VERSION = '1.12.1'
+    VERSION = '1.13.1'
   end
 end

data/lib/opentelemetry/sdk.rb

@@ -23,7 +23,7 @@ module OpenTelemetry
     # ConfigurationError is an exception type used to wrap configuration errors
     # passed to OpenTelemetry.error_handler. This can be used to distinguish
     # errors reported during SDK configuration.
-    ConfigurationError = Class.new(OpenTelemetry::Error)
+    ConfigurationError = Class.new(OpenTelemetry::Error) # rubocop:disable Style/EmptyClassDefinition
 
     # Configures SDK and instrumentation
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.13.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -125,10 +125,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-sdk/1.12.1/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-sdk/v1.12.1/sdk
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-sdk/1.13.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-sdk/v1.13.1/sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-sdk/1.12.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-sdk/1.13.1
 rdoc_options: []
 require_paths:
 - lib
@@ -143,7 +143,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: []