opentelemetry-sdk 0.2.0 → 0.6.0

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

@@ -18,13 +18,13 @@ module OpenTelemetry
       class Span < OpenTelemetry::Trace::Span
         # The following readers are intended for the use of SpanProcessors and
         # should not be considered part of the public interface for instrumentation.
-        attr_reader :name, :status, :kind, :parent_span_id, :start_timestamp, :end_timestamp, :links, :library_resource
+        attr_reader :name, :status, :kind, :parent_span_id, :start_timestamp, :end_timestamp, :links, :resource, :instrumentation_library
 
         # Return a frozen copy of the current attributes. This is intended for
-        # use of SpanProcesses and should not be considered part of the public
+        # use of SpanProcessors and should not be considered part of the public
         # interface for instrumentation.
         #
-        # @return [Hash<String, Object>] may be nil.
+        # @return [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] may be nil.
         def attributes
           # Don't bother synchronizing. Access by SpanProcessors is expected to
           # be serialized.
@@ -59,7 +59,7 @@ module OpenTelemetry
         # meanings.
         #
         # @param [String] key
-        # @param [String, Boolean, Numeric] value
+        # @param [String, Boolean, Numeric, Array<String, Numeric, Boolean>] value
         #
         # @return [self] returns itself
         def set_attribute(key, value)
@@ -76,37 +76,30 @@ module OpenTelemetry
           end
           self
         end
+        alias []= set_attribute
 
-        # Add an Event to a {Span}. This can be accomplished eagerly or lazily.
-        # Lazy evaluation is useful when the event attributes are expensive to
-        # build and where the cost can be avoided for an unsampled {Span}.
+        # Add an Event to a {Span}.
         #
-        # Eager example:
+        # Example:
         #
-        #   span.add_event(name: 'event', attributes: {'eager' => true})
-        #
-        # Lazy example:
-        #
-        #   span.add_event { OpenTelemetry::Trace::Event.new(name: 'event', attributes: {'eager' => false}) }
+        #   span.add_event('event', attributes: {'eager' => true})
         #
         # Note that the OpenTelemetry project
-        # {https://github.com/open-telemetry/opentelemetry-specification/blob/master/semantic-conventions.md
+        # {https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md
         # documents} certain "standard event names and keys" which have
         # prescribed semantic meanings.
         #
-        # @param [optional String] name Optional name of the event. This is
-        #   required if a block is not given.
-        # @param [optional Hash<String, Object>] attributes One or more key:value
-        #   pairs, where the keys must be strings and the values may be string,
-        #   boolean or numeric type. This argument should only be used when
-        #   passing in a name.
+        # @param [String] name Name of the event.
+        # @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 string, boolean or numeric type.
         # @param [optional Time] timestamp Optional timestamp for the event.
-        #   This argument should only be used when passing in a name.
         #
         # @return [self] returns itself
-        def add_event(name: nil, attributes: nil, timestamp: nil)
+        def add_event(name, attributes: nil, timestamp: nil)
           super
-          event = block_given? ? yield : OpenTelemetry::Trace::Event.new(name: name, attributes: attributes, timestamp: timestamp || Time.now)
+          event = Event.new(name: name, attributes: attributes, timestamp: timestamp || Time.now)
+
           @mutex.synchronize do
             if @ended
               OpenTelemetry.logger.warn('Calling add_event on an ended Span.')
@@ -119,6 +112,21 @@ module OpenTelemetry
           self
         end
 
+        # Record an exception during the execution of this span. Multiple exceptions
+        # can be recorded on a span.
+        #
+        # @param [Exception] exception The exception to be recorded
+        #
+        # @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)
+                    })
+        end
+
         # Sets the Status to the Span
         #
         # If used, this will override the default Span status. Default is OK.
@@ -220,15 +228,17 @@ module OpenTelemetry
             @attributes,
             @links,
             @events,
-            @library_resource,
+            @resource,
+            @instrumentation_library,
             context.span_id,
             context.trace_id,
-            context.trace_flags
+            context.trace_flags,
+            context.tracestate
           )
         end
 
         # @api private
-        def initialize(context, name, kind, parent_span_id, trace_config, span_processor, attributes, links, start_timestamp, library_resource) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def initialize(context, name, kind, parent_span_id, trace_config, span_processor, attributes, links, start_timestamp, resource, instrumentation_library) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           super(span_context: context)
           @mutex = Mutex.new
           @name = name
@@ -236,7 +246,8 @@ module OpenTelemetry
           @parent_span_id = parent_span_id.freeze || OpenTelemetry::Trace::INVALID_SPAN_ID
           @trace_config = trace_config
           @span_processor = span_processor
-          @library_resource = library_resource
+          @resource = resource
+          @instrumentation_library = instrumentation_library
           @ended = false
           @status = nil
           @child_count = 0
@@ -306,7 +317,7 @@ module OpenTelemetry
             attrs.keep_if { |key, value| Internal.valid_key?(key) && Internal.valid_value?(value) }
             excess = attrs.size - max_attributes_per_event
             excess.times { attrs.shift } if excess.positive?
-            event = OpenTelemetry::Trace::Event.new(name: event.name, attributes: attrs, timestamp: event.timestamp)
+            event = Event.new(name: event.name, attributes: attrs, timestamp: event.timestamp)
           end
           events << event
         end

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

@@ -23,10 +23,26 @@ module OpenTelemetry
                             :attributes,
                             :links,
                             :events,
-                            :library_resource,
+                            :resource,
+                            :instrumentation_library,
                             :span_id,
                             :trace_id,
-                            :trace_flags)
+                            :trace_flags,
+                            :tracestate) do
+                              # Returns the lowercase [hex encoded](https://tools.ietf.org/html/rfc4648#section-8) span ID.
+                              #
+                              # @return [String] A 16-hex-character lowercase string.
+                              def hex_span_id
+                                span_id.unpack1('H*')
+                              end
+
+                              # Returns the lowercase [hex encoded](https://tools.ietf.org/html/rfc4648#section-8) trace ID.
+                              #
+                              # @return [String] A 32-hex-character lowercase string.
+                              def hex_trace_id
+                                trace_id.unpack1('H*')
+                              end
+                            end
     end
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright 2020 OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -11,6 +11,7 @@ module OpenTelemetry
       class Tracer < OpenTelemetry::Trace::Tracer
         attr_reader :name
         attr_reader :version
+        attr_reader :tracer_provider
 
         # @api private
         #
@@ -18,45 +19,55 @@ module OpenTelemetry
         #
         # @param [String] name Instrumentation package name
         # @param [String] version Instrumentation package version
+        # @param [TracerProvider] tracer_provider TracerProvider that initialized the tracer
         #
         # @return [Tracer]
-        def initialize(name, version)
+        def initialize(name, version, tracer_provider)
           @name = name
           @version = version
-          @resource = Resources::Resource.create('name' => name, 'version' => version)
+          @instrumentation_library = InstrumentationLibrary.new(name, version)
+          @tracer_provider = tracer_provider
         end
 
-        def start_root_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, sampling_hint: nil)
-          parent_span_context = OpenTelemetry::Trace::SpanContext::INVALID
-          start_span(name, with_parent_context: parent_span_context, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind, sampling_hint: sampling_hint)
+        def start_root_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
+          start_span(name, with_parent_context: Context.empty, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind)
         end
 
-        def start_span(name, with_parent: nil, with_parent_context: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil, sampling_hint: nil) # rubocop:disable Metrics/AbcSize
+        def start_span(name, with_parent: nil, with_parent_context: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
           name ||= 'empty'
 
-          parent_span_context = with_parent&.context || with_parent_context || current_span.context
+          parent_span_context = with_parent&.context || active_span_context(with_parent_context)
           parent_span_context = nil unless parent_span_context.valid?
           parent_span_id = parent_span_context&.span_id
           tracestate = parent_span_context&.tracestate
           trace_id = parent_span_context&.trace_id
           trace_id ||= OpenTelemetry::Trace.generate_trace_id
           span_id = OpenTelemetry::Trace.generate_span_id
-          sampler = OpenTelemetry.tracer_factory.active_trace_config.sampler
-          result = sampler.call(trace_id: trace_id, span_id: span_id, parent_context: parent_span_context, hint: sampling_hint, links: links, name: name, kind: kind, attributes: attributes)
-
+          sampler = tracer_provider.active_trace_config.sampler
+          result = sampler.should_sample?(trace_id: trace_id, parent_context: parent_span_context, links: links, name: name, kind: kind, attributes: attributes)
           internal_create_span(result, name, kind, trace_id, span_id, parent_span_id, attributes, links, start_timestamp, tracestate)
         end
 
         private
 
         def internal_create_span(result, name, kind, trace_id, span_id, parent_span_id, attributes, links, start_timestamp, tracestate) # rubocop:disable Metrics/AbcSize
-          if result.recording? && !OpenTelemetry.tracer_factory.stopped?
+          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)
             attributes = attributes&.merge(result.attributes) || result.attributes
-            active_trace_config = OpenTelemetry.tracer_factory.active_trace_config
-            active_span_processor = OpenTelemetry.tracer_factory.active_span_processor
-            Span.new(context, name, kind, parent_span_id, active_trace_config, active_span_processor, attributes, links, start_timestamp || Time.now, @resource)
+            Span.new(
+              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))
           end

data/lib/opentelemetry/sdk/trace/{tracer_factory.rb → tracer_provider.rb}

@@ -7,26 +7,26 @@
 module OpenTelemetry
   module SDK
     module Trace
-      # {TracerFactory} is the SDK implementation of {OpenTelemetry::Trace::TracerFactory}.
-      class TracerFactory < OpenTelemetry::Trace::TracerFactory
+      # {TracerProvider} is the SDK implementation of {OpenTelemetry::Trace::TracerProvider}.
+      class TracerProvider < OpenTelemetry::Trace::TracerProvider
         Key = Struct.new(:name, :version)
         private_constant(:Key)
 
         attr_accessor :active_trace_config
-        attr_reader :active_span_processor
-        attr_reader :stopped
+        attr_reader :active_span_processor, :stopped, :resource
         alias stopped? stopped
 
-        # Returns a new {TracerFactory} instance.
+        # Returns a new {TracerProvider} instance.
         #
-        # @return [TracerFactory]
-        def initialize
+        # @return [TracerProvider]
+        def initialize(resource = OpenTelemetry::SDK::Resources::Resource.create)
           @mutex = Mutex.new
           @registry = {}
           @active_span_processor = NoopSpanProcessor.instance
           @active_trace_config = Config::TraceConfig::DEFAULT
           @registered_span_processors = []
           @stopped = false
+          @resource = resource
         end
 
         # Returns a {Tracer} instance.
@@ -38,7 +38,7 @@ module OpenTelemetry
         def tracer(name = nil, version = nil)
           name ||= ''
           version ||= ''
-          @mutex.synchronize { @registry[Key.new(name, version)] ||= Tracer.new(name, version) }
+          @mutex.synchronize { @registry[Key.new(name, version)] ||= Tracer.new(name, version, self) }
         end
 
         # Attempts to stop all the activity for this {Tracer}. Calls
@@ -75,7 +75,7 @@ module OpenTelemetry
               return
             end
             @registered_span_processors << span_processor
-            @active_span_processor = MultiSpanProcessor.new(@registered_span_processors)
+            @active_span_processor = MultiSpanProcessor.new(@registered_span_processors.dup)
           end
         end
       end

data/lib/opentelemetry/sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,15 +143,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE
+- 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/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
@@ -162,13 +172,15 @@ files:
 - lib/opentelemetry/sdk/trace/multi_span_processor.rb
 - lib/opentelemetry/sdk/trace/noop_span_processor.rb
 - lib/opentelemetry/sdk/trace/samplers.rb
+- lib/opentelemetry/sdk/trace/samplers/constant_sampler.rb
 - lib/opentelemetry/sdk/trace/samplers/decision.rb
-- lib/opentelemetry/sdk/trace/samplers/probability_sampler.rb
+- lib/opentelemetry/sdk/trace/samplers/parent_based.rb
 - lib/opentelemetry/sdk/trace/samplers/result.rb
+- 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/tracer.rb
-- lib/opentelemetry/sdk/trace/tracer_factory.rb
+- lib/opentelemetry/sdk/trace/tracer_provider.rb
 - lib/opentelemetry/sdk/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
@@ -182,14 +194,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework

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

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Trace
-      module Samplers
-        # @api private
-        #
-        # Implements sampling based on a probability.
-        class ProbabilitySampler
-          HINT_RECORD_AND_SAMPLED = OpenTelemetry::Trace::SamplingHint::RECORD_AND_SAMPLED
-          HINT_RECORD = OpenTelemetry::Trace::SamplingHint::RECORD
-
-          private_constant(:HINT_RECORD_AND_SAMPLED, :HINT_RECORD)
-
-          def initialize(probability, ignore_hints:, ignore_parent:, apply_to_remote_parent:, apply_to_all_spans:)
-            @probability = probability
-            @id_upper_bound = format('%016x', (probability * (2**64 - 1)).ceil)
-            @ignored_hints = ignore_hints
-            @use_parent_sampled_flag = !ignore_parent
-            @apply_to_remote_parent = apply_to_remote_parent
-            @apply_to_all_spans = apply_to_all_spans
-          end
-
-          # @api private
-          #
-          # Callable interface for probability sampler. See {Samplers}.
-          def call(trace_id:, span_id:, parent_context:, hint:, links:, name:, kind:, attributes:)
-            # Ignored for sampling decision: links, name, kind, attributes.
-
-            hint = nil if @ignored_hints.include?(hint)
-
-            sampled = sample?(hint, trace_id, parent_context)
-            recording = hint == HINT_RECORD || sampled
-
-            if sampled && recording
-              RECORD_AND_SAMPLED
-            elsif recording
-              RECORD
-            else
-              NOT_RECORD
-            end
-          end
-
-          private
-
-          def sample?(hint, trace_id, parent_context)
-            if parent_context.nil?
-              hint == HINT_RECORD_AND_SAMPLED || sample_trace_id?(trace_id)
-            else
-              parent_sampled?(parent_context) || hint == HINT_RECORD_AND_SAMPLED || sample_trace_id_for_child?(parent_context, trace_id)
-            end
-          end
-
-          def parent_sampled?(parent_context)
-            @use_parent_sampled_flag && parent_context.trace_flags.sampled?
-          end
-
-          def sample_trace_id_for_child?(parent_context, trace_id)
-            (@apply_to_all_spans || (@apply_to_remote_parent && parent_context.remote?)) && sample_trace_id?(trace_id)
-          end
-
-          def sample_trace_id?(trace_id)
-            @probability == 1.0 || trace_id[16, 16] < @id_upper_bound
-          end
-        end
-      end
-    end
-  end
-end