opentelemetry-sdk 0.8.0 → 0.12.0

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
 
@@ -18,7 +18,7 @@ module OpenTelemetry
             @stopped = false
           end
 
-          def export(spans)
+          def export(spans, timeout: nil)
             return FAILURE if @stopped
 
             Array(spans).each { |s| pp s }
@@ -26,7 +26,7 @@ module OpenTelemetry
             SUCCESS
           end
 
-          def shutdown
+          def shutdown(timeout: nil)
             @stopped = true
             SUCCESS
           end

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
 
@@ -60,9 +60,10 @@ module OpenTelemetry
           #
           # @param [Enumerable<SpanData>] span_datas the list of sampled {SpanData}s to be
           #   exported.
+          # @param [optional Numeric] timeout An optional timeout in seconds.
           # @return [Integer] the result of the export, SUCCESS or
           #   FAILURE
-          def export(span_datas)
+          def export(span_datas, timeout: nil)
             @mutex.synchronize do
               return FAILURE if @stopped
 
@@ -74,9 +75,10 @@ module OpenTelemetry
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #
+          # @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 shutdown
+          def shutdown(timeout: nil)
             @mutex.synchronize do
               @finished_spans.clear
               @stopped = true

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
 
@@ -23,36 +23,34 @@ module OpenTelemetry
           #
           # @param [Enumerable<Span>] spans the list of sampled {Span}s to be
           #   exported.
+          # @param [optional Numeric] timeout An optional timeout in seconds.
           # @return [Integer] the result of the export.
-          def export(spans)
-            @span_exporters.inject(SUCCESS) do |result_code, span_exporter|
-              merge_result_code(result_code, span_exporter.export(spans))
+          def export(spans, timeout: nil)
+            start_time = Time.now
+            results = @span_exporters.map do |span_exporter|
+              span_exporter.export(spans, timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
             rescue => e # rubocop:disable Style/RescueStandardError
               OpenTelemetry.logger.warn("exception raised by export - #{e}")
               FAILURE
             end
+            results.uniq.max || SUCCESS
           end
 
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #
+          # @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 shutdown
-            @span_exporters.map(&:shutdown).uniq.max
-          end
-
-          private
+          def shutdown(timeout: nil)
+            start_time = Time.now
+            results = @span_exporters.map do |processor|
+              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+              return TIMEOUT if remaining_timeout&.zero?
 
-          # Returns a merged error code, see the rules in the code.
-          def merge_result_code(result_code, new_result_code)
-            if result_code == SUCCESS && new_result_code == SUCCESS
-              # If both errors are success then return success.
-              SUCCESS
-            else
-              # At this point at least one of the code is FAILURE, so return FAILURE.
-              FAILURE
+              processor.shutdown(timeout: remaining_timeout)
             end
+            results.uniq.max || SUCCESS
           end
         end
       end

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
 
@@ -23,8 +23,9 @@ module OpenTelemetry
           #
           # @param [Enumerable<Span>] spans the list of sampled {Span}s to be
           #   exported.
+          # @param [optional Numeric] timeout An optional timeout in seconds.
           # @return [Integer] the result of the export.
-          def export(spans)
+          def export(spans, timeout: nil)
             return SUCCESS unless @stopped
 
             FAILURE
@@ -32,7 +33,9 @@ module OpenTelemetry
 
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
-          def shutdown
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          def shutdown(timeout: nil)
             @stopped = true
             SUCCESS
           end

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
 
@@ -12,6 +12,12 @@ module OpenTelemetry
         # {Span} to {io.opentelemetry.proto.trace.v1.Span} and passes it to the
         # configured exporter.
         #
+        # Typically, the SimpleSpanProcessor will be most suitable for use in testing;
+        # it should be used with caution in production. It may be appropriate for
+        # production use in scenarios where creating multiple threads is not desirable
+        # as well as scenarios where different custom attributes should be added to
+        # individual spans based on code scopes.
+        #
         # Only spans that are recorded are converted, {OpenTelemetry::Trace::Span#is_recording?} must
         # return true.
         class SimpleSpanProcessor
@@ -51,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
@@ -62,18 +68,20 @@ module OpenTelemetry
           # the process after an invocation, but before the `Processor` exports
           # the completed spans.
           #
+          # @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
+          def force_flush(timeout: nil)
             SUCCESS
           end
 
           # Called when {TracerProvider#shutdown} is called.
           #
+          # @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 shutdown
-            @span_exporter&.shutdown || SUCCESS
+          def shutdown(timeout: nil)
+            @span_exporter&.shutdown(timeout: timeout) || SUCCESS
           end
         end
       end

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
 
@@ -51,18 +51,34 @@ module OpenTelemetry
         # 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
-          @span_processors.map(&:force_flush).uniq.max
+        def force_flush(timeout: nil)
+          start_time = Time.now
+          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.uniq.max
         end
 
         # Called when {TracerProvider#shutdown} is called.
         #
+        # @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
-          @span_processors.map(&:shutdown).uniq.max
+        def shutdown(timeout: nil)
+          start_time = Time.now
+          results = @span_processors.map do |processor|
+            remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+            return Export::TIMEOUT if remaining_timeout&.zero?
+
+            processor.shutdown(timeout: remaining_timeout)
+          end
+          results.uniq.max
         end
       end
     end

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
 
@@ -43,17 +43,19 @@ module OpenTelemetry
         # 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
+        def force_flush(timeout: nil)
           Export::SUCCESS
         end
 
         # Called when {TracerProvider#shutdown} is called.
         #
+        # @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
+        def shutdown(timeout: nil)
           Export::SUCCESS
         end
       end

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
 
@@ -25,9 +25,10 @@ module OpenTelemetry
       # Where:
       #
       # @param [String] trace_id The trace_id of the {Span} to be created.
-      # @param [OpenTelemetry::Trace::SpanContext] parent_context The
-      #   {OpenTelemetry::Trace::SpanContext} of a parent span, typically
-      #   extracted from the wire. Can be nil for a root span.
+      # @param [OpenTelemetry::Context] parent_context The
+      #   {OpenTelemetry::Context} with a parent {Span}. The {Span}'s
+      #   {OpenTelemetry::Trace::SpanContext} may be invalid to indicate a
+      #   root span.
       # @param [Enumerable<Link>] links A collection of links to be associated
       #   with the {Span} to be created. Can be nil.
       # @param [String] name Name of the {Span} to be created.
@@ -37,18 +38,11 @@ module OpenTelemetry
       #   to the {Span} to be created. Can be nil.
       # @return [Result] The sampling result.
       module Samplers
-        RECORD_AND_SAMPLE = Result.new(decision: Decision::RECORD_AND_SAMPLE)
-        DROP = Result.new(decision: Decision::DROP)
-        RECORD_ONLY = Result.new(decision: Decision::RECORD_ONLY)
-        SAMPLING_HINTS = [Decision::DROP, Decision::RECORD_ONLY, Decision::RECORD_AND_SAMPLE].freeze
-
-        private_constant(:RECORD_AND_SAMPLE, :DROP, :RECORD_ONLY, :SAMPLING_HINTS)
-
         # Returns a {Result} with {Decision::RECORD_AND_SAMPLE}.
-        ALWAYS_ON = ConstantSampler.new(result: RECORD_AND_SAMPLE, description: 'AlwaysOnSampler')
+        ALWAYS_ON = ConstantSampler.new(decision: Decision::RECORD_AND_SAMPLE, description: 'AlwaysOnSampler')
 
         # Returns a {Result} with {Decision::DROP}.
-        ALWAYS_OFF = ConstantSampler.new(result: DROP, description: 'AlwaysOffSampler')
+        ALWAYS_OFF = ConstantSampler.new(decision: Decision::DROP, description: 'AlwaysOffSampler')
 
         # Returns a new sampler. It delegates to samplers according to the following rules:
         #

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

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

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

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

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

@@ -26,6 +26,14 @@ module OpenTelemetry
             @local_parent_not_sampled = local_parent_not_sampled
           end
 
+          def ==(other)
+            @root == other.root &&
+              @remote_parent_sampled == other.remote_parent_sampled &&
+              @remote_parent_not_sampled == other.remote_parent_not_sampled &&
+              @local_parent_sampled == other.local_parent_sampled &&
+              @local_parent_not_sampled == other.local_parent_not_sampled
+          end
+
           # @api private
           #
           # See {Samplers}.
@@ -37,15 +45,20 @@ module OpenTelemetry
           #
           # See {Samplers}.
           def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
-            delegate = if parent_context.nil?
+            parent_span_context = OpenTelemetry::Trace.current_span(parent_context).context
+            delegate = if !parent_span_context.valid?
                          @root
-                       elsif parent_context.remote?
-                         parent_context.trace_flags.sampled? ? @remote_parent_sampled : @remote_parent_not_sampled
+                       elsif parent_span_context.remote?
+                         parent_span_context.trace_flags.sampled? ? @remote_parent_sampled : @remote_parent_not_sampled
                        else
-                         parent_context.trace_flags.sampled? ? @local_parent_sampled : @local_parent_not_sampled
+                         parent_span_context.trace_flags.sampled? ? @local_parent_sampled : @local_parent_not_sampled
                        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