ddtrace 0.53.0 → 1.9.0

data/lib/ddtrace/transport/serializable_trace.rb

@@ -0,0 +1,118 @@
+# typed: true
+
+require 'json'
+require 'msgpack'
+
+module Datadog
+  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(&:to_hash).to_json(*args)
+      end
+    end
+
+    # Adds serialization functions to a {Datadog::Span}
+    class SerializableSpan
+      attr_reader \
+        :span
+
+      def initialize(span)
+        @span = span
+      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(span.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)
+        span.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
+
+      # Used for serialization
+      # @return [Integer] in nanoseconds since Epoch
+      def duration_nano(duration)
+        (duration * 1e9).to_i
+      end
+    end
+  end
+end

data/lib/ddtrace/transport/statistics.rb

@@ -1,5 +1,7 @@
 # typed: true
-require 'ddtrace/diagnostics/health'
+
+require_relative '../../datadog/core/metrics/metric'
+require_relative '../../datadog/core/diagnostics/health'
 
 module Datadog
   module Transport
@@ -28,8 +30,8 @@ module Datadog
 
       def metrics_for_response(response)
         {}.tap do |metrics|
-          metrics[:api_errors] = Metrics::Metric.new(:api_errors, nil, 1) if response.internal_error?
-          metrics[:api_responses] = Metrics::Metric.new(:api_responses, nil, 1) unless response.internal_error?
+          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
 
@@ -44,7 +46,7 @@ module Datadog
       end
 
       def metrics_for_exception(_exception)
-        { api_errors: Metrics::Metric.new(:api_errors, nil, 1) }
+        { api_errors: Core::Metrics::Metric.new(:api_errors, nil, 1) }
       end
 
       # Stat counts

data/lib/ddtrace/transport/trace_formatter.rb

@@ -0,0 +1,191 @@
+# typed: true
+
+require_relative '../../datadog/core/environment/identity'
+require_relative '../../datadog/core/environment/socket'
+require_relative '../../datadog/core/runtime/ext'
+require_relative '../../datadog/tracing/metadata/ext'
+require_relative '../../datadog/tracing/trace_segment'
+
+module Datadog
+  module Transport
+    # Prepares traces for transport
+    class TraceFormatter
+      attr_reader \
+        :root_span,
+        :trace
+
+      def self.format!(trace)
+        new(trace).format!
+      end
+
+      def initialize(trace)
+        @trace = trace
+        @root_span = find_root_span(trace)
+      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_sampling_priority!
+
+        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
+
+      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
+    end
+  end
+end

data/lib/ddtrace/transport/traces.rb

@@ -1,7 +1,10 @@
 # typed: true
-require 'ddtrace/transport/parcel'
-require 'ddtrace/transport/request'
-require 'ddtrace/chunker'
+
+require_relative '../../datadog/core/chunker'
+require_relative 'parcel'
+require_relative 'request'
+require_relative 'serializable_trace'
+require_relative 'trace_formatter'
 
 module Datadog
   module Transport
@@ -44,7 +47,7 @@ module Datadog
         #
         # Single traces larger than +max_size+ will be discarded.
         #
-        # @param encoder [Datadog::Encoding::Encoder]
+        # @param encoder [Datadog::Core::Encoding::Encoder]
         # @param max_size [String] maximum acceptable payload size
         def initialize(encoder, max_size: DEFAULT_MAX_PAYLOAD_SIZE)
           @encoder = encoder
@@ -65,7 +68,7 @@ module Datadog
                              traces.map { |t| encode_one(t) }.reject(&:nil?)
                            end
 
-          Datadog::Chunker.chunk_by_size(encoded_traces, max_size).map do |chunk|
+          Datadog::Core::Chunker.chunk_by_size(encoded_traces, max_size).map do |chunk|
             [encoder.join(chunk), chunk.size]
           end
         end
@@ -77,7 +80,7 @@ module Datadog
 
           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.logger.debug { "Dropping trace. Payload too large: '#{trace.inspect}'" }
             Datadog.health_metrics.transport_trace_too_large(1)
 
             return nil
@@ -87,12 +90,21 @@ module Datadog
         end
       end
 
-      # Encodes traces using {Datadog::Encoding::Encoder} instances.
+      # Encodes traces using {Datadog::Core::Encoding::Encoder} instances.
       module Encoder
         module_function
 
         def encode_trace(encoder, trace)
-          encoder.encode(trace)
+          # Format the trace for transport
+          TraceFormatter.format!(trace)
+
+          # Make the trace serializable
+          serializable_trace = SerializableTrace.new(trace)
+
+          Datadog.logger.debug { "Flushing trace: #{JSON.dump(serializable_trace)}" }
+
+          # Encode the trace
+          encoder.encode(serializable_trace)
         end
       end
 

data/lib/ddtrace/version.rb

@@ -1,8 +1,9 @@
 # typed: true
-module Datadog
+
+module DDTrace
   module VERSION
-    MAJOR = 0
-    MINOR = 53
+    MAJOR = 1
+    MINOR = 9
     PATCH = 0
     PRE = nil
 
@@ -10,16 +11,17 @@ module Datadog
 
     MINIMUM_RUBY_VERSION = '2.1.0'.freeze
 
-    # Ruby 3.2 is not supported: Ruby 3.x support as implemented using *args
-    # needs ruby2_keywords to continue working, yet the scheduled removal of
-    # ruby2_keywords when Ruby 2.6 is EOL'd (i.e on Ruby 3.2 release) would
-    # leave the code with no option, other than to move to *args, **kwargs.
+    # A maximum version was initially added in https://github.com/DataDog/dd-trace-rb/pull/1495 because we expected
+    # the `ruby2_keywords` method to be removed (see the PR for the discussion).
+    # That is because Ruby 3.x support as implemented using `*args` needs `ruby2_keywords` to continue working,
+    # but if `ruby2_keywords` gets removed we would need to change the code to use `*args, **kwargs`.
     #
-    # See https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+    # Now Ruby 3.2.0-preview1 is out and `ruby2_keywords` are still there, and there's even a recent change for it
+    # in https://github.com/ruby/ruby/pull/5684 that is documented as "ruby2_keywords needed in 3.2+".
     #
-    # This constraint can only be removed when the dependency on ruby2_keywords is
-    # dropped. An allowance is nonetheless made to test prerelease versions.
-    # The version constraint may be bumped if the removal is postponed.
-    MAXIMUM_RUBY_VERSION = '3.2'.freeze
+    # So for now let's bump the maximum version to < 3.3 to allow the Ruby 3.2 series to be supported and we can keep
+    # an eye on the Ruby 3.2 test releases to see if anything changes. (Otherwise, once Ruby 3.2.0 stable is out, we
+    # should probably bump this to 3.4, and so on...)
+    MAXIMUM_RUBY_VERSION = '3.3'.freeze
   end
 end

data/lib/ddtrace.rb

@@ -1,52 +1,13 @@
 # typed: strict
-# During development, we load `ddtrace` by through `ddtrace.gemspec`,
-# which in turn eager loads 'ddtrace/version'.
-#
-# Users load this gem by requiring this file.
-# We need to ensure that any files loaded in our gemspec are also loaded here.
-require 'ddtrace/version'
 
-require 'ddtrace/pin'
-require 'ddtrace/tracer'
-require 'ddtrace/error'
-require 'ddtrace/quantization/hash'
-require 'ddtrace/quantization/http'
-require 'ddtrace/pipeline'
-require 'ddtrace/configuration'
-require 'ddtrace/patcher'
-require 'ddtrace/metrics'
-require 'ddtrace/auto_instrument_base'
-require 'ddtrace/profiling'
+# Load tracing
+require_relative 'datadog/tracing'
+require_relative 'datadog/tracing/contrib'
 
-require 'datadog/contrib'
-require 'ddtrace/contrib/auto_instrument'
-require 'ddtrace/contrib/extensions'
+# Load appsec
+require_relative 'datadog/appsec/autoload' # TODO: datadog/appsec?
 
-require 'ddtrace/opentelemetry/extensions'
-
-# \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
-module Datadog
-  extend Configuration
-  extend AutoInstrumentBase
-
-  # Load built-in Datadog integrations
-  extend Contrib::Extensions
-  # Load Contrib auto instrumentation
-  extend Contrib::AutoInstrument
-  # Load Contrib extension to global Datadog objects
-  Configuration::Settings.include Contrib::Extensions::Configuration::Settings
-
-  # Load and extend OpenTelemetry compatibility by default
-  extend OpenTelemetry::Extensions
-
-  # Add shutdown hook:
-  # Ensures the tracer has an opportunity to flush traces
-  # and cleanup before terminating the process.
-  at_exit do
-    if Interrupt === $! # rubocop:disable Style/SpecialGlobalVars is process terminating due to a ctrl+c or similar?
-      Datadog.send(:handle_interrupt_shutdown!)
-    else
-      Datadog.shutdown!
-    end
-  end
-end
+# Load other products (must follow tracing)
+require_relative 'datadog/profiling'
+require_relative 'datadog/ci'
+require_relative 'datadog/kit'