opentelemetry-sdk 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a170a385c24de9a417323b40bee2d07f8040bdf2535e08ee4f5cf3ac5ce440c
-  data.tar.gz: 8f2bf92d634725f8863e551522dc06e0ccb562e08b1741529cb1f3633cfd344b
+  metadata.gz: 83a673caf48821ecaaebd3bf954cc674b720eee1727eff03b5094ecd4338971c
+  data.tar.gz: 3fb2937947b640cc86e4ae7d56137bf4cf6683e4f11e378002a56ca8c45506d5
 SHA512:
-  metadata.gz: 652201b97d3ff1f384a0f101f882d7dbf1cbc8ab6e402a75d3a029784cef5e655cda907df6066d69e2af511933a59323f430ede8903c442d2f267f7cd9c52ac8
-  data.tar.gz: 91321cf005b589ffc0e2715d63ea03fad1369e8b3288a9f1493c3847e4f32077167d3cee31fc61fba35c6f8718bd5ac999e2ede13a521a8f6991eca6e7e393d9
+  metadata.gz: e3f0135a67fffcb1a50c8d7a639dcd9e02a2b7d8abe61ff9beb3553a2ed1e8d93fbbe08904b46fbbebaa0c913ae6acd3a88c93329168cf00be13f205511bc48f
+  data.tar.gz: 7197e47a5a52adabad0f651b3d7b7a9cc3f5b5f4792e64a20790efb69fc20315ab5fef322ff0798eb6e3ee6eb88e8b25429e5412657cc61fcb19496fbbe79de9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History: opentelemetry-sdk
 
+### v1.4.0 / 2024-01-25
+
+* ADDED: Add spans to Trace::ExportError
+
+### v1.3.2 / 2024-01-23
+
+* FIXED: Reduce allocations on GraphQL hot paths
+* FIXED: Add context to metrics reporting of buffer-full events
+
 ### v1.3.1 / 2023-11-02
 
 * FIXED: Spec compliance for span attribute limit

data/lib/opentelemetry/sdk/internal.rb

@@ -49,17 +49,17 @@ module OpenTelemetry
       end
 
       def valid_attributes?(owner, kind, attrs)
-        attrs.nil? || attrs.all? do |k, v|
+        attrs.nil? || attrs.each do |k, v|
           if !valid_key?(k)
             OpenTelemetry.handle_error(message: "invalid #{kind} attribute key type #{k.class} on span '#{owner}'")
-            false
+            return false
           elsif !valid_value?(v)
             OpenTelemetry.handle_error(message: "invalid #{kind} attribute value type #{v.class} for key '#{k}' on span '#{owner}'")
-            false
-          else
-            true
+            return false
           end
         end
+
+        true
       end
     end
   end

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

@@ -81,8 +81,8 @@ module OpenTelemetry
               reset_on_fork
               n = spans.size + 1 - max_queue_size
               if n.positive?
-                spans.shift(n)
-                report_dropped_spans(n, reason: 'buffer-full')
+                dropped_spans = spans.shift(n)
+                report_dropped_spans(dropped_spans, reason: 'buffer-full', function: __method__.to_s)
               end
               spans << span
               @condition.signal if spans.size > batch_size
@@ -110,7 +110,7 @@ module OpenTelemetry
               remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
               return TIMEOUT if remaining_timeout&.zero?
 
-              batch = snapshot.shift(@batch_size).map!(&:to_span_data)
+              batch = snapshot.shift(@batch_size)
               result_code = export_batch(batch, timeout: remaining_timeout)
               return result_code unless result_code == SUCCESS
             end
@@ -122,10 +122,10 @@ module OpenTelemetry
             lock do
               n = spans.size + snapshot.size - max_queue_size
               if n.positive?
-                snapshot.shift(n)
-                report_dropped_spans(n, reason: 'buffer-full')
+                dropped_spans = snapshot.shift(n)
+                report_dropped_spans(dropped_spans, reason: 'buffer-full', function: __method__.to_s)
               end
-              spans.unshift(snapshot) unless snapshot.empty?
+              spans.unshift(*snapshot) unless snapshot.empty?
               @condition.signal if spans.size > max_queue_size / 2
             end
           end
@@ -146,8 +146,8 @@ module OpenTelemetry
 
             thread&.join(timeout)
             force_flush(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
-            dropped_spans = lock { spans.size }
-            report_dropped_spans(dropped_spans, reason: 'terminating') if dropped_spans.positive?
+            dropped_spans = lock { spans.shift(spans.length) }
+            report_dropped_spans(dropped_spans, reason: 'terminating') if dropped_spans.any?
             @exporter.shutdown(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
           end
 
@@ -162,7 +162,7 @@ module OpenTelemetry
                 @condition.wait(@mutex, @delay_seconds) while spans.empty? && @keep_running
                 return unless @keep_running
 
-                fetch_batch
+                spans.shift(@batch_size)
               end
 
               @metrics_reporter.observe_value('otel.bsp.buffer_utilization', value: spans.size / max_queue_size.to_f)
@@ -183,33 +183,30 @@ module OpenTelemetry
             OpenTelemetry.handle_error(exception: e, message: 'unexpected error in BatchSpanProcessor#reset_on_fork')
           end
 
-          def export_batch(batch, timeout: @exporter_timeout_seconds)
+          def export_batch(span_array, timeout: @exporter_timeout_seconds)
+            batch = span_array.map(&:to_span_data)
             result_code = @export_mutex.synchronize { @exporter.export(batch, timeout: timeout) }
-            report_result(result_code, batch)
+            report_result(result_code, span_array)
             result_code
           rescue StandardError => e
-            report_result(FAILURE, batch)
+            report_result(FAILURE, span_array)
             @metrics_reporter.add_to_counter('otel.bsp.error', labels: { 'reason' => e.class.to_s })
             FAILURE
           end
 
-          def report_result(result_code, batch)
+          def report_result(result_code, span_array)
             if result_code == SUCCESS
               @metrics_reporter.add_to_counter('otel.bsp.export.success')
-              @metrics_reporter.add_to_counter('otel.bsp.exported_spans', increment: batch.size)
+              @metrics_reporter.add_to_counter('otel.bsp.exported_spans', increment: span_array.size)
             else
-              OpenTelemetry.handle_error(exception: ExportError.new("Unable to export #{batch.size} spans"))
+              OpenTelemetry.handle_error(exception: ExportError.new(span_array))
               @metrics_reporter.add_to_counter('otel.bsp.export.failure')
-              report_dropped_spans(batch.size, reason: 'export-failure')
+              report_dropped_spans(span_array, reason: 'export-failure')
             end
           end
 
-          def report_dropped_spans(count, reason:)
-            @metrics_reporter.add_to_counter('otel.bsp.dropped_spans', increment: count, labels: { 'reason' => reason })
-          end
-
-          def fetch_batch
-            spans.shift(@batch_size).map!(&:to_span_data)
+          def report_dropped_spans(dropped_spans, reason:, function: nil)
+            @metrics_reporter.add_to_counter('otel.bsp.dropped_spans', increment: dropped_spans.size, labels: { 'reason' => reason, OpenTelemetry::SemanticConventions::Trace::CODE_FUNCTION => function }.compact)
           end
 
           def lock

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

@@ -10,7 +10,19 @@ module OpenTelemetry
       # The Export module contains the built-in exporters and span processors for the OpenTelemetry
       # reference implementation.
       module Export
-        ExportError = Class.new(OpenTelemetry::Error)
+        # Raised when an export fails; spans are available via :spans accessor
+        class ExportError < OpenTelemetry::Error
+          # Returns the {Span} array for this exception
+          #
+          # @return [Array<OpenTelemetry::SDK::Trace::Span>]
+          attr_reader :spans
+
+          # @param [Array<OpenTelemetry::SDK::Trace::Span>] spans the array of spans that failed to export
+          def initialize(spans)
+            super("Unable to export #{spans.size} spans")
+            @spans = spans
+          end
+        end
 
         # Result codes for the SpanExporter#export method and the SpanProcessor#force_flush and SpanProcessor#shutdown methods.
 

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

@@ -282,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_scope) # rubocop:disable  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/MethodLength, Metrics/PerceivedComplexity
           super(span_context: context)
           @mutex = Mutex.new
           @name = name
@@ -297,7 +297,7 @@ module OpenTelemetry
           @total_recorded_events = 0
           @total_recorded_links = links&.size || 0
           @total_recorded_attributes = attributes&.size || 0
-          @attributes = attributes.nil? ? nil : Hash[attributes] # We need a mutable copy of attributes.
+          @attributes = attributes
           trim_span_attributes(@attributes)
           @events = nil
           @links = trim_links(links, span_limits.link_count_limit, span_limits.link_attribute_count_limit)
@@ -317,7 +317,7 @@ module OpenTelemetry
           # SpanData.
           @monotonic_start_timestamp = monotonic_now
           @realtime_start_timestamp = if parent_span.recording?
-                                        relative_realtime(parent_span.realtime_start_timestamp, parent_span.monotonic_start_timestamp)
+                                        relative_realtime(parent_span.realtime_start_timestamp, parent_span.monotonic_start_timestamp, @monotonic_start_timestamp)
                                       else
                                         realtime_now
                                       end
@@ -419,15 +419,15 @@ module OpenTelemetry
         def relative_timestamp(timestamp)
           return time_in_nanoseconds(timestamp) unless timestamp.nil?
 
-          relative_realtime(realtime_start_timestamp, monotonic_start_timestamp)
+          relative_realtime(realtime_start_timestamp, monotonic_start_timestamp, monotonic_now)
         end
 
         def time_in_nanoseconds(timestamp)
           (timestamp.to_r * 1_000_000_000).to_i
         end
 
-        def relative_realtime(realtime_base, monotonic_base)
-          realtime_base + (monotonic_now - monotonic_base)
+        def relative_realtime(realtime_base, monotonic_base, now)
+          realtime_base + (now - monotonic_base)
         end
 
         def realtime_now

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

@@ -141,7 +141,7 @@ module OpenTelemetry
           if result.recording? && !@stopped
             trace_flags = result.sampled? ? OpenTelemetry::Trace::TraceFlags::SAMPLED : OpenTelemetry::Trace::TraceFlags::DEFAULT
             context = OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, span_id: span_id, trace_flags: trace_flags, tracestate: result.tracestate)
-            attributes = attributes&.merge(result.attributes) || result.attributes
+            attributes = attributes&.merge(result.attributes) || result.attributes.dup
             Span.new(
               context,
               parent_context,

data/lib/opentelemetry/sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -294,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.3.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.4.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.3.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.4.0
 post_install_message: 
 rdoc_options: []
 require_paths: