ddtrace 1.12.1 → 1.23.2

data/lib/datadog/tracing/transport/io/traces.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative '../../transport/traces'
+require_relative '../../../core/transport/parcel'
+require_relative 'response'
+require_relative 'client'
+
+module Datadog
+  module Tracing
+    module Transport
+      module IO
+        # IO transport behavior for traces
+        module Traces
+          # Response from HTTP transport for traces
+          class Response < IO::Response
+            include Transport::Traces::Response
+
+            def initialize(result, trace_count = 1)
+              super(result)
+              @trace_count = trace_count
+            end
+          end
+
+          # Extensions for HTTP client
+          module Client
+            def send_traces(traces)
+              # Build a request
+              req = Transport::Traces::Request.new(Parcel.new(traces))
+
+              [send_request(req) do |out, request|
+                # Encode trace data
+                data = encode_data(encoder, request)
+
+                # Write to IO
+                result = if block_given?
+                           yield(out, data)
+                         else
+                           write_data(out, data)
+                         end
+
+                # 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.spans.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 Datadog::Core::Transport::Parcel
+            include Encoder
+
+            def count
+              data.length
+            end
+
+            def encode_with(encoder)
+              encode_traces(encoder, data)
+            end
+          end
+
+          # Add traces behavior to transport components
+          IO::Client.include(Traces::Client)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/transport/io.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../../core/encoding'
+require_relative 'io/client'
+require_relative 'io/traces'
+
+module Datadog
+  module Tracing
+    module Transport
+      # Namespace for IO transport components
+      module IO
+        module_function
+
+        # Builds a new Transport::IO::Client
+        def new(out, encoder)
+          Client.new(out, encoder)
+        end
+
+        # Builds a new Transport::IO::Client with default settings
+        # Pass options to override any settings.
+        def default(options = {})
+          new(
+            options.fetch(:out, $stdout),
+            options.fetch(:encoder, Core::Encoding::JSONEncoder)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/transport/serializable_trace.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'msgpack'
+require 'datadog/tracing/utils'
+
+module Datadog
+  module Tracing
+    module Transport
+      # Adds serialization functions to a {Datadog::TraceSegment}
+      class SerializableTrace
+        attr_reader \
+          :trace
+
+        def initialize(trace)
+          @trace = trace
+        end
+
+        # MessagePack serializer interface. Making this object
+        # respond to `#to_msgpack` allows it to be automatically
+        # serialized by MessagePack.
+        #
+        # This is more efficient than doing +MessagePack.pack(span.to_hash)+
+        # as we don't have to create an intermediate Hash.
+        #
+        # @param packer [MessagePack::Packer] serialization buffer, can be +nil+ with JRuby
+        def to_msgpack(packer = nil)
+          # As of 1.3.3, JRuby implementation doesn't pass an existing packer
+          trace.spans.map { |s| SerializableSpan.new(s) }.to_msgpack(packer)
+        end
+
+        # JSON serializer interface.
+        # Used by older version of the transport.
+        def to_json(*args)
+          trace.spans.map { |s| SerializableSpan.new(s).to_hash }.to_json(*args)
+        end
+      end
+
+      # Adds serialization functions to a {Datadog::Span}
+      class SerializableSpan
+        attr_reader \
+          :span
+
+        def initialize(span)
+          @span = span
+          @trace_id = Tracing::Utils::TraceId.to_low_order(span.trace_id)
+        end
+
+        # MessagePack serializer interface. Making this object
+        # respond to `#to_msgpack` allows it to be automatically
+        # serialized by MessagePack.
+        #
+        # This is more efficient than doing +MessagePack.pack(span.to_hash)+
+        # as we don't have to create an intermediate Hash.
+        #
+        # @param packer [MessagePack::Packer] serialization buffer, can be +nil+ with JRuby
+        # rubocop:disable Metrics/AbcSize
+        def to_msgpack(packer = nil)
+          packer ||= MessagePack::Packer.new
+
+          number_of_elements_to_write = 10
+
+          if span.stopped?
+            packer.write_map_header(number_of_elements_to_write + 2) # Set header with how many elements in the map
+
+            packer.write('start')
+            packer.write(time_nano(span.start_time))
+
+            packer.write('duration')
+            packer.write(duration_nano(span.duration))
+          else
+            packer.write_map_header(number_of_elements_to_write) # Set header with how many elements in the map
+          end
+
+          # DEV: We use strings as keys here, instead of symbols, as
+          # DEV: MessagePack will ultimately convert them to strings.
+          # DEV: By providing strings directly, we skip this indirection operation.
+          packer.write('span_id')
+          packer.write(span.id)
+          packer.write('parent_id')
+          packer.write(span.parent_id)
+          packer.write('trace_id')
+          packer.write(@trace_id)
+          packer.write('name')
+          packer.write(span.name)
+          packer.write('service')
+          packer.write(span.service)
+          packer.write('resource')
+          packer.write(span.resource)
+          packer.write('type')
+          packer.write(span.type)
+          packer.write('meta')
+          packer.write(span.meta)
+          packer.write('metrics')
+          packer.write(span.metrics)
+          packer.write('error')
+          packer.write(span.status)
+          packer
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        # JSON serializer interface.
+        # Used by older version of the transport.
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+
+        # Used for serialization
+        # @return [Integer] in nanoseconds since Epoch
+        def time_nano(time)
+          time.to_i * 1000000000 + time.nsec
+        end
+
+        def to_hash
+          span.to_hash.merge(trace_id: @trace_id)
+        end
+
+        # Used for serialization
+        # @return [Integer] in nanoseconds since Epoch
+        def duration_nano(duration)
+          (duration * 1e9).to_i
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/transport/statistics.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../../core/metrics/metric'
+require_relative '../../core/diagnostics/health'
+
+module Datadog
+  module Tracing
+    module Transport
+      # Tracks statistics for transports
+      module Statistics
+        def stats
+          @stats ||= Counts.new
+        end
+
+        def update_stats_from_response!(response)
+          if response.ok?
+            stats.success += 1
+            stats.consecutive_errors = 0
+          else
+            stats.client_error += 1 if response.client_error?
+            stats.server_error += 1 if response.server_error?
+            stats.internal_error += 1 if response.internal_error?
+            stats.consecutive_errors += 1
+          end
+
+          # Send health metrics
+          Datadog.health_metrics.send_metrics(
+            metrics_for_response(response).values
+          )
+        end
+
+        def metrics_for_response(response)
+          {}.tap do |metrics|
+            metrics[:api_errors] = Core::Metrics::Metric.new(:api_errors, nil, 1) if response.internal_error?
+            metrics[:api_responses] = Core::Metrics::Metric.new(:api_responses, nil, 1) unless response.internal_error?
+          end
+        end
+
+        def update_stats_from_exception!(exception)
+          stats.internal_error += 1
+          stats.consecutive_errors += 1
+
+          # Send health metrics
+          Datadog.health_metrics.send_metrics(
+            metrics_for_exception(exception).values
+          )
+        end
+
+        def metrics_for_exception(_exception)
+          { api_errors: Core::Metrics::Metric.new(:api_errors, nil, 1) }
+        end
+
+        # Stat counts
+        class Counts
+          attr_accessor \
+            :success,
+            :client_error,
+            :server_error,
+            :internal_error,
+            :consecutive_errors
+
+          def initialize
+            reset!
+          end
+
+          def reset!
+            @success = 0
+            @client_error = 0
+            @server_error = 0
+            @internal_error = 0
+            @consecutive_errors = 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/transport/trace_formatter.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require_relative '../../core/environment/identity'
+require_relative '../../core/environment/socket'
+require_relative '../../core/environment/git'
+require_relative '../../core/git/ext'
+require_relative '../../core/runtime/ext'
+require_relative '../metadata/ext'
+require_relative '../trace_segment'
+
+module Datadog
+  module Tracing
+    module Transport
+      # Prepares traces for transport
+      class TraceFormatter
+        attr_reader \
+          :root_span,
+          :first_span,
+          :trace
+
+        def self.format!(trace)
+          new(trace).format!
+        end
+
+        def initialize(trace)
+          @trace = trace
+          @root_span = find_root_span(trace)
+          # source code integration uses the "first span in trace chunk" concept instead of root span
+          # see: https://github.com/DataDog/dd-trace-rb/pull/3424
+          @first_span = trace.spans.first
+        end
+
+        # Modifies a trace so suitable for transport
+        def format!
+          return unless trace
+          return trace unless root_span
+
+          # Because the trace API does not support
+          # trace metadata, we must put our trace
+          # metadata on the root span. This "root span"
+          # is needed by the agent/API to ingest the trace.
+
+          # Apply generic trace tags. Any more specific value will be overridden
+          # by the subsequent calls below.
+          set_trace_tags!
+
+          set_resource!
+
+          tag_agent_sample_rate!
+          tag_hostname!
+          tag_lang!
+          tag_origin!
+          tag_process_id!
+          tag_rule_sample_rate!
+          tag_runtime_id!
+          tag_rate_limiter_rate!
+          tag_sample_rate!
+          tag_sampling_decision_maker!
+          tag_high_order_trace_id!
+          tag_sampling_priority!
+          tag_profiling_enabled!
+
+          if first_span
+            tag_git_repository_url!
+            tag_git_commit_sha!
+          end
+
+          trace
+        end
+
+        protected
+
+        def set_resource!
+          # If the trace resource is undefined, or the root span wasn't
+          # specified, don't set this. We don't want to overwrite the
+          # resource of a span that is in the middle of the trace.
+          return if trace.resource.nil? || partial?
+
+          root_span.resource = trace.resource
+        end
+
+        def set_trace_tags!
+          # If the root span wasn't specified, don't set this. We don't want to
+          # misset or overwrite the tags of a span that is in the middle of the
+          # trace.
+          return if partial?
+
+          root_span.set_tags(trace.send(:meta))
+          root_span.set_tags(trace.send(:metrics))
+        end
+
+        def tag_agent_sample_rate!
+          return unless trace.agent_sample_rate
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::Sampling::TAG_AGENT_RATE,
+            trace.agent_sample_rate
+          )
+        end
+
+        def tag_hostname!
+          return unless trace.hostname
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::NET::TAG_HOSTNAME,
+            trace.hostname
+          )
+        end
+
+        def tag_lang!
+          return if trace.lang.nil?
+
+          root_span.set_tag(
+            Core::Runtime::Ext::TAG_LANG,
+            trace.lang
+          )
+        end
+
+        def tag_origin!
+          return unless trace.origin
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::Distributed::TAG_ORIGIN,
+            trace.origin
+          )
+        end
+
+        def tag_process_id!
+          return unless trace.process_id
+
+          root_span.set_tag(Core::Runtime::Ext::TAG_PROCESS_ID, trace.process_id)
+        end
+
+        def tag_rate_limiter_rate!
+          return unless trace.rate_limiter_rate
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::Sampling::TAG_RATE_LIMITER_RATE,
+            trace.rate_limiter_rate
+          )
+        end
+
+        def tag_rule_sample_rate!
+          return unless trace.rule_sample_rate
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::Sampling::TAG_RULE_SAMPLE_RATE,
+            trace.rule_sample_rate
+          )
+        end
+
+        def tag_runtime_id!
+          return unless trace.runtime_id
+
+          root_span.set_tag(
+            Core::Runtime::Ext::TAG_ID,
+            trace.runtime_id
+          )
+        end
+
+        def tag_sample_rate!
+          return unless trace.sample_rate
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::Sampling::TAG_SAMPLE_RATE,
+            trace.sample_rate
+          )
+        end
+
+        def tag_sampling_decision_maker!
+          return unless (decision = trace.sampling_decision_maker)
+
+          root_span.set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, decision)
+        end
+
+        def tag_sampling_priority!
+          return unless trace.sampling_priority
+
+          root_span.set_metric(
+            Tracing::Metadata::Ext::Distributed::TAG_SAMPLING_PRIORITY,
+            trace.sampling_priority
+          )
+        end
+
+        def tag_high_order_trace_id!
+          return unless (high_order_tid = trace.high_order_tid)
+
+          root_span.set_tag(Tracing::Metadata::Ext::Distributed::TAG_TID, high_order_tid)
+        end
+
+        def tag_profiling_enabled!
+          return if trace.profiling_enabled.nil?
+
+          root_span.set_tag(
+            Tracing::Metadata::Ext::TAG_PROFILING_ENABLED, trace.profiling_enabled ? 1 : 0
+          )
+        end
+
+        def tag_git_repository_url!
+          return if git_repository_url.nil?
+
+          first_span.set_tag(Core::Git::Ext::TAG_REPOSITORY_URL, git_repository_url)
+        end
+
+        def tag_git_commit_sha!
+          return if git_commit_sha.nil?
+
+          first_span.set_tag(Core::Git::Ext::TAG_COMMIT_SHA, git_commit_sha)
+        end
+
+        private
+
+        def partial?
+          !@found_root_span
+        end
+
+        def find_root_span(trace)
+          # TODO: Should we memoize this?
+          #       Would be safe, but `spans` is mutable, so if
+          #       the root span were removed, it would be a stale reference.
+          #       Figure out a better way to deal with this.
+          root_span_id = trace.send(:root_span_id)
+          root_span = trace.spans.find { |s| s.id == root_span_id } if root_span_id
+          @found_root_span = !root_span.nil?
+
+          # when root span is not found, fall back to last span (partial flush)
+          root_span || trace.spans.last
+        end
+
+        def git_repository_url
+          Core::Environment::Git.git_repository_url
+        end
+
+        def git_commit_sha
+          Core::Environment::Git.git_commit_sha
+        end
+      end
+    end
+  end
+end