ddtrace 0.34.1 → 0.36.0

data/lib/ddtrace/transport/io.rb

@@ -18,7 +18,7 @@ module Datadog
       def default(options = {})
         new(
           options.fetch(:out, STDOUT),
-          options.fetch(:encoder, Encoding::JSONEncoder::V2)
+          options.fetch(:encoder, Encoding::JSONEncoder)
         )
       end
     end

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

@@ -37,9 +37,9 @@ module Datadog
 
           # Log error
           if stats.consecutive_errors > 0
-            Datadog::Logger.log.debug(message)
+            Datadog.logger.debug(message)
           else
-            Datadog::Logger.log.error(message)
+            Datadog.logger.error(message)
           end
 
           # Update statistics

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

@@ -6,12 +6,14 @@ module Datadog
       # Response from HTTP transport for traces
       class Response
         include Transport::Response
+        include Transport::Traces::Response
 
         attr_reader \
           :result
 
-        def initialize(result)
+        def initialize(result, trace_count = 1)
           @result = result
+          @trace_count = trace_count
         end
 
         def ok?

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

@@ -10,16 +10,15 @@ module Datadog
       module Traces
         # Response from HTTP transport for traces
         class Response < IO::Response
-          include Transport::Traces::Response
         end
 
         # Extensions for HTTP client
         module Client
           def send_traces(traces)
             # Build a request
-            req = Transport::Traces::Request.new(traces)
+            req = Transport::Traces::Request.new(Parcel.new(traces))
 
-            send_request(req) do |out, request|
+            [send_request(req) do |out, request|
               # Encode trace data
               data = encode_data(encoder, request)
 
@@ -32,7 +31,55 @@ module Datadog
 
               # Generate response
               Traces::Response.new(result)
+            end]
+          end
+        end
+
+        # Encoder for IO-specific trace encoding
+        # API compliant when used with {JSONEncoder}.
+        module Encoder
+          ENCODED_IDS = [
+            :trace_id,
+            :span_id,
+            :parent_id
+          ].freeze
+
+          # Encodes a list of traces
+          def encode_traces(encoder, traces)
+            trace_hashes = traces.map do |trace|
+              encode_trace(trace)
             end
+
+            # Wrap traces & encode them
+            encoder.encode(traces: trace_hashes)
+          end
+
+          private
+
+          def encode_trace(trace)
+            # Convert each trace to hash
+            trace.map(&:to_hash).tap do |spans|
+              # Convert IDs to hexadecimal
+              spans.each do |span|
+                ENCODED_IDS.each do |id|
+                  span[id] = span[id].to_s(16) if span.key?(id)
+                end
+              end
+            end
+          end
+        end
+
+        # Transfer object for list of traces
+        class Parcel
+          include Transport::Parcel
+          include Encoder
+
+          def count
+            data.length
+          end
+
+          def encode_with(encoder)
+            encode_traces(encoder, data)
           end
         end
 

data/lib/ddtrace/transport/parcel.rb

@@ -8,10 +8,6 @@ module Datadog
       def initialize(data)
         @data = data
       end
-
-      def encode_with(encoder)
-        encoder.encode(data)
-      end
     end
   end
 end

data/lib/ddtrace/transport/statistics.rb

@@ -20,7 +20,7 @@ module Datadog
         end
 
         # Send health metrics
-        Diagnostics::Health.metrics.send_metrics(
+        Datadog.health_metrics.send_metrics(
           metrics_for_response(response).values
         )
       end
@@ -37,7 +37,7 @@ module Datadog
         stats.consecutive_errors += 1
 
         # Send health metrics
-        Diagnostics::Health.metrics.send_metrics(
+        Datadog.health_metrics.send_metrics(
           metrics_for_exception(exception).values
         )
       end

data/lib/ddtrace/transport/traces.rb

@@ -1,32 +1,182 @@
 require 'ddtrace/transport/parcel'
 require 'ddtrace/transport/request'
+require 'ddtrace/chunker'
 
 module Datadog
   module Transport
     module Traces
-      # Data transfer object for trace data
-      class Parcel
+      # Data transfer object for encoded traces
+      class EncodedParcel
         include Transport::Parcel
 
-        def count
-          data.length
+        attr_reader :trace_count
+
+        def initialize(data, trace_count)
+          super(data)
+          @trace_count = trace_count
         end
 
-        def encode_with(encoder)
-          encoder.encode_traces(data)
+        def count
+          data.length
         end
       end
 
       # Traces request
       class Request < Transport::Request
-        def initialize(traces)
-          super(Parcel.new(traces))
-        end
       end
 
       # Traces response
       module Response
-        attr_reader :service_rates
+        attr_reader :service_rates, :trace_count
+      end
+
+      # Traces chunker
+      class Chunker
+        # Trace agent limit payload size of 10 MiB (since agent v5.11.0):
+        # https://github.com/DataDog/datadog-agent/blob/6.14.1/pkg/trace/api/api.go#L46
+        #
+        # We set the value to a conservative 5 MiB, in case network speed is slow.
+        DEFAULT_MAX_PAYLOAD_SIZE = 5 * 1024 * 1024
+
+        attr_reader :encoder, :max_size
+
+        #
+        # Single traces larger than +max_size+ will be discarded.
+        #
+        # @param encoder [Datadog::Encoding::Encoder]
+        # @param max_size [String] maximum acceptable payload size
+        def initialize(encoder, max_size: DEFAULT_MAX_PAYLOAD_SIZE)
+          @encoder = encoder
+          @max_size = max_size
+        end
+
+        # Encodes a list of traces in chunks.
+        # Before serializing, all traces are normalized. Trace nesting is not changed.
+        #
+        # @param traces [Enumerable<Trace>] list of traces
+        # @return [Enumerable[Array[Bytes,Integer]]] list of encoded chunks: each containing a byte array and
+        #   number of traces
+        def encode_in_chunks(traces)
+          encoded_traces = traces.map { |t| encode_one(t) }.reject(&:nil?)
+
+          Datadog::Chunker.chunk_by_size(encoded_traces, max_size).map do |chunk|
+            [encoder.join(chunk), chunk.size]
+          end
+        end
+
+        private
+
+        def encode_one(trace)
+          encoded = Encoder.encode_trace(encoder, trace)
+
+          if encoded.size > max_size
+            # This single trace is too large, we can't flush it
+            Datadog.logger.debug { "Dropping trace. Payload too large: '#{trace.map(&:to_hash)}'" }
+            Datadog.health_metrics.transport_trace_too_large(1)
+
+            return nil
+          end
+
+          encoded
+        end
+      end
+
+      # Encodes traces using {Datadog::Encoding::Encoder} instances.
+      module Encoder
+        module_function
+
+        def encode_trace(encoder, trace)
+          encoder.encode(trace.map(&:to_hash))
+        end
+      end
+
+      # Sends traces based on transport API configuration.
+      #
+      # This class initializes the HTTP client, breaks down large
+      # batches of traces into smaller chunks and handles
+      # API version downgrade handshake.
+      class Transport
+        attr_reader :client, :apis, :default_api, :current_api_id
+
+        def initialize(apis, default_api)
+          @apis = apis
+          @default_api = default_api
+
+          change_api!(default_api)
+        end
+
+        def send_traces(traces)
+          encoder = current_api.encoder
+          chunker = Datadog::Transport::Traces::Chunker.new(encoder)
+
+          responses = chunker.encode_in_chunks(traces.lazy).map do |encoded_traces, trace_count|
+            request = Request.new(EncodedParcel.new(encoded_traces, trace_count))
+
+            client.send_payload(request).tap do |response|
+              if downgrade?(response)
+                downgrade!
+                return send_traces(traces)
+              end
+            end
+          end.force
+
+          Datadog.health_metrics.transport_chunked(responses.size)
+
+          responses
+        end
+
+        def stats
+          @client.stats
+        end
+
+        def current_api
+          apis[@current_api_id]
+        end
+
+        private
+
+        def downgrade?(response)
+          return false unless apis.fallbacks.key?(@current_api_id)
+          response.not_found? || response.unsupported?
+        end
+
+        def downgrade!
+          downgrade_api_id = apis.fallbacks[@current_api_id]
+          raise NoDowngradeAvailableError, @current_api_id if downgrade_api_id.nil?
+          change_api!(downgrade_api_id)
+        end
+
+        def change_api!(api_id)
+          raise UnknownApiVersionError, api_id unless apis.key?(api_id)
+          @current_api_id = api_id
+          @client = HTTP::Client.new(current_api)
+        end
+
+        # Raised when configured with an unknown API version
+        class UnknownApiVersionError < StandardError
+          attr_reader :version
+
+          def initialize(version)
+            @version = version
+          end
+
+          def message
+            "No matching transport API for version #{version}!"
+          end
+        end
+
+        # Raised when configured with an unknown API version
+        class NoDowngradeAvailableError < StandardError
+          attr_reader :version
+
+          def initialize(version)
+            @version = version
+          end
+
+          def message
+            "No downgrade from transport API version #{version} is available!"
+          end
+        end
       end
     end
   end

data/lib/ddtrace/utils.rb

@@ -57,7 +57,7 @@ module Datadog
         str.encode(::Encoding::UTF_8)
       end
     rescue => e
-      Logger.log.debug("Error encoding string in UTF-8: #{e}")
+      Datadog.logger.debug("Error encoding string in UTF-8: #{e}")
 
       options.fetch(:placeholder, STRING_PLACEHOLDER)
     end

data/lib/ddtrace/version.rb

@@ -1,8 +1,8 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 34
-    PATCH = 1
+    MINOR = 36
+    PATCH = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

data/lib/ddtrace/workers.rb

@@ -1,5 +1,8 @@
 require 'time'
 
+require 'ddtrace/workers/trace_writer'
+require 'ddtrace/workers/runtime_metrics'
+
 require 'ddtrace/buffer'
 require 'ddtrace/runtime/metrics'
 
@@ -25,7 +28,6 @@ module Datadog
 
         # Callbacks
         @trace_task = options[:on_trace]
-        @runtime_metrics_task = options[:on_runtime_metrics]
 
         # Intervals
         interval = options.fetch(:interval, DEFAULT_FLUSH_INTERVAL)
@@ -55,26 +57,18 @@ module Datadog
           # ensures that the thread will not die because of an exception.
           # TODO[manu]: findout the reason and reschedule the send if it's not
           # a fatal exception
-          Datadog::Logger.log.error(
+          Datadog.logger.error(
             "Error during traces flush: dropped #{traces.length} items. Cause: #{e} Location: #{e.backtrace.first}"
           )
         end
       end
 
-      def callback_runtime_metrics
-        @runtime_metrics_task.call unless @runtime_metrics_task.nil?
-      rescue StandardError => e
-        Datadog::Logger.log.error(
-          "Error during runtime metrics flush. Cause: #{e} Location: #{e.backtrace.first}"
-        )
-      end
-
       # Start the timer execution.
       def start
         @mutex.synchronize do
           return if @run
           @run = true
-          Logger.log.debug("Starting thread in the process: #{Process.pid}")
+          Datadog.logger.debug("Starting thread in the process: #{Process.pid}")
           @worker = Thread.new { perform }
         end
       end
@@ -112,8 +106,6 @@ module Datadog
         loop do
           @back_off = flush_data ? @flush_interval : [@back_off * BACK_OFF_RATIO, BACK_OFF_MAX].min
 
-          callback_runtime_metrics
-
           @mutex.synchronize do
             return if !@run && @trace_buffer.empty?
             @shutdown.wait(@mutex, @back_off) if @run # do not wait when shutting down

data/lib/ddtrace/workers/async.rb

@@ -121,7 +121,7 @@ module Datadog
           @run_async = true
           @pid = Process.pid
           @error = nil
-          Logger.log.debug("Starting thread in the process: #{Process.pid}")
+          Datadog.logger.debug("Starting thread in the process: #{Process.pid}")
 
           @worker = ::Thread.new do
             begin
@@ -129,7 +129,7 @@ module Datadog
             # rubocop:disable Lint/RescueException
             rescue Exception => e
               @error = e
-              Logger.log.debug("Worker thread error. Cause #{e.message} Location: #{e.backtrace.first}")
+              Datadog.logger.debug("Worker thread error. Cause #{e.message} Location: #{e.backtrace.first}")
               raise
             end
           end

data/lib/ddtrace/workers/runtime_metrics.rb

@@ -0,0 +1,47 @@
+require 'forwardable'
+
+require 'ddtrace/runtime/metrics'
+
+require 'ddtrace/worker'
+require 'ddtrace/workers/polling'
+
+module Datadog
+  module Workers
+    # Emits runtime metrics asynchronously on a timed loop
+    class RuntimeMetrics < Worker
+      extend Forwardable
+      include Workers::Polling
+
+      attr_reader \
+        :metrics
+
+      def initialize(options = {})
+        @metrics = options.fetch(:metrics, Runtime::Metrics.new)
+
+        # Workers::Async::Thread settings
+        self.fork_policy = options.fetch(:fork_policy, Workers::Async::Thread::FORK_POLICY_STOP)
+
+        # Workers::IntervalLoop settings
+        self.interval = options[:interval] if options.key?(:interval)
+        self.back_off_ratio = options[:back_off_ratio] if options.key?(:back_off_ratio)
+        self.back_off_max = options[:back_off_max] if options.key?(:back_off_max)
+
+        self.enabled = options.fetch(:enabled, false)
+      end
+
+      def perform
+        metrics.flush
+        true
+      end
+
+      def associate_with_span(*args)
+        # Start the worker
+        metrics.associate_with_span(*args).tap { perform }
+      end
+
+      def_delegators \
+        :metrics,
+        :register_service
+    end
+  end
+end