ddtrace 0.54.2 → 1.0.0.beta1

data/lib/ddtrace/transport/http.rb

@@ -1,17 +1,15 @@
 # typed: true
-require 'ddtrace/version'
-require 'datadog/core/environment/ext'
-require 'ddtrace/ext/transport'
+require 'uri'
 
 require 'datadog/core/environment/container'
-
-require 'ddtrace/transport/http/builder'
-require 'ddtrace/transport/http/api'
-
+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 'uri'
+require 'ddtrace/transport/http/api'
+require 'ddtrace/transport/http/builder'
+require 'ddtrace/version'
 
 module Datadog
   module Transport
@@ -28,22 +26,18 @@ module Datadog
 
       # Builds a new Transport::HTTP::Client with default settings
       # Pass a block to override any settings.
-      def default(agent_settings: Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS, **options)
+      def default(
+        agent_settings: Datadog::Core::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS,
+        **options
+      )
         new do |transport|
           transport.adapter(agent_settings)
           transport.headers default_headers
 
-          if agent_settings.deprecated_for_removal_transport_configuration_options
-            # The deprecated_for_removal_transport_configuration_options take precedence over any options the caller
-            # specifies
-            options = options.merge(**agent_settings.deprecated_for_removal_transport_configuration_options)
-          end
-
           apis = API.defaults
 
           transport.api API::V4, apis[API::V4], fallback: API::V3, default: true
-          transport.api API::V3, apis[API::V3], fallback: API::V2
-          transport.api API::V2, apis[API::V2]
+          transport.api API::V3, apis[API::V3]
 
           # Apply any settings given by options
           unless options.empty?
@@ -62,19 +56,19 @@ module Datadog
 
       def default_headers
         {
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG => Datadog::Core::Environment::Ext::LANG,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_VERSION => Datadog::Core::Environment::Ext::LANG_VERSION,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Core::Environment::Ext::LANG_INTERPRETER,
-          Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION => Datadog::Core::Environment::Ext::TRACER_VERSION
+          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,
+          Datadog::Transport::Ext::HTTP::HEADER_META_TRACER_VERSION => Datadog::Core::Environment::Ext::TRACER_VERSION
         }.tap do |headers|
           # Add container ID, if present.
           container_id = Datadog::Core::Environment::Container.container_id
-          headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
+          headers[Datadog::Transport::Ext::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       end
 
       def default_adapter
-        Ext::Transport::HTTP::ADAPTER
+        Transport::Ext::HTTP::ADAPTER
       end
 
       def default_hostname(logger: Datadog.logger)
@@ -83,7 +77,7 @@ module Datadog
           'be removed on a future ddtrace release.'
         )
 
-        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.hostname
+        Datadog::Core::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.hostname
       end
 
       def default_port(logger: Datadog.logger)
@@ -92,7 +86,7 @@ module Datadog
           'be removed on a future ddtrace release.'
         )
 
-        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.port
+        Datadog::Core::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.port
       end
 
       def default_url(logger: Datadog.logger)
@@ -105,9 +99,9 @@ module Datadog
       end
 
       # Add adapters to registry
-      Builder::REGISTRY.set(Adapters::Net, Ext::Transport::HTTP::ADAPTER)
-      Builder::REGISTRY.set(Adapters::Test, Ext::Transport::Test::ADAPTER)
-      Builder::REGISTRY.set(Adapters::UnixSocket, Ext::Transport::UnixSocket::ADAPTER)
+      Builder::REGISTRY.set(Adapters::Net, Transport::Ext::HTTP::ADAPTER)
+      Builder::REGISTRY.set(Adapters::Test, Transport::Ext::Test::ADAPTER)
+      Builder::REGISTRY.set(Adapters::UnixSocket, Transport::Ext::UnixSocket::ADAPTER)
     end
   end
 end

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

@@ -67,7 +67,7 @@ module Datadog
 
           def encode_trace(trace)
             # Convert each trace to hash
-            trace.map(&:to_hash).tap do |spans|
+            trace.spans.map(&:to_hash).tap do |spans|
               # Convert IDs to hexadecimal
               spans.each do |span|
                 ENCODED_IDS.each do |id|

data/lib/ddtrace/transport/io.rb

@@ -1,5 +1,5 @@
 # typed: true
-require 'ddtrace/encoding'
+require 'datadog/core/encoding'
 require 'ddtrace/transport/io/client'
 require 'ddtrace/transport/io/traces'
 
@@ -19,7 +19,7 @@ module Datadog
       def default(options = {})
         new(
           options.fetch(:out, $stdout),
-          options.fetch(:encoder, Encoding::JSONEncoder)
+          options.fetch(:encoder, Core::Encoding::JSONEncoder)
         )
       end
     end

data/lib/ddtrace/transport/parcel.rb

@@ -2,6 +2,7 @@
 module Datadog
   module Transport
     # Data transfer object for generic data
+    # @abstract
     module Parcel
       include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
 

data/lib/ddtrace/transport/serializable_trace.rb

@@ -0,0 +1,116 @@
+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,6 @@
 # typed: true
-require 'ddtrace/diagnostics/health'
+require 'datadog/core/metrics/metric'
+require 'datadog/core/diagnostics/health'
 
 module Datadog
   module Transport
@@ -28,8 +29,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 +45,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,164 @@
+require 'datadog/core/environment/identity'
+require 'datadog/core/environment/socket'
+require 'datadog/core/runtime/ext'
+require 'datadog/tracing/metadata/ext'
+require '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.
+        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_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? || !@found_root_span
+
+        root_span.resource = trace.resource
+      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.get_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE)
+
+        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_PID,
+          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_priority!
+        return unless trace.sampling_priority
+
+        root_span.set_metric(
+          Tracing::Metadata::Ext::Distributed::TAG_SAMPLING_PRIORITY,
+          trace.sampling_priority
+        )
+      end
+
+      private
+
+      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?
+        root_span || trace.spans.last
+      end
+    end
+  end
+end

data/lib/ddtrace/transport/traces.rb

@@ -1,7 +1,9 @@
 # typed: true
+require 'datadog/core/chunker'
 require 'ddtrace/transport/parcel'
 require 'ddtrace/transport/request'
-require 'ddtrace/chunker'
+require 'ddtrace/transport/serializable_trace'
+require 'ddtrace/transport/trace_formatter'
 
 module Datadog
   module Transport
@@ -44,7 +46,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 +67,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
@@ -87,12 +89,19 @@ 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)
+
+          # Encode the trace
+          encoder.encode(serializable_trace)
         end
       end
 

data/lib/ddtrace/version.rb

@@ -1,10 +1,10 @@
 # typed: true
-module Datadog
+module DDTrace
   module VERSION
-    MAJOR = 0
-    MINOR = 54
-    PATCH = 2
-    PRE = nil
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    PRE = 'beta1'.freeze
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
 

data/lib/ddtrace.rb

@@ -1,52 +1,31 @@
-# 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'
+# Load tracing
+require 'datadog/tracing'
 
-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'
+# Load tracing extensions
+require 'datadog/tracing/contrib'
+require 'datadog/tracing/contrib/auto_instrument'
+require 'datadog/tracing/contrib/extensions'
+require 'datadog/opentelemetry/extensions'
 require 'ddtrace/auto_instrument_base'
-require 'ddtrace/profiling'
 
-require 'datadog/contrib'
-require 'ddtrace/contrib/auto_instrument'
-require 'ddtrace/contrib/extensions'
+# Load appsec
+require 'datadog/appsec/autoload' # TODO: datadog/appsec?
 
-require 'ddtrace/opentelemetry/extensions'
-
-# \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
+# Global namespace that includes all Datadog functionality.
+# @public_api
 module Datadog
-  extend Configuration
   extend AutoInstrumentBase
 
   # Load built-in Datadog integrations
-  extend Contrib::Extensions
+  Tracing::Contrib::Extensions.extend!
+
   # Load Contrib auto instrumentation
-  extend Contrib::AutoInstrument
-  # Load Contrib extension to global Datadog objects
-  Configuration::Settings.include Contrib::Extensions::Configuration::Settings
+  extend Tracing::Contrib::AutoInstrument
 
   # 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 'datadog/profiling'
+require 'datadog/ci'