opentelemetry-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d222b778e1876c24a4bf0f71f30ec32ff23b75b28eaf6d436d2341123a044f31
-  data.tar.gz: 8d2eb94080371ad6bdcef6c14dbe0dd8cbc9355c1d395b7fe675cd64ed02f667
+  metadata.gz: fae25f56974c1b746cc24c2bd537c829b9bc0b510a0993c0d85f144ddacade73
+  data.tar.gz: e4e8c19fa73acaf36eac999e4d8f4eccd1769ec8b93e4ec712afcf69c2989975
 SHA512:
-  metadata.gz: 1f03bfb89f173d1c9a88f9027ca0c2bf29353330bf640ba3aeba8b68167e8c0d9a5d4d1aa6b50dfa728e5e3a90a64e25c5597e72e628bc918726f7dafbc15bea
-  data.tar.gz: 784998cd384e404a2b3f312fc5560482cfc2ddd942ea2e57216320898b33399f9e554f16de50af5987a60a9c3ddbd4b9847259ab42abfe76d8e4a50cf07c6367
+  metadata.gz: e62fcd38916931803cb8321a6bc8a4790943799156597d9b4c9c838075afeeb7fccbd7e5f05c63aaa52aa630dfcea0d04298ea37d52ff887650d4f802a1d7e75
+  data.tar.gz: c33752a751d7db605813ce1aa062650f3d2fd8db5f561e1a157e1a8a52af24b0f9d1ab54367486092524e86c9fff59eec9777152f03c646bdd1a6182923e8c88

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History: opentelemetry-sdk
 
+### v1.2.0 / 2022-09-14
+
+* ADDED: Support OTEL_PROPAGATORS=none 
+* ADDED: Support OTEL_ATTRIBUTE_{COUNT,VALUE_LENGTH}_LIMIT env vars 
+* ADDED: Support InstrumentationScope, and update OTLP proto to 0.18.0 
+* FIXED: SpanLimits setting event attributes length limit 
+
 ### v1.1.0 / 2022-05-26
 
 * BREAKING CHANGE: This requires upgrading both the SDK and Instrumentation gem in tandem

data/lib/opentelemetry/sdk/configurator.rb

@@ -141,11 +141,14 @@ module OpenTelemetry
         configure_span_processors
         tracer_provider.id_generator = @id_generator
         OpenTelemetry.tracer_provider = tracer_provider
+        metrics_configuration_hook
         install_instrumentation
       end
 
       private
 
+      def metrics_configuration_hook; end
+
       def tracer_provider
         @tracer_provider ||= Trace::TracerProvider.new(resource: @resource)
       end
@@ -169,7 +172,7 @@ module OpenTelemetry
         processors.each { |p| tracer_provider.add_span_processor(p) }
       end
 
-      def wrapped_exporters_from_env # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+      def wrapped_exporters_from_env # rubocop:disable Metrics/CyclomaticComplexity
         exporters = ENV.fetch('OTEL_TRACES_EXPORTER', 'otlp')
         exporters.split(',').map do |exporter|
           case exporter.strip
@@ -203,6 +206,7 @@ module OpenTelemetry
           when 'jaeger' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::Jaeger')
           when 'xray' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::XRay')
           when 'ottrace' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::OTTrace')
+          when 'none' then NoopTextMapPropagator.new
           else
             OpenTelemetry.logger.warn "The #{propagator} propagator is unknown and cannot be configured"
             NoopTextMapPropagator.new

data/lib/opentelemetry/sdk/instrumentation_library.rb

@@ -7,6 +7,7 @@
 module OpenTelemetry
   module SDK
     # InstrumentationLibrary is a struct containing library information for export.
+    # @deprecated Use InstrumentationScope instead.
     InstrumentationLibrary = Struct.new(:name,
                                         :version)
   end

data/lib/opentelemetry/sdk/instrumentation_scope.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # InstrumentationScope is a struct containing scope information for export.
+    InstrumentationScope = Struct.new(:name,
+                                      :version)
+  end
+end

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

@@ -30,10 +30,10 @@ module OpenTelemetry
           #
           # @param [SpanExporter] exporter the (duck type) SpanExporter to where the
           #   recorded Spans are pushed after batching.
-          # @param [Numeric] exporter_timeout the delay interval between two
-          #   consecutive exports. Defaults to the value of the OTEL_BSP_EXPORT_TIMEOUT
+          # @param [Numeric] exporter_timeout the maximum allowed time to export data.
+          #   Defaults to the value of the OTEL_BSP_EXPORT_TIMEOUT
           #   environment variable, if set, or 30,000 (30 seconds).
-          # @param [Numeric] schedule_delay the maximum allowed time to export data.
+          # @param [Numeric] schedule_delay the delay interval between two consecutive exports.
           #   Defaults to the value of the OTEL_BSP_SCHEDULE_DELAY environment
           #   variable, if set, or 5,000 (5 seconds).
           # @param [Integer] max_queue_size the maximum queue size in spans.
@@ -74,7 +74,7 @@ module OpenTelemetry
           def on_start(_span, _parent_context); end
 
           # Adds a span to the batch. Thread-safe; may block on lock.
-          def on_finish(span) # rubocop:disable Metrics/AbcSize
+          def on_finish(span)
             return unless span.context.trace_flags.sampled?
 
             lock do
@@ -100,7 +100,7 @@ module OpenTelemetry
           # @param [optional Numeric] timeout An optional timeout in seconds.
           # @return [Integer] SUCCESS if no error occurred, FAILURE if a
           #   non-specific failure occurred, TIMEOUT if a timeout occurred.
-          def force_flush(timeout: nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+          def force_flush(timeout: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
             start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
             snapshot = lock do
               reset_on_fork if @keep_running
@@ -155,7 +155,7 @@ module OpenTelemetry
 
           attr_reader :spans, :max_queue_size, :batch_size
 
-          def work # rubocop:disable Metrics/AbcSize
+          def work
             loop do
               batch = lock do
                 @condition.wait(@mutex, @delay_seconds) if spans.size < batch_size && @keep_running

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

@@ -23,7 +23,13 @@ module OpenTelemetry
 
         # The following readers are intended for the use of SpanProcessors and
         # should not be considered part of the public interface for instrumentation.
-        attr_reader :name, :status, :kind, :parent_span_id, :start_timestamp, :end_timestamp, :links, :resource, :instrumentation_library
+        attr_reader :name, :status, :kind, :parent_span_id, :start_timestamp, :end_timestamp, :links, :resource, :instrumentation_scope
+
+        # Returns an InstrumentationScope struct, which is backwards compatible with InstrumentationLibrary.
+        # @deprecated Please use instrumentation_scope instead.
+        #
+        # @return InstrumentationScope
+        alias instrumentation_library instrumentation_scope
 
         # Return a frozen copy of the current attributes. This is intended for
         # use of SpanProcessors and should not be considered part of the public
@@ -131,7 +137,7 @@ module OpenTelemetry
         #
         # @return [self] returns itself
         def add_event(name, attributes: nil, timestamp: nil)
-          event = Event.new(name, truncate_attribute_values(attributes), relative_timestamp(timestamp))
+          event = Event.new(name, truncate_attribute_values(attributes, @span_limits.event_attribute_length_limit), relative_timestamp(timestamp))
 
           @mutex.synchronize do
             if @ended
@@ -267,7 +273,7 @@ module OpenTelemetry
             @links,
             @events,
             @resource,
-            @instrumentation_library,
+            @instrumentation_scope,
             context.span_id,
             context.trace_id,
             context.trace_flags,
@@ -276,7 +282,7 @@ module OpenTelemetry
         end
 
         # @api private
-        def initialize(context, parent_context, parent_span, name, kind, parent_span_id, span_limits, span_processors, attributes, links, start_timestamp, resource, instrumentation_library) # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity, Metrics/MethodLength,  Metrics/PerceivedComplexity
+        def initialize(context, parent_context, parent_span, name, kind, parent_span_id, span_limits, span_processors, attributes, links, start_timestamp, resource, instrumentation_scope) # rubocop:disable  Metrics/CyclomaticComplexity, Metrics/MethodLength,  Metrics/PerceivedComplexity
           super(span_context: context)
           @mutex = Mutex.new
           @name = name
@@ -285,7 +291,7 @@ module OpenTelemetry
           @span_limits = span_limits
           @span_processors = span_processors
           @resource = resource
-          @instrumentation_library = instrumentation_library
+          @instrumentation_scope = instrumentation_scope
           @ended = false
           @status = DEFAULT_STATUS
           @total_recorded_events = 0
@@ -343,21 +349,19 @@ module OpenTelemetry
 
           excess = attrs.size - @span_limits.attribute_count_limit
           excess.times { attrs.shift } if excess.positive?
-          truncate_attribute_values(attrs)
+          truncate_attribute_values(attrs, @span_limits.attribute_length_limit)
           nil
         end
 
-        def truncate_attribute_values(attrs)
+        def truncate_attribute_values(attrs, attribute_length_limit)
           return EMPTY_ATTRIBUTES if attrs.nil?
-
-          attribute_length_limit = @span_limits.attribute_length_limit
           return attrs if attribute_length_limit.nil?
 
           attrs.transform_values! { |value| OpenTelemetry::Common::Utilities.truncate_attribute_value(value, attribute_length_limit) }
           attrs
         end
 
-        def trim_links(links, link_count_limit, link_attribute_count_limit) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def trim_links(links, link_count_limit, link_attribute_count_limit) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           # Fast path (likely) common cases.
           return nil if links.nil?
 
@@ -379,7 +383,7 @@ module OpenTelemetry
           end.freeze
         end
 
-        def append_event(events, event) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def append_event(events, event) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           event_count_limit = @span_limits.event_count_limit
           event_attribute_count_limit = @span_limits.event_attribute_count_limit
           valid_attributes = Internal.valid_attributes?(name, 'event', event.attributes)

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

@@ -23,7 +23,7 @@ module OpenTelemetry
                             :links,                     # optional Array[OpenTelemetry::Trace::Link]
                             :events,                    # optional Array[Event]
                             :resource,                  # OpenTelemetry::SDK::Resources::Resource
-                            :instrumentation_library,   # OpenTelemetry::SDK::InstrumentationLibrary
+                            :instrumentation_scope,     # OpenTelemetry::SDK::InstrumentationScope
                             :span_id,                   # String (8 byte binary)
                             :trace_id,                  # String (16-byte binary)
                             :trace_flags,               # Integer (8-bit byte of bit flags)
@@ -48,6 +48,12 @@ module OpenTelemetry
                               def hex_parent_span_id
                                 parent_span_id.unpack1('H*')
                               end
+
+                              # Returns an InstrumentationScope struct, which is backwards compatible with InstrumentationLibrary.
+                              # @deprecated Please use instrumentation_scope instead.
+                              #
+                              # @return InstrumentationScope
+                              alias_method :instrumentation_library, :instrumentation_scope
                             end
     end
   end

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

@@ -24,6 +24,9 @@ module OpenTelemetry
         # The global default max number of attributes per {OpenTelemetry::SDK::Trace::Event}.
         attr_reader :event_attribute_count_limit
 
+        # The global default max length of attribute value per {OpenTelemetry::SDK::Trace::Event}.
+        attr_reader :event_attribute_length_limit
+
         # The global default max number of attributes per {OpenTelemetry::Trace::Link}.
         attr_reader :link_attribute_count_limit
 
@@ -31,18 +34,20 @@ module OpenTelemetry
         #
         # @return [SpanLimits] with the desired values.
         # @raise [ArgumentError] if any of the max numbers are not positive.
-        def initialize(attribute_count_limit: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 128)), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-                       attribute_length_limit: ENV.fetch('OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT',
-                                                         ENV['OTEL_RUBY_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT']),
-                       event_count_limit: Integer(ENV.fetch('OTEL_SPAN_EVENT_COUNT_LIMIT', 128)),
-                       link_count_limit: Integer(ENV.fetch('OTEL_SPAN_LINK_COUNT_LIMIT', 128)),
-                       event_attribute_count_limit: Integer(ENV.fetch('OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT', 128)),
-                       link_attribute_count_limit: Integer(ENV.fetch('OTEL_LINK_ATTRIBUTE_COUNT_LIMIT', 128)))
+        def initialize(attribute_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 'OTEL_ATTRIBUTE_COUNT_LIMIT', default: 128)), # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+                       attribute_length_limit: OpenTelemetry::Common::Utilities.config_opt('OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT', 'OTEL_RUBY_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT', 'OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT'),
+                       event_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_SPAN_EVENT_COUNT_LIMIT', default: 128)),
+                       link_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_SPAN_LINK_COUNT_LIMIT', default: 128)),
+                       event_attribute_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT', default: 128)),
+                       event_attribute_length_limit: OpenTelemetry::Common::Utilities.config_opt('OTEL_EVENT_ATTRIBUTE_VALUE_LENGTH_LIMIT', 'OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT'),
+                       link_attribute_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_LINK_ATTRIBUTE_COUNT_LIMIT', default: 128)))
+
           raise ArgumentError, 'attribute_count_limit must be positive' unless attribute_count_limit.positive?
           raise ArgumentError, 'attribute_length_limit must not be less than 32' unless attribute_length_limit.nil? || Integer(attribute_length_limit) >= 32
           raise ArgumentError, 'event_count_limit must be positive' unless event_count_limit.positive?
           raise ArgumentError, 'link_count_limit must be positive' unless link_count_limit.positive?
           raise ArgumentError, 'event_attribute_count_limit must be positive' unless event_attribute_count_limit.positive?
+          raise ArgumentError, 'event_attribute_length_limit must not be less than 32' unless event_attribute_length_limit.nil? || Integer(event_attribute_length_limit) >= 32
           raise ArgumentError, 'link_attribute_count_limit must be positive' unless link_attribute_count_limit.positive?
 
           @attribute_count_limit = attribute_count_limit
@@ -50,6 +55,7 @@ module OpenTelemetry
           @event_count_limit = event_count_limit
           @link_count_limit = link_count_limit
           @event_attribute_count_limit = event_attribute_count_limit
+          @event_attribute_length_limit = event_attribute_length_limit.nil? ? nil : Integer(event_attribute_length_limit)
           @link_attribute_count_limit = link_attribute_count_limit
         end
 

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

@@ -19,7 +19,7 @@ module OpenTelemetry
         #
         # @return [Tracer]
         def initialize(name, version, tracer_provider)
-          @instrumentation_library = InstrumentationLibrary.new(name, version)
+          @instrumentation_scope = InstrumentationScope.new(name, version)
           @tracer_provider = tracer_provider
         end
 
@@ -29,16 +29,10 @@ module OpenTelemetry
 
         def start_span(name, with_parent: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
           name ||= 'empty'
-
+          kind ||= :internal
           with_parent ||= Context.current
-          parent_span = OpenTelemetry::Trace.current_span(with_parent)
-          parent_span_context = OpenTelemetry::Trace.current_span(with_parent).context
-          if parent_span_context.valid?
-            parent_span_id = parent_span_context.span_id
-            trace_id = parent_span_context.trace_id
-          end
 
-          @tracer_provider.internal_create_span(name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, with_parent, parent_span, @instrumentation_library)
+          @tracer_provider.internal_start_span(name, kind, attributes, links, start_timestamp, with_parent, @instrumentation_scope)
         end
       end
     end

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

@@ -126,15 +126,16 @@ module OpenTelemetry
         end
 
         # @api private
-        def internal_create_span(name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, parent_context, parent_span, instrumentation_library) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def internal_start_span(name, kind, attributes, links, start_timestamp, parent_context, instrumentation_scope) # rubocop:disable Metrics/MethodLength
+          parent_span = OpenTelemetry::Trace.current_span(parent_context)
           parent_span_context = parent_span.context
+
           if parent_span_context.valid?
             parent_span_id = parent_span_context.span_id
             trace_id = parent_span_context.trace_id
           end
-          name ||= 'empty'
+
           trace_id ||= @id_generator.generate_trace_id
-          kind ||= :internal
           result = @sampler.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
           span_id = @id_generator.generate_span_id
           if result.recording? && !@stopped
@@ -154,7 +155,7 @@ module OpenTelemetry
               links,
               start_timestamp,
               @resource,
-              instrumentation_library
+              instrumentation_scope
             )
           else
             OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, span_id: span_id, tracestate: result.tracestate))

data/lib/opentelemetry/sdk/version.rb

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

data/lib/opentelemetry/sdk.rb

@@ -78,6 +78,7 @@ require 'opentelemetry/sdk/configurator'
 require 'opentelemetry/sdk/forwarding_logger'
 require 'opentelemetry/sdk/internal'
 require 'opentelemetry/sdk/instrumentation_library'
+require 'opentelemetry/sdk/instrumentation_scope'
 require 'opentelemetry/sdk/resources'
 require 'opentelemetry/sdk/trace'
 require 'opentelemetry/sdk/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-semantic_conventions
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-zipkin
   requirement: !ruby/object:Gem::Requirement
@@ -264,6 +264,7 @@ files:
 - lib/opentelemetry/sdk/configurator.rb
 - lib/opentelemetry/sdk/forwarding_logger.rb
 - lib/opentelemetry/sdk/instrumentation_library.rb
+- lib/opentelemetry/sdk/instrumentation_scope.rb
 - lib/opentelemetry/sdk/internal.rb
 - lib/opentelemetry/sdk/resources.rb
 - lib/opentelemetry/sdk/resources/resource.rb
@@ -293,10 +294,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.1.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.2.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.1.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: