ddtrace 1.0.0 → 1.9.0

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
@@ -29,7 +29,8 @@ module Datadog
           response
         rescue StandardError => e
           message =
-            "Internal error during HTTP transport request. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+            "Internal error during #{self.class.name} request. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
 
           # Log error
           if stats.consecutive_errors > 0

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

@@ -1,7 +1,6 @@
 # typed: false
 
-require 'forwardable'
-require 'ddtrace/transport/response'
+require_relative '../response'
 
 module Datadog
   module Transport
@@ -11,13 +10,44 @@ module Datadog
       # Used by endpoints to wrap responses from adapters with
       # fields or behavior that's specific to that endpoint.
       module Response
-        extend ::Forwardable
-
         def initialize(http_response)
           @http_response = http_response
         end
 
-        def_delegators :@http_response, *Datadog::Transport::Response.instance_methods
+        # (see Datadog::Transport::Response#payload)
+        def payload
+          @http_response.payload
+        end
+
+        # (see Datadog::Transport::Response#internal_error?)
+        def internal_error?
+          @http_response.internal_error?
+        end
+
+        # (see Datadog::Transport::Response#unsupported?)
+        def unsupported?
+          @http_response.unsupported?
+        end
+
+        # (see Datadog::Transport::Response#ok?)
+        def ok?
+          @http_response.ok?
+        end
+
+        # (see Datadog::Transport::Response#not_found?)
+        def not_found?
+          @http_response.not_found?
+        end
+
+        # (see Datadog::Transport::Response#client_error?)
+        def client_error?
+          @http_response.client_error?
+        end
+
+        # (see Datadog::Transport::Response#server_error?)
+        def server_error?
+          @http_response.server_error?
+        end
 
         def code
           @http_response.respond_to?(:code) ? @http_response.code : nil

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

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

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

@@ -2,11 +2,11 @@
 
 require 'json'
 
-require 'ddtrace/transport/traces'
-require 'ddtrace/transport/http/client'
-require 'ddtrace/transport/http/response'
-require 'ddtrace/transport/http/api/endpoint'
-require 'ddtrace/transport/http/api/instance'
+require_relative '../traces'
+require_relative 'client'
+require_relative 'response'
+require_relative 'api/endpoint'
+require_relative 'api/instance'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 # typed: true
 
 require 'uri'
 
-require 'datadog/core/environment/container'
-require 'datadog/core/environment/ext'
-require 'ddtrace/transport/ext'
-require 'ddtrace/transport/http/adapters/net'
-require 'ddtrace/transport/http/adapters/test'
-require 'ddtrace/transport/http/adapters/unix_socket'
-require 'ddtrace/transport/http/api'
-require 'ddtrace/transport/http/builder'
-require 'ddtrace/version'
+require_relative '../../datadog/core/environment/container'
+require_relative '../../datadog/core/environment/ext'
+require_relative 'ext'
+require_relative 'http/adapters/net'
+require_relative 'http/adapters/test'
+require_relative 'http/adapters/unix_socket'
+require_relative 'http/api'
+require_relative 'http/builder'
+require_relative '../version'
 
 module Datadog
   module Transport
@@ -67,6 +69,7 @@ module Datadog
 
       def default_headers
         {
+          Datadog::Transport::Ext::HTTP::HEADER_CLIENT_COMPUTED_TOP_LEVEL => '1',
           Datadog::Transport::Ext::HTTP::HEADER_META_LANG => Datadog::Core::Environment::Ext::LANG,
           Datadog::Transport::Ext::HTTP::HEADER_META_LANG_VERSION => Datadog::Core::Environment::Ext::LANG_VERSION,
           Datadog::Transport::Ext::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Core::Environment::Ext::LANG_INTERPRETER,

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

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'ddtrace/transport/statistics'
-require 'ddtrace/transport/io/response'
+require_relative '../statistics'
+require_relative 'response'
 
 module Datadog
   module Transport
@@ -40,7 +40,9 @@ module Datadog
           # Return response
           response
         rescue StandardError => e
-          message = "Internal error during IO transport request. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+          message =
+            "Internal error during IO transport request. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
 
           # Log error
           if stats.consecutive_errors > 0

data/lib/ddtrace/transport/io/response.rb

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

data/lib/ddtrace/transport/io/traces.rb

@@ -1,9 +1,9 @@
 # typed: false
 
-require 'ddtrace/transport/traces'
+require_relative '../traces'
 
-require 'ddtrace/transport/io/response'
-require 'ddtrace/transport/io/client'
+require_relative 'response'
+require_relative 'client'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/io.rb

@@ -1,8 +1,8 @@
 # typed: true
 
-require 'datadog/core/encoding'
-require 'ddtrace/transport/io/client'
-require 'ddtrace/transport/io/traces'
+require_relative '../../datadog/core/encoding'
+require_relative 'io/client'
+require_relative 'io/traces'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/statistics.rb

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'datadog/core/metrics/metric'
-require 'datadog/core/diagnostics/health'
+require_relative '../../datadog/core/metrics/metric'
+require_relative '../../datadog/core/diagnostics/health'
 
 module Datadog
   module Transport