opentelemetry-sdk 0.14.0 → 1.0.0.rc2

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

@@ -10,24 +10,24 @@ module OpenTelemetry
     # implementation.
     module Trace
       # SpanData is a Struct containing {Span} data for export.
-      SpanData = Struct.new(:name,
-                            :kind,
-                            :status,
-                            :parent_span_id,
-                            :total_recorded_attributes,
-                            :total_recorded_events,
-                            :total_recorded_links,
-                            :start_timestamp,
-                            :end_timestamp,
-                            :attributes,
-                            :links,
-                            :events,
-                            :resource,
-                            :instrumentation_library,
-                            :span_id,
-                            :trace_id,
-                            :trace_flags,
-                            :tracestate) do
+      SpanData = Struct.new(:name,                      # String
+                            :kind,                      # Symbol: :internal, :producer, :consumer, :client, :server
+                            :status,                    # Status
+                            :parent_span_id,            # String (8 byte binary), may be OpenTelemetry::Trace::INVALID_SPAN_ID
+                            :total_recorded_attributes, # Integer
+                            :total_recorded_events,     # Integer
+                            :total_recorded_links,      # Integer
+                            :start_timestamp,           # Integer nanoseconds since Epoch
+                            :end_timestamp,             # Integer nanoseconds since Epoch
+                            :attributes,                # optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}
+                            :links,                     # optional Array[OpenTelemetry::Trace::Link]
+                            :events,                    # optional Array[Event]
+                            :resource,                  # OpenTelemetry::SDK::Resources::Resource
+                            :instrumentation_library,   # OpenTelemetry::SDK::InstrumentationLibrary
+                            :span_id,                   # String (8 byte binary)
+                            :trace_id,                  # String (16-byte binary)
+                            :trace_flags,               # Integer (8-bit byte of bit flags)
+                            :tracestate) do             # OpenTelemetry::Trace::Tracestate
                               # Returns the lowercase [hex encoded](https://tools.ietf.org/html/rfc4648#section-8) span ID.
                               #
                               # @return [String] A 16-hex-character lowercase string.
@@ -41,6 +41,13 @@ module OpenTelemetry
                               def hex_trace_id
                                 trace_id.unpack1('H*')
                               end
+
+                              # Returns the lowercase [hex encoded](https://tools.ietf.org/html/rfc4648#section-8) parent span ID.
+                              #
+                              # @return [String] A 16-hex-character lowercase string.
+                              def hex_parent_span_id
+                                parent_span_id.unpack1('H*')
+                              end
                             end
     end
   end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Trace
+      # Class that holds global trace parameters.
+      class SpanLimits
+        # The global default max number of attributes per {Span}.
+        attr_reader :attribute_count_limit
+
+        # The global default max length of attribute value per {Span}.
+        attr_reader :attribute_length_limit
+
+        # The global default max number of {OpenTelemetry::SDK::Trace::Event}s per {Span}.
+        attr_reader :event_count_limit
+
+        # The global default max number of {OpenTelemetry::Trace::Link} entries per {Span}.
+        attr_reader :link_count_limit
+
+        # The global default max number of attributes per {OpenTelemetry::SDK::Trace::Event}.
+        attr_reader :attribute_per_event_count_limit
+
+        # The global default max number of attributes per {OpenTelemetry::Trace::Link}.
+        attr_reader :attribute_per_link_count_limit
+
+        # Returns a {SpanLimits} with the desired values.
+        #
+        # @return [SpanLimits] with the desired values.
+        # @raise [ArgumentError] if any of the max numbers are not positive.
+        def initialize(attribute_count_limit: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 128)), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+                       attribute_length_limit: ENV['OTEL_RUBY_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT'],
+                       event_count_limit: Integer(ENV.fetch('OTEL_SPAN_EVENT_COUNT_LIMIT', 128)),
+                       link_count_limit: Integer(ENV.fetch('OTEL_SPAN_LINK_COUNT_LIMIT', 128)),
+                       attribute_per_event_count_limit: attribute_count_limit,
+                       attribute_per_link_count_limit: attribute_count_limit)
+          raise ArgumentError, 'attribute_count_limit must be positive' unless attribute_count_limit.positive?
+          raise ArgumentError, 'attribute_length_limit must not be less than 32' unless attribute_length_limit.nil? || Integer(attribute_length_limit) >= 32
+          raise ArgumentError, 'event_count_limit must be positive' unless event_count_limit.positive?
+          raise ArgumentError, 'link_count_limit must be positive' unless link_count_limit.positive?
+          raise ArgumentError, 'attribute_per_event_count_limit must be positive' unless attribute_per_event_count_limit.positive?
+          raise ArgumentError, 'attribute_per_link_count_limit must be positive' unless attribute_per_link_count_limit.positive?
+
+          @attribute_count_limit = attribute_count_limit
+          @attribute_length_limit = attribute_length_limit.nil? ? nil : Integer(attribute_length_limit)
+          @event_count_limit = event_count_limit
+          @link_count_limit = link_count_limit
+          @attribute_per_event_count_limit = attribute_per_event_count_limit
+          @attribute_per_link_count_limit = attribute_per_link_count_limit
+        end
+
+        # The default {SpanLimits}.
+        DEFAULT = new
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/trace/{noop_span_processor.rb → span_processor.rb}

@@ -4,17 +4,14 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require 'singleton'
-
 module OpenTelemetry
   module SDK
     module Trace
-      # NoopSpanProcessor is a singleton implementation of the duck type
-      # SpanProcessor that provides synchronous no-op hooks for when a
-      # {Span} is started or when a {Span} is ended.
-      class NoopSpanProcessor
-        include Singleton
-
+      # SpanProcessor describes a duck type and provides synchronous no-op hooks for when a
+      # {Span} is started or when a {Span} is ended. It is not required to subclass this
+      # class to provide an implementation of SpanProcessor, provided the interface is
+      # satisfied.
+      class SpanProcessor
         # Called when a {Span} is started, if the {Span#recording?}
         # returns true.
         #

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

@@ -9,10 +9,6 @@ module OpenTelemetry
     module Trace
       # {Tracer} is the SDK implementation of {OpenTelemetry::Trace::Tracer}.
       class Tracer < OpenTelemetry::Trace::Tracer
-        attr_reader :name
-        attr_reader :version
-        attr_reader :tracer_provider
-
         # @api private
         #
         # Returns a new {Tracer} instance.
@@ -23,8 +19,6 @@ module OpenTelemetry
         #
         # @return [Tracer]
         def initialize(name, version, tracer_provider)
-          @name = name
-          @version = version
           @instrumentation_library = InstrumentationLibrary.new(name, version)
           @tracer_provider = tracer_provider
         end
@@ -42,37 +36,7 @@ module OpenTelemetry
             parent_span_id = parent_span_context.span_id
             trace_id = parent_span_context.trace_id
           end
-          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)
-        end
-
-        private
-
-        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, span_id: span_id, trace_flags: trace_flags, tracestate: result.tracestate)
-            attributes = attributes&.merge(result.attributes) || result.attributes
-            Span.new(
-              context,
-              parent_context,
-              name,
-              kind,
-              parent_span_id,
-              tracer_provider.active_trace_config,
-              tracer_provider.active_span_processor,
-              attributes,
-              links,
-              start_timestamp || Time.now,
-              tracer_provider.resource,
-              @instrumentation_library
-            )
-          else
-            OpenTelemetry::Trace::Span.new(span_context: OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, span_id: span_id, tracestate: result.tracestate))
-          end
+          @tracer_provider.internal_create_span(name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, with_parent, @instrumentation_library)
         end
       end
     end

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

@@ -8,24 +8,35 @@ module OpenTelemetry
   module SDK
     module Trace
       # {TracerProvider} is the SDK implementation of {OpenTelemetry::Trace::TracerProvider}.
-      class TracerProvider < OpenTelemetry::Trace::TracerProvider
+      class TracerProvider < OpenTelemetry::Trace::TracerProvider # rubocop:disable Metrics/ClassLength
         Key = Struct.new(:name, :version)
         private_constant(:Key)
 
