opentelemetry-sdk 0.9.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92bb8c4a7792c37eb367fc10a3093b3fe27339592bc8689cdac308f21ba8ffa7
-  data.tar.gz: 2a0b6df150bbf2cb0987d1d4e5aa29fb37323bb740786ee2171e3ae037ff60ac
+  metadata.gz: '079e4ea0a93345e6e014c3f7760425e042544ae619cf5761cb08813dac99a728'
+  data.tar.gz: f36464e88c42bd56a60060854da46daa42b35b720619201ed30e8a038ea567c7
 SHA512:
-  metadata.gz: 59acf74f4d8cd4d4b1b7206690b6b0ddff389e98a76d151eb3cc08b97168af5c876a67a537123d81f2a3c7e65e3d52aea07f502bff02b7f8736863c8d299587e
-  data.tar.gz: b99ebe6b214387d35d530d01d154f017cb5ae9ea11f6922773c12d1b2fa2807a1051d5d3f021816ad6970d152794ccb1b2e9af37c46b5fde768d4c8574d8833b
+  metadata.gz: 7305bdedc102299c04c3c0798d9137fc74919e4edd3eb37a4b239c739218274427b82f925d97cdcdebd192559033f025a6cad2f729f5d05c5856b6aa6e9e2170
+  data.tar.gz: efcd32dc9aa6c9e260b05829d790c294308e08bc7ca275647c33f54b03ac463a63da7962a9038917c6fe3571ae10dc61efaa09dfc17eb5bfae4ed040719a8c80

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Release History: opentelemetry-sdk
 
+### v0.12.1 / 2021-01-13
+
+* FIXED: Fix several BatchSpanProcessor errors related to fork safety 
+* FIXED: Define default value for traceid ratio 
+
+### v0.12.0 / 2020-12-24
+
+* ADDED: Structured error handling 
+* ADDED: Pluggable ID generation 
+* FIXED: BSP dropped span buffer full reporting 
+* FIXED: Implement SDK environment variables 
+* FIXED: Remove incorrect TODO 
+
+### v0.11.1 / 2020-12-16
+
+* FIXED: BSP dropped span buffer full reporting 
+
+### v0.11.0 / 2020-12-11
+
+* ADDED: Metrics reporting from trace export 
+* FIXED: Copyright comments to not reference year 
+
+### v0.10.0 / 2020-12-03
+
+* BREAKING CHANGE: Allow samplers to modify tracestate 
+
+* FIXED: Allow samplers to modify tracestate 
+
 ### v0.9.0 / 2020-11-27
 
 * BREAKING CHANGE: Pass full Context to samplers 

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/lib/opentelemetry-sdk.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/sdk.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -18,6 +18,11 @@ module OpenTelemetry
   module SDK
     extend self
 
+    # 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)
+
     # Configures SDK and instrumentation
     #
     # @yieldparam [Configurator] configurator Yields a configurator to the
@@ -57,6 +62,12 @@ module OpenTelemetry
       configurator = Configurator.new
       yield configurator if block_given?
       configurator.configure
+    rescue StandardError
+      begin
+        raise ConfigurationError
+      rescue ConfigurationError => e
+        OpenTelemetry.handle_error(exception: e, message: 'unexpected configuration error')
+      end
     end
   end
 end

data/lib/opentelemetry/sdk/baggage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/sdk/baggage/builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/sdk/baggage/manager.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/sdk/configurator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -16,7 +16,7 @@ module OpenTelemetry
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
       attr_writer :logger, :http_extractors, :http_injectors, :text_map_extractors,
-                  :text_map_injectors
+                  :text_map_injectors, :error_handler, :id_generator
 
       def initialize
         @instrumentation_names = []
@@ -28,12 +28,17 @@ module OpenTelemetry
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
         @resource = Resources::Resource.telemetry_sdk
+        @id_generator = OpenTelemetry::Trace
       end
 
       def logger
         @logger ||= OpenTelemetry.logger
       end
 
+      def error_handler
+        @error_handler ||= OpenTelemetry.error_handler
+      end
+
       # Accepts a resource object that is merged with the default telemetry sdk
       # resource. The use of this method is optional, and is provided as means
       # to include additional resource information.
@@ -110,9 +115,11 @@ module OpenTelemetry
       #   - install instrumentation
       def configure
         OpenTelemetry.logger = logger
+        OpenTelemetry.error_handler = error_handler
         OpenTelemetry.baggage = Baggage::Manager.new
         configure_propagation
         configure_span_processors
+        tracer_provider.id_generator = @id_generator
         OpenTelemetry.tracer_provider = tracer_provider
         install_instrumentation
       end

data/lib/opentelemetry/sdk/instrumentation_library.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/sdk/internal.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -45,7 +45,17 @@ module OpenTelemetry
       end
 
       def valid_attributes?(attrs)
-        attrs.nil? || attrs.all? { |k, v| valid_key?(k) && valid_value?(v) }
+        attrs.nil? || attrs.all? do |k, v|
+          if !valid_key?(k)
+            OpenTelemetry.handle_error(message: "invalid attribute key type #{v.class}")
+            false
+          elsif !valid_value?(v)
+            OpenTelemetry.handle_error(message: "invalid attribute value type #{v.class}")
+            false
+          else
+            true
+          end
+        end
       end
     end
   end

data/lib/opentelemetry/sdk/resources.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -22,7 +22,7 @@ module OpenTelemetry
           def create(attributes = {})
             frozen_attributes = attributes.each_with_object({}) do |(k, v), memo|
               raise ArgumentError, 'attribute keys must be strings' unless k.is_a?(String)
-              raise ArgumentError, 'attribute values must be strings, integers, floats, or booleans' unless Internal.valid_value?(v)
+              raise ArgumentError, 'attribute values must be (array of) strings, integers, floats, or booleans' unless Internal.valid_value?(v)
 
               memo[-k] = v.freeze
             end.freeze

data/lib/opentelemetry/sdk/trace.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/sdk/trace/config/trace_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -10,20 +10,6 @@ module OpenTelemetry
       module Config
         # Class that holds global trace parameters.
         class TraceConfig
-          DEFAULT_SAMPLER = Samplers.parent_based(root: Samplers::ALWAYS_ON)
-          DEFAULT_MAX_ATTRIBUTES_COUNT = 32
-          DEFAULT_MAX_EVENTS_COUNT = 128
-          DEFAULT_MAX_LINKS_COUNT = 32
-          DEFAULT_MAX_ATTRIBUTES_PER_EVENT = 32
-          DEFAULT_MAX_ATTRIBUTES_PER_LINK = 32
-
-          private_constant(:DEFAULT_SAMPLER,
-                           :DEFAULT_MAX_ATTRIBUTES_COUNT,
-                           :DEFAULT_MAX_EVENTS_COUNT,
-                           :DEFAULT_MAX_LINKS_COUNT,
-                           :DEFAULT_MAX_ATTRIBUTES_PER_EVENT,
-                           :DEFAULT_MAX_ATTRIBUTES_PER_LINK)
-
           # The global default sampler (see {Samplers}).
           attr_reader :sampler
 
@@ -46,12 +32,12 @@ module OpenTelemetry
           #
           # @return [TraceConfig] with the desired values.
           # @raise [ArgumentError] if any of the max numbers are not positive.
-          def initialize(sampler: DEFAULT_SAMPLER,
-                         max_attributes_count: DEFAULT_MAX_ATTRIBUTES_COUNT,
-                         max_events_count: DEFAULT_MAX_EVENTS_COUNT,
-                         max_links_count: DEFAULT_MAX_LINKS_COUNT,
-                         max_attributes_per_event: DEFAULT_MAX_ATTRIBUTES_PER_EVENT,
-                         max_attributes_per_link: DEFAULT_MAX_ATTRIBUTES_PER_LINK)
+          def initialize(sampler: sampler_from_environment(Samplers.parent_based(root: Samplers::ALWAYS_ON)),
+                         max_attributes_count: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 1000)),
+                         max_events_count: Integer(ENV.fetch('OTEL_SPAN_EVENT_COUNT_LIMIT', 1000)),
+                         max_links_count: Integer(ENV.fetch('OTEL_SPAN_LINK_COUNT_LIMIT', 1000)),
+                         max_attributes_per_event: max_attributes_count,
+                         max_attributes_per_link: max_attributes_count)
             raise ArgumentError, 'max_attributes_count must be positive' unless max_attributes_count.positive?
             raise ArgumentError, 'max_events_count must be positive' unless max_events_count.positive?
             raise ArgumentError, 'max_links_count must be positive' unless max_links_count.positive?
@@ -67,6 +53,22 @@ module OpenTelemetry
           end
 
           # TODO: from_proto
+          private
+
+          def sampler_from_environment(default_sampler) # rubocop:disable Metrics/CyclomaticComplexity
+            case ENV['OTEL_TRACE_SAMPLER']
+            when 'always_on' then Samplers::ALWAYS_ON
+            when 'always_off' then Samplers::ALWAYS_OFF
+            when 'traceidratio' then Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACE_SAMPLER_ARG', 1.0)))
+            when 'parentbased_always_on' then Samplers.parent_based(root: Samplers::ALWAYS_ON)
+            when 'parentbased_always_off' then Samplers.parent_based(root: Samplers::ALWAYS_OFF)
+            when 'parentbased_traceidratio' then Samplers.parent_based(root: Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACE_SAMPLER_ARG', 1.0))))
+            else default_sampler
+            end
+          rescue StandardError => e
+            OpenTelemetry.handle_error(exception: e, message: "installing default sampler #{default_sampler.description}")
+            default_sampler
+          end
 
           # The default {TraceConfig}.
           DEFAULT = new

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -30,6 +30,7 @@ end
 require 'opentelemetry/sdk/trace/export/batch_span_processor'
 require 'opentelemetry/sdk/trace/export/console_span_exporter'
 require 'opentelemetry/sdk/trace/export/in_memory_span_exporter'
+require 'opentelemetry/sdk/trace/export/metrics_reporter'
 require 'opentelemetry/sdk/trace/export/multi_span_exporter'
 require 'opentelemetry/sdk/trace/export/noop_span_exporter'
 require 'opentelemetry/sdk/trace/export/simple_span_processor'

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -48,7 +48,8 @@ module OpenTelemetry
                          schedule_delay_millis: Float(ENV.fetch('OTEL_BSP_SCHEDULE_DELAY_MILLIS', 5_000)),
                          max_queue_size: Integer(ENV.fetch('OTEL_BSP_MAX_QUEUE_SIZE', 2048)),
                          max_export_batch_size: Integer(ENV.fetch('OTEL_BSP_MAX_EXPORT_BATCH_SIZE', 512)),
-                         start_thread_on_boot: String(ENV['OTEL_RUBY_BSP_START_THREAD_ON_BOOT']) !~ /false/i)
+                         start_thread_on_boot: String(ENV['OTEL_RUBY_BSP_START_THREAD_ON_BOOT']) !~ /false/i,
+                         metrics_reporter: nil)
             raise ArgumentError if max_export_batch_size > max_queue_size
 
             @exporter = exporter
@@ -60,6 +61,7 @@ module OpenTelemetry
             @delay_seconds = schedule_delay_millis / 1000.0
             @max_queue_size = max_queue_size
             @batch_size = max_export_batch_size
+            @metrics_reporter = metrics_reporter || OpenTelemetry::SDK::Trace::Export::MetricsReporter
             @spans = []
             @pid = nil
             @thread = nil
@@ -76,7 +78,10 @@ module OpenTelemetry
             lock do
               reset_on_fork
               n = spans.size + 1 - max_queue_size
-              spans.shift(n) if n.positive?
+              if n.positive?
+                spans.shift(n)
+                report_dropped_spans(n, reason: 'buffer-full')
+              end
               spans << span
               @condition.signal if spans.size > batch_size
             end
@@ -93,10 +98,10 @@ 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
+          def force_flush(timeout: nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
             start_time = Time.now
             snapshot = lock do
-              reset_on_fork(restart_thread: false) if @keep_running
+              reset_on_fork if @keep_running
               spans.shift(spans.size)
             end
             until snapshot.empty?
@@ -114,7 +119,10 @@ module OpenTelemetry
             # the snapshot because they're older than any spans in the spans buffer.
             lock do
               n = spans.size + snapshot.size - max_queue_size
-              snapshot.shift(n) if n.positive?
+              if n.positive?
+                snapshot.shift(n)
+                report_dropped_spans(n, reason: 'buffer-full')
+              end
               spans.unshift(snapshot) unless snapshot.empty?
               @condition.signal if spans.size > max_queue_size / 2
             end
@@ -128,24 +136,26 @@ module OpenTelemetry
           #   non-specific failure occurred, TIMEOUT if a timeout occurred.
           def shutdown(timeout: nil)
             start_time = Time.now
-            lock do
+            thread = lock do
               @keep_running = false
               @condition.signal
+              @thread
             end
 
-            @thread.join(timeout)
+            thread&.join(timeout)
             force_flush(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
             @exporter.shutdown(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?
           end
 
           private
 
           attr_reader :spans, :max_queue_size, :batch_size
 
-          def work
+          def work # rubocop:disable Metrics/AbcSize
             loop do
               batch = lock do
-                reset_on_fork(restart_thread: false)
                 @condition.wait(@mutex, @delay_seconds) if spans.size < batch_size && @keep_running
                 @condition.wait(@mutex, @delay_seconds) while spans.empty? && @keep_running
                 return unless @keep_running
@@ -153,6 +163,8 @@ module OpenTelemetry
                 fetch_batch
               end
 
+              @metrics_reporter.observe_value('otel.bsp.buffer_utilization', value: spans.size / max_queue_size.to_f)
+
               export_batch(batch)
             end
           end
@@ -163,7 +175,7 @@ module OpenTelemetry
 
             @pid = pid
             spans.clear
-            @thread = Thread.new { work } if restart_thread
+            @thread = restart_thread ? Thread.new { work } : nil
           end
 
           def export_batch(batch, timeout: @exporter_timeout_seconds)
@@ -173,7 +185,18 @@ module OpenTelemetry
           end
 
           def report_result(result_code, batch)
-            OpenTelemetry.logger.error("Unable to export #{batch.size} spans") unless result_code == SUCCESS
+            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)
+            else
+              OpenTelemetry.handle_error(message: "Unable to export #{batch.size} spans")
+              @metrics_reporter.add_to_counter('otel.bsp.export.failure')
+              report_dropped_spans(batch.size, 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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Trace
+      module Export
+        # MetricsReporter defines an interface used for reporting metrics from
+        # span processors (like the BatchSpanProcessor) and exporters. It can
+        # be used to report metrics such as dropped spans, and successful and
+        # failed export attempts. This exists to decouple the Trace SDK from
+        # the unstable OpenTelemetry Metrics API. An example implementation in
+        # terms of StatsD is:
+        #
+        #   module MetricsReporter
+        #     def add_to_counter(metric, increment: 1, labels: {})
+        #       StatsD.increment(metric, increment, labels, no_prefix: true)
+        #     end
+        #     def record_value(metric, value:, labels: {})
+        #       StatsD.distribution(metric, value, labels, no_prefix: true)
+        #     end
+        #     def observe_value(metric, value:, labels: {})
+        #       StatsD.gauge(metric, value, labels, no_prefix: true)
+        #     end
+        #   end
+        module MetricsReporter
+          extend self
+
+          # Adds an increment to a metric with the provided labels.
+          #
+          # @param [String] metric The metric name.
+          # @param [optional Numeric] increment An optional increment to report.
+          # @param [optional Hash<String, String>] labels Optional labels to
+          #   associate with the metric.
+          def add_to_counter(metric, increment: 1, labels: {}); end
+
+          # Records a value for a metric with the provided labels.
+          #
+          # @param [String] metric The metric name.
+          # @param [Numeric] value The value to report.
+          # @param [optional Hash<String, String>] labels Optional labels to
+          #   associate with the metric.
+          def record_value(metric, value:, labels: {}); end
+
+          # Observes a value for a metric with the provided labels.
+          #
+          # @param [String] metric The metric name.
+          # @param [Numeric] value The value to observe.
+          # @param [optional Hash<String, String>] labels Optional labels to
+          #   associate with the metric.
+          def observe_value(metric, value:, labels: {}); end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -57,7 +57,7 @@ module OpenTelemetry
 
             @span_exporter&.export([span.to_span_data])
           rescue => e # rubocop:disable Style/RescueStandardError
-            OpenTelemetry.logger.error("unexpected error in span.on_finish - #{e}")
+            OpenTelemetry.handle_error(exception: e, message: 'unexpected error in span.on_finish')
           end
 
           # Export all ended spans to the configured `Exporter` that have not yet

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -38,18 +38,11 @@ module OpenTelemetry
       #   to the {Span} to be created. Can be nil.
       # @return [Result] The sampling result.
       module Samplers
-        RECORD_AND_SAMPLE = Result.new(decision: Decision::RECORD_AND_SAMPLE)
-        DROP = Result.new(decision: Decision::DROP)
-        RECORD_ONLY = Result.new(decision: Decision::RECORD_ONLY)
-        SAMPLING_HINTS = [Decision::DROP, Decision::RECORD_ONLY, Decision::RECORD_AND_SAMPLE].freeze
-
-        private_constant(:RECORD_AND_SAMPLE, :DROP, :RECORD_ONLY, :SAMPLING_HINTS)
-
         # Returns a {Result} with {Decision::RECORD_AND_SAMPLE}.
-        ALWAYS_ON = ConstantSampler.new(result: RECORD_AND_SAMPLE, description: 'AlwaysOnSampler')
+        ALWAYS_ON = ConstantSampler.new(decision: Decision::RECORD_AND_SAMPLE, description: 'AlwaysOnSampler')
 
         # Returns a {Result} with {Decision::DROP}.
-        ALWAYS_OFF = ConstantSampler.new(result: DROP, description: 'AlwaysOffSampler')
+        ALWAYS_OFF = ConstantSampler.new(decision: Decision::DROP, description: 'AlwaysOffSampler')
 
         # Returns a new sampler. It delegates to samplers according to the following rules:
         #

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

@@ -10,22 +10,29 @@ module OpenTelemetry
       module Samplers
         # @api private
         #
-        # Implements a sampler returning a constant result.
+        # Implements a sampler returning a result with a constant decision.
         class ConstantSampler
           attr_reader :description
 
-          def initialize(result:, description:)
-            @result = result
+          def initialize(decision:, description:)
+            @decision = decision
             @description = description
           end
 
+          def ==(other)
+            @decision == other.decision && @description == other.description
+          end
+
           # @api private
           #
           # See {Samplers}.
           def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
-            # All arguments ignored for sampling decision.
-            @result
+            Result.new(decision: @decision, tracestate: OpenTelemetry::Trace.current_span(parent_context).context.tracestate)
           end
+
+          protected
+
+          attr_reader :decision
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -26,6 +26,14 @@ module OpenTelemetry
             @local_parent_not_sampled = local_parent_not_sampled
           end
 
+          def ==(other)
+            @root == other.root &&
+              @remote_parent_sampled == other.remote_parent_sampled &&
+              @remote_parent_not_sampled == other.remote_parent_not_sampled &&
+              @local_parent_sampled == other.local_parent_sampled &&
+              @local_parent_not_sampled == other.local_parent_not_sampled
+          end
+
           # @api private
           #
           # See {Samplers}.
@@ -47,6 +55,10 @@ module OpenTelemetry
                        end
             delegate.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
           end
+
+          protected
+
+          attr_reader :root, :remote_parent_sampled, :remote_parent_not_sampled, :local_parent_sampled, :local_parent_not_sampled
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -17,11 +17,16 @@ module OpenTelemetry
           DECISIONS = [Decision::RECORD_ONLY, Decision::DROP, Decision::RECORD_AND_SAMPLE].freeze
           private_constant(:EMPTY_HASH, :DECISIONS)
 
-          # Returns a frozen hash of attributes to be attached span.
+          # Returns a frozen hash of attributes to be attached to the span.
           #
           # @return [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
           attr_reader :attributes
 
+          # Returns a Tracestate to be associated with the span.
+          #
+          # @return [Tracestate]
+          attr_reader :tracestate
+
           # Returns a new sampling result with the specified decision and
           # attributes.
           #
@@ -30,9 +35,15 @@ module OpenTelemetry
           # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
           #   attributes A frozen or freezable hash containing attributes to be
           #   attached to the span.
-          def initialize(decision:, attributes: nil)
+          # @param [Tracestate] tracestate A Tracestate that will be associated
+          #   with the Span through the new SpanContext. If the sampler returns
+          #   an empty Tracestate here, the Tracestate will be cleared, so
+          #   samplers SHOULD normally return the passed-in Tracestate if they
+          #   do not intend to change it.
+          def initialize(decision:, attributes: nil, tracestate:)
             @decision = decision
             @attributes = attributes.freeze || EMPTY_HASH
+            @tracestate = tracestate
           end
 
           # Returns true if this span should be sampled.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -20,16 +20,19 @@ module OpenTelemetry
             @description = format('TraceIdRatioBased{%.6f}', probability)
           end
 
+          def ==(other)
+            @description == other.description
+          end
+
           # @api private
           #
           # See {Samplers}.
           def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
-            # Ignored for sampling decision: parent_context:, links, name, kind, attributes.
-
+            tracestate = OpenTelemetry::Trace.current_span(parent_context).context.tracestate
             if sample?(trace_id)
-              RECORD_AND_SAMPLE
+              Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: tracestate)
             else
-              DROP
+              Result.new(decision: Decision::DROP, tracestate: tracestate)
             end
           end
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -199,7 +199,7 @@ module OpenTelemetry
               return self
             end
             @end_timestamp = end_timestamp || Time.now
-            @attributes.freeze
+            @attributes = validated_attributes(@attributes).freeze
             @events.freeze
             @ended = true
           end
@@ -269,12 +269,16 @@ module OpenTelemetry
 
         private
 
+        def validated_attributes(attrs)
+          return attrs if Internal.valid_attributes?(attrs)
+
+          attrs.keep_if { |key, value| Internal.valid_key?(key) && Internal.valid_value?(value) }
+        end
+
         def trim_span_attributes(attrs)
           return if attrs.nil?
 
           excess = attrs.size - @trace_config.max_attributes_count
-          # TODO: with Ruby 2.5, replace with the more efficient
-          # attrs.shift(excess) if excess.positive?
           excess.times { attrs.shift } if excess.positive?
           nil
         end
@@ -301,11 +305,12 @@ module OpenTelemetry
         def append_event(events, event) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           max_events_count = @trace_config.max_events_count
           max_attributes_per_event = @trace_config.max_attributes_per_event
+          valid_attributes = Internal.valid_attributes?(event.attributes)
 
           # Fast path (likely) common case.
           if events.size < max_events_count &&
              event.attributes.size <= max_attributes_per_event &&
-             Internal.valid_attributes?(event.attributes)
+             valid_attributes
             return events << event
           end
 
@@ -314,7 +319,7 @@ module OpenTelemetry
           events.shift(excess) if excess.positive?
 
           excess = event.attributes.size - max_attributes_per_event
-          if excess.positive? || !Internal.valid_attributes?(event.attributes)
+          if excess.positive? || !valid_attributes
             attrs = Hash[event.attributes] # 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 - max_attributes_per_event

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -40,21 +40,21 @@ module OpenTelemetry
           parent_span_context = OpenTelemetry::Trace.current_span(with_parent).context
           if parent_span_context.valid?
             parent_span_id = parent_span_context.span_id
-            tracestate = parent_span_context.tracestate
             trace_id = parent_span_context.trace_id
           end
-          trace_id ||= OpenTelemetry::Trace.generate_trace_id
+          trace_id ||= tracer_provider.id_generator.generate_trace_id
           sampler = tracer_provider.active_trace_config.sampler
           result = sampler.should_sample?(trace_id: trace_id, parent_context: with_parent, links: links, name: name, kind: kind, attributes: attributes)
-          internal_create_span(result, name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, tracestate, with_parent)
+          internal_create_span(result, name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, with_parent)
         end
 
         private
 
-        def internal_create_span(result, name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, tracestate, parent_context) # rubocop:disable Metrics/AbcSize
+        def internal_create_span(result, name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, parent_context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          span_id = tracer_provider.id_generator.generate_span_id
           if result.recording? && !tracer_provider.stopped?
             trace_flags = result.sampled? ? OpenTelemetry::Trace::TraceFlags::SAMPLED : OpenTelemetry::Trace::TraceFlags::DEFAULT
-            context = OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, trace_flags: trace_flags, tracestate: tracestate)
+            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
             Span.new(
               context,
@@ -71,7 +71,7 @@ module OpenTelemetry
               @instrumentation_library
             )
           else
-            OpenTelemetry::Trace::Span.new(span_context: OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id))
+            OpenTelemetry::Trace::Span.new(span_context: OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, span_id: span_id, tracestate: result.tracestate))
           end
         end
       end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -12,7 +12,7 @@ module OpenTelemetry
         Key = Struct.new(:name, :version)
         private_constant(:Key)
 
-        attr_accessor :active_trace_config
+        attr_accessor :active_trace_config, :id_generator
         attr_reader :active_span_processor, :stopped, :resource
         alias stopped? stopped
 
@@ -24,6 +24,7 @@ module OpenTelemetry
           @registry = {}
           @active_span_processor = NoopSpanProcessor.instance
           @active_trace_config = Config::TraceConfig::DEFAULT
+          @id_generator = OpenTelemetry::Trace
           @registered_span_processors = []
           @stopped = false
           @resource = resource

data/lib/opentelemetry/sdk/version.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module SDK
     ## Current OpenTelemetry version
-    VERSION = '0.9.0'
+    VERSION = '0.12.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +180,7 @@ files:
 - lib/opentelemetry/sdk/trace/export/batch_span_processor.rb
 - lib/opentelemetry/sdk/trace/export/console_span_exporter.rb
 - lib/opentelemetry/sdk/trace/export/in_memory_span_exporter.rb
+- lib/opentelemetry/sdk/trace/export/metrics_reporter.rb
 - lib/opentelemetry/sdk/trace/export/multi_span_exporter.rb
 - lib/opentelemetry/sdk/trace/export/noop_span_exporter.rb
 - lib/opentelemetry/sdk/trace/export/simple_span_processor.rb
@@ -200,10 +201,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/v0.9.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.12.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.9.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.12.1
 post_install_message: 
 rdoc_options: []
 require_paths: