ddtrace 1.1.0 → 1.9.0

data/lib/datadog/tracing/trace_operation.rb

@@ -1,15 +1,16 @@
 # typed: false
 
-require 'datadog/core'
-require 'datadog/core/environment/identity'
-require 'datadog/core/utils'
-
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/event'
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/trace_segment'
-require 'datadog/tracing/trace_digest'
-require 'datadog/tracing/metadata/tagging'
+require_relative '../core'
+require_relative '../core/environment/identity'
+require_relative '../core/utils'
+
+require_relative 'event'
+require_relative 'metadata/tagging'
+require_relative 'sampling/ext'
+require_relative 'span_operation'
+require_relative 'trace_digest'
+require_relative 'trace_segment'
+require_relative 'utils'
 
 module Datadog
   module Tracing
@@ -22,7 +23,6 @@ module Datadog
     # For async support, a {Datadog::Tracing::TraceOperation} should be employed
     # per execution context (e.g. Thread, etc.)
     #
-    # rubocop:disable Metrics/ClassLength
     # @public_api
     class TraceOperation
       include Metadata::Tagging
@@ -71,10 +71,10 @@ module Datadog
         metrics: nil
       )
         # Attributes
-        @id = id || Core::Utils.next_id
+        @id = id || Tracing::Utils.next_id
         @max_length = max_length || DEFAULT_MAX_LENGTH
         @parent_span_id = parent_span_id
-        @sampled = sampled.nil? ? false : sampled
+        @sampled = sampled.nil? ? true : sampled
 
         # Tags
         @agent_sample_rate = agent_sample_rate
@@ -113,18 +113,34 @@ module Datadog
         @finished == true
       end
 
+      # Will this trace be flushed by the tracer transport?
+      # This includes cases where the span is kept solely due to priority sampling.
+      #
+      # This is not the ultimate Datadog App sampling decision. Downstream systems
+      # can decide to reject this trace, especially for cases where priority
+      # sampling is set to AUTO_KEEP.
+      #
+      # @return [Boolean]
       def sampled?
-        @sampled == true || (!@sampling_priority.nil? && @sampling_priority > 0)
+        @sampled == true || priority_sampled?
+      end
+
+      # Has the priority sampling chosen to keep this span?
+      # @return [Boolean]
+      def priority_sampled?
+        !@sampling_priority.nil? && @sampling_priority > 0
       end
 
       def keep!
         self.sampled = true
         self.sampling_priority = Sampling::Ext::Priority::USER_KEEP
+        set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, Tracing::Sampling::Ext::Decision::MANUAL)
       end
 
       def reject!
         self.sampled = false
         self.sampling_priority = Sampling::Ext::Priority::USER_REJECT
+        set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, Tracing::Sampling::Ext::Decision::MANUAL)
       end
 
       def name
@@ -135,6 +151,13 @@ module Datadog
         @resource || (root_span && root_span.resource)
       end
 
+      # Returns true if the resource has been explicitly set
+      #
+      # @return [Boolean]
+      def resource_override?
+        !@resource.nil?
+      end
+
       def service
         @service || (root_span && root_span.service)
       end
@@ -226,6 +249,11 @@ module Datadog
         end
       end
 
+      # Returns a {TraceSegment} with all finished spans that can be flushed
+      # at invocation time. All other **finished** spans are discarded.
+      #
+      # @yield [spans] spans that will be returned as part of the trace segment returned
+      # @return [TraceSegment]
       def flush!
         finished = finished?
 
@@ -233,6 +261,8 @@ module Datadog
         spans = @spans.dup
         @spans = []
 
+        spans = yield(spans) if block_given?
+
         # Use them to build a trace
         build_trace(spans, !finished)
       end
@@ -251,6 +281,7 @@ module Datadog
           span_resource: (@active_span && @active_span.resource),
           span_service: (@active_span && @active_span.service),
           span_type: (@active_span && @active_span.type),
+          trace_distributed_tags: distributed_tags,
           trace_hostname: @hostname,
           trace_id: @id,
           trace_name: name,
@@ -425,7 +456,21 @@ module Datadog
           root_span_id: !partial ? root_span && root_span.id : nil
         )
       end
+
+      # Returns tracer tags that will be propagated if this span's context
+      # is exported through {.to_digest}.
+      # @return [Hash] key value pairs of distributed tags
+      def distributed_tags
+        meta.select { |name, _| name.start_with?(Metadata::Ext::Distributed::TAGS_PREFIX) }
+      end
+
+      def reset
+        @root_span = nil
+        @active_span = nil
+        @active_span_count = 0
+        @finished = false
+        @spans = []
+      end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/datadog/tracing/trace_segment.rb

@@ -1,17 +1,16 @@
 # typed: true
 
-require 'datadog/core/runtime/ext'
-require 'datadog/core/utils/safe_dup'
+require_relative '../core/runtime/ext'
+require_relative '../core/utils/safe_dup'
 
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/metadata/tagging'
+require_relative 'sampling/ext'
+require_relative 'metadata/ext'
+require_relative 'metadata/tagging'
 
 module Datadog
   module Tracing
     # Serializable construct representing a trace
     # @public_api
-    # rubocop:disable Metrics/ClassLength
     class TraceSegment
       TAG_NAME = 'name'.freeze
       TAG_RESOURCE = 'resource'.freeze
@@ -31,11 +30,13 @@ module Datadog
         :rule_sample_rate,
         :runtime_id,
         :sample_rate,
+        :sampling_decision_maker,
         :sampling_priority,
         :service
 
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
+      # @param spans [Array<Datadog::Span>]
       def initialize(
         spans,
         agent_sample_rate: nil,
@@ -77,6 +78,7 @@ module Datadog
         @rule_sample_rate = rule_sample_rate_tag || rule_sample_rate
         @runtime_id = runtime_id || runtime_id_tag
         @sample_rate = sample_rate || sample_rate_tag
+        @sampling_decision_maker = sampling_decision_maker_tag
         @sampling_priority = sampling_priority || sampling_priority_tag
         @service = Core::Utils::SafeDup.frozen_or_dup(service || service_tag)
       end
@@ -171,7 +173,7 @@ module Datadog
       end
 
       def process_id_tag
-        meta[Core::Runtime::Ext::TAG_PID]
+        meta[Core::Runtime::Ext::TAG_PROCESS_ID]
       end
 
       def rate_limiter_rate_tag
@@ -194,6 +196,10 @@ module Datadog
         metrics[Metadata::Ext::Sampling::TAG_SAMPLE_RATE]
       end
 
+      def sampling_decision_maker_tag
+        meta[Metadata::Ext::Distributed::TAG_DECISION_MAKER]
+      end
+
       def sampling_priority_tag
         meta[Metadata::Ext::Distributed::TAG_SAMPLING_PRIORITY]
       end
@@ -202,6 +208,5 @@ module Datadog
         meta[TAG_SERVICE]
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/datadog/tracing/tracer.rb

@@ -1,20 +1,21 @@
 # typed: true
 
-require 'datadog/core'
-require 'datadog/core/environment/ext'
-require 'datadog/core/environment/socket'
-
-require 'datadog/tracing/correlation'
-require 'datadog/tracing/event'
-require 'datadog/tracing/flush'
-require 'datadog/tracing/context_provider'
-require 'datadog/tracing/sampling/all_sampler'
-require 'datadog/tracing/sampling/rule_sampler'
-require 'datadog/tracing/sampling/priority_sampler'
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/trace_digest'
-require 'datadog/tracing/trace_operation'
-require 'datadog/tracing/writer'
+require_relative '../core'
+require_relative '../core/environment/ext'
+require_relative '../core/environment/socket'
+
+require_relative 'correlation'
+require_relative 'event'
+require_relative 'flush'
+require_relative 'context_provider'
+require_relative 'sampling/all_sampler'
+require_relative 'sampling/rule_sampler'
+require_relative 'sampling/priority_sampler'
+require_relative 'sampling/span/sampler'
+require_relative 'span_operation'
+require_relative 'trace_digest'
+require_relative 'trace_operation'
+require_relative 'writer'
 
 module Datadog
   module Tracing
@@ -22,12 +23,12 @@ module Datadog
     # example, a trace can be used to track the entire time spent processing a complicated web request.
     # Even though the request may require multiple resources and machines to handle the request, all
     # of these function calls and sub-requests would be encapsulated within a single trace.
-    # rubocop:disable Metrics/ClassLength
     class Tracer
       attr_reader \
         :trace_flush,
         :provider,
         :sampler,
+        :span_sampler,
         :tags
 
       attr_accessor \
@@ -56,6 +57,7 @@ module Datadog
           base_sampler: Sampling::AllSampler.new,
           post_sampler: Sampling::RuleSampler.new
         ),
+        span_sampler: Sampling::Span::Sampler.new,
         tags: {},
         writer: Writer.new
       )
@@ -64,6 +66,7 @@ module Datadog
         @enabled = enabled
         @provider = context_provider
         @sampler = sampler
+        @span_sampler = span_sampler
         @tags = tags
         @writer = writer
       end
@@ -323,7 +326,9 @@ module Datadog
             id: digest.trace_id,
             origin: digest.trace_origin,
             parent_span_id: digest.span_id,
-            sampling_priority: digest.trace_sampling_priority
+            sampling_priority: digest.trace_sampling_priority,
+            # Distributed tags are just regular trace tags with special meaning to Datadog
+            tags: digest.trace_distributed_tags,
           )
         else
           TraceOperation.new(
@@ -341,7 +346,8 @@ module Datadog
           sample_trace(event_trace_op) if event_span_op && event_span_op.parent_id == 0
         end
 
-        events.span_finished.subscribe do |_event_span, event_trace_op|
+        events.span_finished.subscribe do |event_span, event_trace_op|
+          sample_span(event_trace_op, event_span)
           flush_trace(event_trace_op)
         end
       end
@@ -461,20 +467,43 @@ module Datadog
         begin
           @sampler.sample!(trace_op)
         rescue StandardError => e
-          Datadog.logger.debug { "Failed to sample trace: #{e}" }
+          SAMPLE_TRACE_LOG_ONLY_ONCE.run do
+            Datadog.logger.warn { "Failed to sample trace: #{e.class.name} #{e} at #{Array(e.backtrace).first}" }
+          end
         end
       end
 
+      SAMPLE_TRACE_LOG_ONLY_ONCE = Core::Utils::OnlyOnce.new
+      private_constant :SAMPLE_TRACE_LOG_ONLY_ONCE
+
+      def sample_span(trace_op, span)
+        begin
+          @span_sampler.sample!(trace_op, span)
+        rescue StandardError => e
+          SAMPLE_SPAN_LOG_ONLY_ONCE.run do
+            Datadog.logger.warn { "Failed to sample span: #{e.class.name} #{e} at #{Array(e.backtrace).first}" }
+          end
+        end
+      end
+
+      SAMPLE_SPAN_LOG_ONLY_ONCE = Core::Utils::OnlyOnce.new
+      private_constant :SAMPLE_SPAN_LOG_ONLY_ONCE
+
       # Flush finished spans from the trace buffer, send them to writer.
       def flush_trace(trace_op)
         begin
           trace = @trace_flush.consume!(trace_op)
           write(trace) if trace && !trace.empty?
         rescue StandardError => e
-          Datadog.logger.debug { "Failed to flush trace: #{e}" }
+          FLUSH_TRACE_LOG_ONLY_ONCE.run do
+            Datadog.logger.warn { "Failed to flush trace: #{e.class.name} #{e} at #{Array(e.backtrace).first}" }
+          end
         end
       end
 
+      FLUSH_TRACE_LOG_ONLY_ONCE = Core::Utils::OnlyOnce.new
+      private_constant :FLUSH_TRACE_LOG_ONLY_ONCE
+
       # Send the trace to the writer to enqueue the spans list in the agent
       # sending queue.
       def write(trace)
@@ -500,6 +529,5 @@ module Datadog
         end
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/datadog/tracing/utils.rb

@@ -0,0 +1,50 @@
+# typed: true
+
+require_relative '../core/utils/forking'
+
+module Datadog
+  module Tracing
+    # Utils contains low-level tracing utility functions.
+    # @public_api
+    module Utils
+      extend Datadog::Core::Utils::Forking
+
+      # The max value for a {Datadog::Tracing::Span} identifier.
+      # Span and trace identifiers should be strictly positive and strictly inferior to this limit.
+      #
+      # Limited to +2<<62-1+ positive integers, as Ruby is able to represent such numbers "inline",
+      # inside a +VALUE+ scalar, thus not requiring memory allocation.
+      #
+      # The range of IDs also has to consider portability across different languages and platforms.
+      RUBY_MAX_ID = (1 << 62) - 1
+
+      # Excludes zero from possible values
+      RUBY_ID_RANGE = (1..RUBY_MAX_ID).freeze
+
+      # While we only generate 63-bit integers due to limitations in other languages, we support
+      # parsing 64-bit integers for distributed tracing since an upstream system may generate one
+      EXTERNAL_MAX_ID = 1 << 64
+
+      # We use a custom random number generator because we want no interference
+      # with the default one. Using the default prng, we could break code that
+      # would rely on srand/rand sequences.
+
+      # Return a randomly generated integer, valid as a Span ID or Trace ID.
+      # This method is thread-safe and fork-safe.
+      def self.next_id
+        after_fork! { reset! }
+        id_rng.rand(RUBY_ID_RANGE)
+      end
+
+      def self.id_rng
+        @id_rng ||= Random.new
+      end
+
+      def self.reset!
+        @id_rng = Random.new
+      end
+
+      private_class_method :id_rng, :reset!
+    end
+  end
+end

data/lib/datadog/tracing/workers/trace_writer.rb

@@ -1,16 +1,16 @@
 # typed: false
 
-require 'datadog/core'
-require 'datadog/core/worker'
-require 'datadog/core/workers/async'
-require 'datadog/core/workers/polling'
-require 'datadog/core/workers/queue'
+require_relative '../../core'
+require_relative '../../core/worker'
+require_relative '../../core/workers/async'
+require_relative '../../core/workers/polling'
+require_relative '../../core/workers/queue'
 
-require 'datadog/tracing/buffer'
-require 'datadog/tracing/pipeline'
-require 'datadog/tracing/event'
+require_relative '../buffer'
+require_relative '../pipeline'
+require_relative '../event'
 
-require 'ddtrace/transport/http'
+require_relative '../../../ddtrace/transport/http'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/workers.rb

@@ -1,9 +1,9 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../core'
 
-require 'datadog/tracing/buffer'
-require 'datadog/tracing/pipeline'
+require_relative 'buffer'
+require_relative 'pipeline'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/writer.rb

@@ -1,12 +1,12 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../core'
 
-require 'datadog/tracing/event'
-require 'datadog/tracing/runtime/metrics'
-require 'datadog/tracing/workers'
+require_relative 'event'
+require_relative 'runtime/metrics'
+require_relative 'workers'
 
-require 'ddtrace/transport/http'
+require_relative '../../ddtrace/transport/http'
 
 module Datadog
   module Tracing
@@ -175,6 +175,13 @@ module Datadog
           end
         end
       end
+
+      private
+
+      def reset_stats!
+        @traces_flushed = 0
+        @transport.stats.reset!
+      end
     end
   end
 end

data/lib/datadog/tracing.rb

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/core'
-require 'datadog/tracing/pipeline'
+require_relative 'core'
+require_relative 'tracing/pipeline'
 
 module Datadog
   # Datadog APM tracing public API.
@@ -18,7 +18,7 @@ module Datadog
         tracer.trace(name, continue_from: continue_from, **span_options, &block)
       end
 
-      # (see Datadog:::Tracing::Tracer#continue_trace!)
+      # (see Datadog::Tracing::Tracer#continue_trace!)
       # @public_api
       def continue_trace!(digest, &block)
         tracer.continue_trace!(digest, &block)
@@ -45,7 +45,7 @@ module Datadog
         current_tracer.active_trace
       end
 
-      # (see Datadog:::Tracing::Tracer#active_span)
+      # (see Datadog::Tracing::Tracer#active_span)
       # @public_api
       def active_span
         current_tracer = tracer
@@ -54,7 +54,7 @@ module Datadog
         current_tracer.active_span
       end
 
-      # (see Datadog:::Tracing::TraceSegment#keep!)
+      # (see Datadog::Tracing::TraceSegment#keep!)
       # If no trace is active, no action is taken.
       # @public_api
       def keep!
@@ -62,7 +62,7 @@ module Datadog
         active_trace.keep! if trace
       end
 
-      # (see Datadog:::Tracing::TraceSegment#reject!)
+      # (see Datadog::Tracing::TraceSegment#reject!)
       # If no trace is active, no action is taken.
       # @public_api
       def reject!
@@ -70,7 +70,7 @@ module Datadog
         active_trace.reject! if trace
       end
 
-      # (see Datadog:::Tracing::Tracer#active_correlation)
+      # (see Datadog::Tracing::Tracer#active_correlation)
       # @public_api
       def correlation
         current_tracer = tracer
@@ -113,7 +113,7 @@ module Datadog
         current_tracer.shutdown!
       end
 
-      # (see Datadog:::Tracing::Pipeline.before_flush)
+      # (see Datadog::Tracing::Pipeline.before_flush)
       def before_flush(*processors, &processor_block)
         Pipeline.before_flush(*processors, &processor_block)
       end

data/lib/ddtrace/auto_instrument.rb

@@ -3,7 +3,14 @@
 # Entrypoint file for auto instrumentation.
 #
 # This file's path is part of the @public_api.
-require 'ddtrace'
-require 'datadog/tracing/contrib/auto_instrument'
+require_relative '../ddtrace'
+require_relative '../datadog/tracing/contrib/auto_instrument'
 
 Datadog::Profiling.start_if_enabled
+
+module Datadog
+  module AutoInstrument
+    # Flag to determine if Auto Instrumentation was used
+    LOADED = true
+  end
+end

data/lib/ddtrace/transport/ext.rb

@@ -9,10 +9,16 @@ module Datadog
         ADAPTER = :net_http # DEV: Rename to simply `:http`, as Net::HTTP is an implementation detail.
         DEFAULT_HOST = '127.0.0.1'.freeze
         DEFAULT_PORT = 8126
-        DEFAULT_TIMEOUT_SECONDS = 1
 
         HEADER_CONTAINER_ID = 'Datadog-Container-ID'.freeze
         HEADER_DD_API_KEY = 'DD-API-KEY'.freeze
+        # Tells agent that `_dd.top_level` metrics have been set by the tracer.
+        # The agent will not calculate top-level spans but instead trust the tracer tagging.
+        #
+        # This prevents partially flushed traces being mistakenly marked as top-level.
+        #
+        # Setting this header to any non-empty value enables this feature.
+        HEADER_CLIENT_COMPUTED_TOP_LEVEL = 'Datadog-Client-Computed-Top-Level'.freeze
         HEADER_META_LANG = 'Datadog-Meta-Lang'.freeze
         HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'.freeze
         HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'.freeze

data/lib/ddtrace/transport/http/adapters/net.rb

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'ddtrace/transport/response'
-require 'datadog/core/vendor/multipart-post/net/http/post/multipart'
+require_relative '../../response'
+require_relative '../../../../datadog/core/vendor/multipart-post/net/http/post/multipart'
 
 module Datadog
   module Transport
@@ -15,6 +15,7 @@ module Datadog
             :timeout,
             :ssl
 
+          # in seconds
           DEFAULT_TIMEOUT = 30
 
           # @deprecated Positional parameters are deprecated. Use named parameters instead.

data/lib/ddtrace/transport/http/adapters/test.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'ddtrace/transport/response'
+require_relative '../../response'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/adapters/unix_socket.rb

@@ -1,8 +1,8 @@
 # typed: false
 
 require 'net/http'
-require 'ddtrace/transport/ext'
-require 'ddtrace/transport/http/adapters/net'
+require_relative '../../ext'
+require_relative 'net'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/api/map.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'ddtrace/transport/http/api/fallbacks'
+require_relative 'fallbacks'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/api.rb

@@ -1,11 +1,11 @@
 # typed: false
 
-require 'datadog/core/encoding'
+require_relative '../../../datadog/core/encoding'
 
-require 'ddtrace/transport/http/api/map'
-require 'ddtrace/transport/http/api/spec'
+require_relative 'api/map'
+require_relative 'api/spec'
 
-require 'ddtrace/transport/http/traces'
+require_relative 'traces'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/builder.rb

@@ -1,10 +1,10 @@
 # typed: true
 
-require 'datadog/core/configuration/agent_settings_resolver'
-require 'ddtrace/transport/http/adapters/registry'
-require 'ddtrace/transport/http/api/map'
-require 'ddtrace/transport/http/api/instance'
-require 'ddtrace/transport/http/client'
+require_relative '../../../datadog/core/configuration/agent_settings_resolver'
+require_relative 'adapters/registry'
+require_relative 'api/map'
+require_relative 'api/instance'
+require_relative 'client'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/client.rb

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'ddtrace/transport/http/statistics'
-require 'ddtrace/transport/http/env'
+require_relative 'statistics'
+require_relative 'env'
 
 module Datadog
   module Transport