-        attr_accessor :active_trace_config, :id_generator
-        attr_reader :active_span_processor, :stopped, :resource
-        alias stopped? stopped
+        attr_accessor :span_limits, :id_generator, :sampler
+        attr_reader :resource
 
         # Returns a new {TracerProvider} instance.
         #
+        # @param [optional Sampler] sampler The sampling policy for new spans
+        # @param [optional Resource] resource The resource to associate with spans
+        #   created by Tracers created by this TracerProvider
+        # @param [optional IDGenerator] id_generator The trace and span ID generation
+        #   policy
+        # @param [optional SpanLimits] span_limits The limits to apply to attribute,
+        #   event and link counts for Spans created by Tracers created by this
+        #   TracerProvider
+        #
         # @return [TracerProvider]
-        def initialize(resource = OpenTelemetry::SDK::Resources::Resource.create)
+        def initialize(sampler: sampler_from_environment(Samplers.parent_based(root: Samplers::ALWAYS_ON)),
+                       resource: OpenTelemetry::SDK::Resources::Resource.create,
+                       id_generator: OpenTelemetry::Trace,
+                       span_limits: SpanLimits::DEFAULT)
           @mutex = Mutex.new
           @registry = {}
-          @active_span_processor = NoopSpanProcessor.instance
-          @active_trace_config = Config::TraceConfig::DEFAULT
-          @id_generator = OpenTelemetry::Trace
-          @registered_span_processors = []
+          @span_processors = []
+          @span_limits = span_limits
+          @sampler = sampler
+          @id_generator = id_generator
           @stopped = false
           @resource = resource
         end
@@ -39,10 +50,11 @@ module OpenTelemetry
         def tracer(name = nil, version = nil)
           name ||= ''
           version ||= ''
+          OpenTelemetry.logger.warn 'calling TracerProvider#tracer without providing a tracer name.' if name.empty?
           @mutex.synchronize { @registry[Key.new(name, version)] ||= Tracer.new(name, version, self) }
         end
 
-        # Attempts to stop all the activity for this {Tracer}. Calls
+        # Attempts to stop all the activity for this {TracerProvider}. Calls
         # SpanProcessor#shutdown for all registered SpanProcessors.
         #
         # This operation may block until all the Spans are processed. Must be
@@ -52,23 +64,54 @@ module OpenTelemetry
         # After this is called all the newly created {Span}s will be no-op.
         #
         # @param [optional Numeric] timeout An optional timeout in seconds.
+        # @return [Integer] Export::SUCCESS if no error occurred, Export::FAILURE if
+        #   a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.
         def shutdown(timeout: nil)
           @mutex.synchronize do
             if @stopped
               OpenTelemetry.logger.warn('calling Tracer#shutdown multiple times.')
-              return
+              return Export::FAILURE
+            end
+
+            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
+            results = @span_processors.map do |processor|
+              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+              break [Export::TIMEOUT] if remaining_timeout&.zero?
+
+              processor.shutdown(timeout: remaining_timeout)
             end
-            @active_span_processor.shutdown(timeout: timeout)
             @stopped = true
+            results.max || Export::SUCCESS
           end
         end
 
-        # Adds a new SpanProcessor to this {Tracer}.
+        # Immediately export all spans that have not yet been exported for all the
+        # registered SpanProcessors.
         #
-        # Any registered processor causes overhead, consider to use an
-        # async/batch processor especially for span exporting, and export to
-        # multiple backends using the
-        # {io.opentelemetry.sdk.trace.export.MultiSpanExporter}.
+        # This method should only be called in cases where it is absolutely
+        # necessary, such as when using some FaaS providers that may suspend
+        # the process after an invocation, but before the `Processor` exports
+        # the completed spans.
+        #
+        # @param [optional Numeric] timeout An optional timeout in seconds.
+        # @return [Integer] Export::SUCCESS if no error occurred, Export::FAILURE if
+        #   a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.
+        def force_flush(timeout: nil)
+          @mutex.synchronize do
+            return Export::SUCCESS if @stopped
+
+            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
+            results = @span_processors.map do |processor|
+              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+              return Export::TIMEOUT if remaining_timeout&.zero?
+
+              processor.force_flush(timeout: remaining_timeout)
+            end
+            results.max || Export::SUCCESS
+          end
+        end
+
+        # Adds a new SpanProcessor to this {Tracer}.
         #
         # @param span_processor the new SpanProcessor to be added.
         def add_span_processor(span_processor)
@@ -77,9 +120,53 @@ module OpenTelemetry
               OpenTelemetry.logger.warn('calling Tracer#add_span_processor after shutdown.')
               return
             end
-            @registered_span_processors << span_processor
-            @active_span_processor = MultiSpanProcessor.new(@registered_span_processors.dup)
+            @span_processors = @span_processors.dup.push(span_processor)
+          end
+        end
+
+        # @api private
+        def internal_create_span(name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, parent_context, instrumentation_library) # rubocop:disable Metrics/MethodLength
+          trace_id ||= @id_generator.generate_trace_id
+          result = @sampler.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
+          span_id = @id_generator.generate_span_id
+          if result.recording? && !@stopped
+            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
+            Span.new(
+              context,
+              parent_context,
+              name,
+              kind,
+              parent_span_id,
+              @span_limits,
+              @span_processors,
+              attributes,
+              links,
+              start_timestamp,
+              @resource,
+              instrumentation_library
+            )
+          else
+            OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, span_id: span_id, tracestate: result.tracestate))
+          end
+        end
+
+        private
+
+        def sampler_from_environment(default_sampler) # rubocop:disable Metrics/CyclomaticComplexity
+          case ENV['OTEL_TRACES_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_TRACES_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_TRACES_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
       end
     end

data/lib/opentelemetry/sdk/version.rb

@@ -7,6 +7,6 @@
 module OpenTelemetry
   module SDK
     ## Current OpenTelemetry version
-    VERSION = '0.14.0'
+    VERSION = '1.0.0.rc2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-jaeger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -163,29 +191,22 @@ files:
 - README.md
 - lib/opentelemetry-sdk.rb
 - lib/opentelemetry/sdk.rb
-- lib/opentelemetry/sdk/baggage.rb
-- lib/opentelemetry/sdk/baggage/builder.rb
-- lib/opentelemetry/sdk/baggage/manager.rb
 - lib/opentelemetry/sdk/configurator.rb
+- lib/opentelemetry/sdk/forwarding_logger.rb
 - lib/opentelemetry/sdk/instrumentation_library.rb
 - lib/opentelemetry/sdk/internal.rb
 - lib/opentelemetry/sdk/resources.rb
 - lib/opentelemetry/sdk/resources/constants.rb
 - lib/opentelemetry/sdk/resources/resource.rb
 - lib/opentelemetry/sdk/trace.rb
-- lib/opentelemetry/sdk/trace/config.rb
-- lib/opentelemetry/sdk/trace/config/trace_config.rb
 - lib/opentelemetry/sdk/trace/event.rb
 - lib/opentelemetry/sdk/trace/export.rb
 - 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
-- lib/opentelemetry/sdk/trace/multi_span_processor.rb
-- lib/opentelemetry/sdk/trace/noop_span_processor.rb
+- lib/opentelemetry/sdk/trace/export/span_exporter.rb
 - lib/opentelemetry/sdk/trace/samplers.rb
 - lib/opentelemetry/sdk/trace/samplers/constant_sampler.rb
 - lib/opentelemetry/sdk/trace/samplers/decision.rb
@@ -194,6 +215,8 @@ files:
 - lib/opentelemetry/sdk/trace/samplers/trace_id_ratio_based.rb
 - lib/opentelemetry/sdk/trace/span.rb
 - lib/opentelemetry/sdk/trace/span_data.rb
+- lib/opentelemetry/sdk/trace/span_limits.rb
+- lib/opentelemetry/sdk/trace/span_processor.rb
 - lib/opentelemetry/sdk/trace/tracer.rb
 - lib/opentelemetry/sdk/trace/tracer_provider.rb
 - lib/opentelemetry/sdk/version.rb
@@ -201,10 +224,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.14.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.0.0.rc2/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.14.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.0.0.rc2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -216,11 +239,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework