opentelemetry-sdk 0.10.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dd502ccc29f875d2af8691a99945f9ff6fcea5505ec0541fffb9798cc8406ec
-  data.tar.gz: 32c4805d198ad93f29c8b51ebd0d0b2fa0c5d13b5bfc595c22b12762d954259a
+  metadata.gz: b64da58e8086f08efd2f7bace98369ec16936abcf95996588bda288a592d5912
+  data.tar.gz: 4d67cd982c51998cf0396531bcbaae6f62f23b89314793def72410624c87a645
 SHA512:
-  metadata.gz: 8a10fb701cec552ce95f61cdbc124dc82f962cbab938e8c41b897d23d5ad8f778b6487605d35d09876fa8259612cef6f570e8991ba8258dcd0ed2ef9af82040a
-  data.tar.gz: ec7430fe3bd0ab0f0999c9d22c5d6addbcb45bc37e31b2eb83cb9ddc492c900cf5bf5acd2721c5eadaf1f58caf358d8a0607d7a08aeec7a8de09569f9badb5be
+  metadata.gz: 3d8d0331a351e32cf184a512c155c6d3944bb5bbbb2857aad27636bdc7eca58081d45e6d778eecd50681e1a1c471c75f9cf7d8116b57ba5c5c5b7a5838f3a648
+  data.tar.gz: ef884f72a85e1457b1d160d2075313df169f895cfe92831d87e77022244db6b6d980f7a36f6c88926886fd67538e916c2e813728ce80aa2897ef24da216d2924

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Release History: opentelemetry-sdk
 
+### v0.13.0 / 2021-01-29
+
+* BREAKING CHANGE: Remove MILLIS from BatchSpanProcessor vars 
+
+* ADDED: Process.runtime resource 
+* ADDED: Provide default resource in SDK 
+* ADDED: Add optional attributes to record_exception 
+* FIXED: Resource.merge consistency 
+* FIXED: Remove MILLIS from BatchSpanProcessor vars 
+
+### 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 

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/README.md

@@ -66,8 +66,8 @@ The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LI
 [opentelemetry-home]: https://opentelemetry.io
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
-[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/examples
+[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
 [ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby

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 = []
@@ -27,13 +27,18 @@ module OpenTelemetry
         @text_map_injectors = nil
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
-        @resource = Resources::Resource.telemetry_sdk
+        @resource = Resources::Resource.default
+        @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.
@@ -41,7 +46,7 @@ module OpenTelemetry
       #
       # @param [Resource] new_resource The resource to be merged
       def resource=(new_resource)
-        @resource = new_resource.merge(@resource)
+        @resource = @resource.merge(new_resource)
       end
 
       # Accepts a string that is merged in as the service.name resource attribute.
@@ -49,9 +54,9 @@ module OpenTelemetry
       # calls to this setter.
       # @param [String] service_name The value to be used as the service name
       def service_name=(service_name)
-        @resource = OpenTelemetry::SDK::Resources::Resource.create(
+        self.resource = OpenTelemetry::SDK::Resources::Resource.create(
           OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:name] => service_name
-        ).merge(@resource)
+        )
       end
 
       # Accepts a string that is merged in as the service.version resource attribute.
@@ -59,9 +64,9 @@ module OpenTelemetry
       # calls to this setter.
       # @param [String] service_version The value to be used as the service version
       def service_version=(service_version)
-        @resource = OpenTelemetry::SDK::Resources::Resource.create(
+        self.resource = OpenTelemetry::SDK::Resources::Resource.create(
           OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:version] => service_version
-        ).merge(@resource)
+        )
       end
 
       # Install an instrumentation with specificied optional +config+.
@@ -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
 
@@ -77,6 +77,46 @@ module OpenTelemetry
           deployment_name: 'k8s.deployment.name'
         }.freeze
 
+        # Attributes defining an operating system process.
+        PROCESS_RESOURCE = {
+          # Process identifier (PID).
+          pid: 'process.pid',
+
+          # The name of the process executable.
+          executable_name: 'process.executable.name',
+
+          # The full path to the process executable.
+          executable_path: 'process.executable.path',
+
+          # The command used to launch the process (i.e. the command name).
+          command: 'process.command',
+
+          # The full command used to launch the process as a single string
+          # representing the full command.
+          command_line: 'process.command_line',
+
+          # All the command arguments (including the command/executable itself)
+          # as received by the process.
+          command_args: 'process.command_args',
+
+          # The username of the user that owns the process.
+          owner: 'process.owner'
+        }.freeze
+
+        # Attributes defining the single (language) runtime instance which is monitored.
+        PROCESS_RUNTIME_RESOURCE = {
+          # The name of the runtime of this process.
+          name: 'process.runtime.name',
+
+          # The version of the runtime of this process, as returned by the runtime
+          # without modification.
+          version: 'process.runtime.version',
+
+          # An additional description about the runtime of the process, for example
+          # a specific vendor customization of the runtime environment.
+          description: 'process.runtime.description'
+        }.freeze
+
         # Attributes defining a computing instance (e.g. host).
         HOST_RESOURCE = {
           # Unique host id. For Cloud this must be the instance_id assigned by the

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
@@ -30,6 +30,10 @@ module OpenTelemetry
             new(frozen_attributes)
           end
 
+          def default
+            @default ||= telemetry_sdk.merge(process).merge(create(Constants::SERVICE_RESOURCE[:name] => 'unknown_service'))
+          end
+
           def telemetry_sdk
             resource_attributes = {
               Constants::TELEMETRY_SDK_RESOURCE[:name] => 'opentelemetry',
@@ -48,6 +52,18 @@ module OpenTelemetry
             resource_attributes.delete_if { |_key, value| value.nil? || value.empty? }
             create(resource_attributes)
           end
+
+          def process
+            resource_attributes = {
+              Constants::PROCESS_RESOURCE[:pid] => Process.pid,
+              Constants::PROCESS_RESOURCE[:command] => $PROGRAM_NAME,
+              Constants::PROCESS_RUNTIME_RESOURCE[:name] => RUBY_ENGINE,
+              Constants::PROCESS_RUNTIME_RESOURCE[:version] => RUBY_VERSION,
+              Constants::PROCESS_RUNTIME_RESOURCE[:description] => RUBY_DESCRIPTION
+            }
+
+            create(resource_attributes)
+          end
         end
 
         # @api private
@@ -79,11 +95,7 @@ module OpenTelemetry
         def merge(other)
           return self unless other.is_a?(Resource)
 
-          merged_attributes = attributes.merge(other.attributes) do |_, old_v, new_v|
-            old_v.empty? ? new_v : old_v
-          end
-
-          self.class.send(:new, merged_attributes.freeze)
+          self.class.send(:new, attributes.merge(other.attributes).freeze)
         end
 
         protected

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
 
@@ -19,7 +19,7 @@ module OpenTelemetry
         # All spans reported by the SDK implementation are first added to a
         # synchronized queue (with a {max_queue_size} maximum size, after the
         # size is reached spans are dropped) and exported every
-        # schedule_delay_millis to the exporter pipeline in batches of
+        # schedule_delay to the exporter pipeline in batches of
         # max_export_batch_size.
         #
         # If the queue gets half full a preemptive notification is sent to the
@@ -29,11 +29,11 @@ module OpenTelemetry
           # Returns a new instance of the {BatchSpanProcessor}.
           #
           # @param [SpanExporter] exporter
-          # @param [Numeric] exporter_timeout_millis the delay interval between two
-          #   consecutive exports. Defaults to the value of the OTEL_BSP_EXPORT_TIMEOUT_MILLIS
+          # @param [Numeric] exporter_timeout the delay interval between two
+          #   consecutive exports. Defaults to the value of the OTEL_BSP_EXPORT_TIMEOUT
           #   environment variable, if set, or 30,000 (30 seconds).
-          # @param [Numeric] schedule_delay_millis the maximum allowed time to export data.
-          #   Defaults to the value of the OTEL_BSP_SCHEDULE_DELAY_MILLIS environment
+          # @param [Numeric] schedule_delay the maximum allowed time to export data.
+          #   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.
           #   Defaults to the value of the OTEL_BSP_MAX_QUEUE_SIZE environment
@@ -44,22 +44,24 @@ module OpenTelemetry
           #
           # @return a new instance of the {BatchSpanProcessor}.
           def initialize(exporter:,
-                         exporter_timeout_millis: Float(ENV.fetch('OTEL_BSP_EXPORT_TIMEOUT_MILLIS', 30_000)),
-                         schedule_delay_millis: Float(ENV.fetch('OTEL_BSP_SCHEDULE_DELAY_MILLIS', 5_000)),
+                         exporter_timeout: Float(ENV.fetch('OTEL_BSP_EXPORT_TIMEOUT', 30_000)),
+                         schedule_delay: Float(ENV.fetch('OTEL_BSP_SCHEDULE_DELAY', 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
-            @exporter_timeout_seconds = exporter_timeout_millis / 1000.0
+            @exporter_timeout_seconds = exporter_timeout / 1000.0
             @mutex = Mutex.new
             @export_mutex = Mutex.new
             @condition = ConditionVariable.new
             @keep_running = true
-            @delay_seconds = schedule_delay_millis / 1000.0
+            @delay_seconds = schedule_delay / 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
 

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

@@ -19,12 +19,20 @@ module OpenTelemetry
             @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:)
             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
 

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,6 +20,10 @@ module OpenTelemetry
             @description = format('TraceIdRatioBased{%.6f}', probability)
           end
 
+          def ==(other)
+            @description == other.description
+          end
+
           # @api private
           #
           # See {Samplers}.

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
 
@@ -120,15 +120,20 @@ module OpenTelemetry
         # can be recorded on a span.
         #
         # @param [Exception] exception The exception to be recorded
+        # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
+        #   attributes One or more key:value pairs, where the keys must be
+        #   strings and the values may be (array of) string, boolean or numeric
+        #   type.
         #
         # @return [void]
-        def record_exception(exception)
-          add_event('exception',
-                    attributes: {
-                      'exception.type' => exception.class.to_s,
-                      'exception.message' => exception.message,
-                      'exception.stacktrace' => exception.full_message(highlight: false, order: :top)
-                    })
+        def record_exception(exception, attributes: nil)
+          event_attributes = {
+            'exception.type' => exception.class.to_s,
+            'exception.message' => exception.message,
+            'exception.stacktrace' => exception.full_message(highlight: false, order: :top)
+          }
+          event_attributes.merge!(attributes) unless attributes.nil?
+          add_event('exception', attributes: event_attributes)
         end
 
         # Sets the Status to the Span
@@ -199,7 +204,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 +274,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 +310,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 +324,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
 
@@ -42,7 +42,7 @@ module OpenTelemetry
             parent_span_id = parent_span_context.span_id
             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, with_parent)
@@ -50,10 +50,11 @@ module OpenTelemetry
 
         private
 
-        def internal_create_span(result, name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, 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: result.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,
@@ -70,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.10.0'
+    VERSION = '0.13.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.13.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-01-30 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.10.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.13.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.10.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/sdk
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.13.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/v0.10.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.13.0
 post_install_message: 
 rdoc_options: []
 require_paths: