opentelemetry-sdk 0.4.0 → 0.8.0

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

@@ -14,7 +14,7 @@ module OpenTelemetry
         # root span.
         class Result
           EMPTY_HASH = {}.freeze
-          DECISIONS = [Decision::RECORD, Decision::NOT_RECORD, Decision::RECORD_AND_SAMPLED].freeze
+          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.
@@ -39,14 +39,14 @@ module OpenTelemetry
           #
           # @return [Boolean] sampling decision
           def sampled?
-            @decision == Decision::RECORD_AND_SAMPLED
+            @decision == Decision::RECORD_AND_SAMPLE
           end
 
           # Returns true if this span should record events, attributes, status, etc.
           #
           # @return [Boolean] recording decision
           def recording?
-            @decision != Decision::NOT_RECORD
+            @decision != Decision::DROP
           end
         end
       end

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

@@ -0,0 +1,45 @@
+# 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 TraceIdRatioBased
+          attr_reader :description
+
+          def initialize(probability)
+            @probability = probability
+            @id_upper_bound = (probability * (2**64 - 1)).ceil
+            @description = format('TraceIdRatioBased{%.6f}', probability)
+          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.
+
+            if sample?(trace_id)
+              RECORD_AND_SAMPLE
+            else
+              DROP
+            end
+          end
+
+          private
+
+          def sample?(trace_id)
+            @probability == 1.0 || trace_id[8, 8].unpack1('Q>') < @id_upper_bound
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,12 +16,16 @@ module OpenTelemetry
       #
       # rubocop:disable Metrics/ClassLength
       class Span < OpenTelemetry::Trace::Span
+        DEFAULT_STATUS = OpenTelemetry::Trace::Status.new(OpenTelemetry::Trace::Status::UNSET)
+
+        private_constant(:DEFAULT_STATUS)
+
         # 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 => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] may be nil.
@@ -59,7 +63,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 +80,29 @@ 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}.
-        #
-        # Eager example:
-        #
-        #   span.add_event(name: 'event', attributes: {'eager' => true})
+        # Add an Event to a {Span}.
         #
-        # Lazy example:
+        # 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/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 [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. This argument should
-        #   only be used when passing in a name.
+        #   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
@@ -120,18 +116,18 @@ module OpenTelemetry
           self
         end
 
-        # Record an error during the execution of this span. Multiple errors
+        # Record an exception during the execution of this span. Multiple exceptions
         # can be recorded on a span.
         #
-        # @param [Exception] error The error to be recorded
+        # @param [Exception] exception The exception to be recorded
         #
         # @return [void]
-        def record_error(error)
-          add_event(name: 'error',
+        def record_exception(exception)
+          add_event('exception',
                     attributes: {
-                      'error.type' => error.class.to_s,
-                      'error.message' => error.message,
-                      'error.stack' => error.backtrace.join("\n")
+                      'exception.type' => exception.class.to_s,
+                      'exception.message' => exception.message,
+                      'exception.stacktrace' => exception.full_message(highlight: false, order: :top)
                     })
         end
 
@@ -227,7 +223,6 @@ module OpenTelemetry
             @kind,
             @status,
             @parent_span_id,
-            @child_count,
             @total_recorded_attributes,
             @total_recorded_events,
             @total_recorded_links,
@@ -236,15 +231,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, parent_context, name, kind, parent_span_id, trace_config, span_processor, attributes, links, start_timestamp, resource, instrumentation_library) # rubocop:disable Metrics/AbcSize
           super(span_context: context)
           @mutex = Mutex.new
           @name = name
@@ -252,10 +249,10 @@ 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
+          @status = DEFAULT_STATUS
           @total_recorded_events = 0
           @total_recorded_links = links&.size || 0
           @total_recorded_attributes = attributes&.size || 0
@@ -265,7 +262,7 @@ module OpenTelemetry
           trim_span_attributes(@attributes)
           @events = nil
           @links = trim_links(links, trace_config.max_links_count, trace_config.max_attributes_per_link)
-          @span_processor.on_start(self)
+          @span_processor.on_start(self, parent_context)
         end
 
         # TODO: Java implementation overrides finalize to log if a span isn't finished.
@@ -297,7 +294,7 @@ module OpenTelemetry
             attrs.keep_if { |key, value| Internal.valid_key?(key) && Internal.valid_value?(value) }
             excess = attrs.size - max_attributes_per_link
             excess.times { attrs.shift } if excess.positive?
-            OpenTelemetry::Trace::Link.new(link.context, attrs)
+            OpenTelemetry::Trace::Link.new(link.span_context, attrs)
           end.freeze
         end
 
@@ -322,7 +319,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

@@ -14,7 +14,6 @@ module OpenTelemetry
                             :kind,
                             :status,
                             :parent_span_id,
-                            :child_count,
                             :total_recorded_attributes,
                             :total_recorded_events,
                             :total_recorded_links,
@@ -23,10 +22,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,44 +19,59 @@ 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)
-          start_span(name, with_parent_context: Context.empty, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind)
+          start_span(name, with_parent: 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)
+        def start_span(name, with_parent: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil) # rubocop:disable Metrics/AbcSize
           name ||= 'empty'
 
-          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
+          with_parent ||= Context.current
+          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
+          else
+            parent_span_context = nil
+          end
           trace_id ||= OpenTelemetry::Trace.generate_trace_id
-          span_id = OpenTelemetry::Trace.generate_span_id
-          sampler = OpenTelemetry.tracer_provider.active_trace_config.sampler
-          result = sampler.call(trace_id: trace_id, span_id: span_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)
+          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, parent_span_id, attributes, links, start_timestamp, tracestate, with_parent)
         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_provider.stopped?
+        def internal_create_span(result, name, kind, trace_id, parent_span_id, attributes, links, start_timestamp, tracestate, parent_context) # rubocop:disable Metrics/AbcSize
+          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_provider.active_trace_config
-            active_span_processor = OpenTelemetry.tracer_provider.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,
+              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))
           end

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

@@ -13,20 +13,20 @@ module OpenTelemetry
         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 {TracerProvider} instance.
         #
         # @return [TracerProvider]
-        def initialize
+        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

data/lib/opentelemetry/sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-10-27 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.4.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -149,16 +149,19 @@ 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/correlation_context.rb
-- lib/opentelemetry/sdk/correlation_context/builder.rb
-- lib/opentelemetry/sdk/correlation_context/manager.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
@@ -169,9 +172,11 @@ 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
@@ -180,7 +185,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.8.0/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.8.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -196,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework