ddtrace 0.49.0 → 0.52.0

data/lib/ddtrace/profiling/transport/http/api.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/api/map'
 require 'ddtrace/profiling/encoding/profile'
 require 'ddtrace/profiling/transport/http/api/spec'

data/lib/ddtrace/profiling/transport/http/api/endpoint.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/profiling'
 require 'ddtrace/utils/compression'
 require 'ddtrace/vendor/multipart-post/multipart/post/composite_read_io'
@@ -14,10 +15,15 @@ module Datadog
           class Endpoint < Datadog::Transport::HTTP::API::Endpoint
             include Datadog::Ext::Profiling::Transport::HTTP
 
+            # These tags are read from the flush object (see below) directly and so we ignore any extra copies that
+            # may come in the tags hash to avoid duplicates.
+            TAGS_TO_IGNORE_IN_TAGS_HASH = %w[service env version].freeze
+            private_constant :TAGS_TO_IGNORE_IN_TAGS_HASH
+
             attr_reader \
               :encoder
 
-            def initialize(path, encoder, options = {})
+            def initialize(path, encoder)
               super(:post, path)
               @encoder = encoder
             end
@@ -52,7 +58,11 @@ module Datadog
                   "#{FORM_FIELD_TAG_PROFILER_VERSION}:#{flush.profiler_version}",
                   # NOTE: Redundant w/ 'runtime'; may want to remove this later.
                   "#{FORM_FIELD_TAG_LANGUAGE}:#{flush.language}",
-                  "#{FORM_FIELD_TAG_HOST}:#{flush.host}"
+                  "#{FORM_FIELD_TAG_HOST}:#{flush.host}",
+                  *flush
+                    .tags
+                    .reject { |tag_key| TAGS_TO_IGNORE_IN_TAGS_HASH.include?(tag_key) }
+                    .map { |tag_key, tag_value| "#{tag_key}:#{tag_value}" }
                 ],
                 FORM_FIELD_DATA => pprof_file,
                 FORM_FIELD_RUNTIME => flush.language,

data/lib/ddtrace/profiling/transport/http/api/instance.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/api/instance'
 require 'ddtrace/profiling/transport/http/api/spec'
 

data/lib/ddtrace/profiling/transport/http/api/spec.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/api/spec'
 
 module Datadog

data/lib/ddtrace/profiling/transport/http/builder.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/builder'
 
 require 'ddtrace/profiling/transport/http/api'

data/lib/ddtrace/profiling/transport/http/client.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/client'
 require 'ddtrace/profiling/transport/client'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/response'
 require 'ddtrace/profiling/transport/response'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/profiling/transport/io/client'
 require 'ddtrace/profiling/encoding/profile'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/io/client'
 require 'ddtrace/profiling/transport/client'
 require 'ddtrace/profiling/transport/request'

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

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace/transport/io/response'
 require 'ddtrace/profiling/transport/response'
 

data/lib/ddtrace/profiling/transport/parcel.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/parcel'
 
 module Datadog

data/lib/ddtrace/profiling/transport/request.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/request'
 require 'ddtrace/profiling/transport/parcel'
 

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

@@ -1,3 +1,4 @@
+# typed: strict
 module Datadog
   module Profiling
     module Transport

data/lib/ddtrace/propagation/grpc_propagator.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/context'
 require 'ddtrace/ext/distributed'
 

data/lib/ddtrace/propagation/http_propagator.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/configuration'
 require 'ddtrace/context'
 require 'ddtrace/ext/distributed'
@@ -31,7 +32,7 @@ module Datadog
         rescue => e
           Datadog.logger.error(
             'Error injecting propagated context into the environment. ' \
-            "Cause: #{e} Location: #{e.backtrace.first}"
+            "Cause: #{e} Location: #{Array(e.backtrace).first}"
           )
         end
       end
@@ -54,7 +55,7 @@ module Datadog
         rescue => e
           Datadog.logger.error(
             'Error extracting propagated context from the environment. ' \
-            "Cause: #{e} Location: #{e.backtrace.first}"
+            "Cause: #{e} Location: #{Array(e.backtrace).first}"
           )
         end
 

data/lib/ddtrace/quantization/hash.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Quantization
     # Quantization for HTTP resources

data/lib/ddtrace/quantization/http.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'uri'
 require 'set'
 
@@ -5,6 +6,8 @@ module Datadog
   module Quantization
     # Quantization for HTTP resources
     module HTTP
+      include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
       PLACEHOLDER = '?'.freeze
 
       module_function

data/lib/ddtrace/runtime/metrics.rb

@@ -1,17 +1,18 @@
+# typed: true
 require 'ddtrace/ext/integration'
 require 'ddtrace/ext/runtime'
 
 require 'ddtrace/metrics'
-require 'ddtrace/runtime/class_count'
-require 'ddtrace/runtime/gc'
-require 'ddtrace/runtime/identity'
-require 'ddtrace/runtime/thread_count'
+require 'datadog/core/environment/class_count'
+require 'datadog/core/environment/gc'
+require 'datadog/core/environment/identity'
+require 'datadog/core/environment/thread_count'
 
 module Datadog
   module Runtime
     # For generating runtime metrics
     class Metrics < Datadog::Metrics
-      def initialize(options = {})
+      def initialize(**options)
         super
 
         # Initialize service list
@@ -29,7 +30,7 @@ module Datadog
         # Tag span with language and runtime ID for association with metrics.
         # We only tag spans that performed internal application work.
         unless span.get_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE)
-          span.set_tag(Ext::Runtime::TAG_LANG, Runtime::Identity.lang)
+          span.set_tag(Ext::Runtime::TAG_LANG, Core::Environment::Identity.lang)
         end
       end
 
@@ -52,17 +53,23 @@ module Datadog
       def flush
         return unless enabled?
 
-        try_flush { gauge(Ext::Runtime::Metrics::METRIC_CLASS_COUNT, ClassCount.value) if ClassCount.available? }
-        try_flush { gauge(Ext::Runtime::Metrics::METRIC_THREAD_COUNT, ThreadCount.value) if ThreadCount.available? }
-        try_flush { gc_metrics.each { |metric, value| gauge(metric, value) } if GC.available? }
+        try_flush do
+          if Core::Environment::ClassCount.available?
+            gauge(Ext::Runtime::Metrics::METRIC_CLASS_COUNT, Core::Environment::ClassCount.value)
+          end
+        end
+        try_flush do
+          if Core::Environment::ThreadCount.available?
+            gauge(Ext::Runtime::Metrics::METRIC_THREAD_COUNT, Core::Environment::ThreadCount.value)
+          end
+        end
+        try_flush { gc_metrics.each { |metric, value| gauge(metric, value) } if Core::Environment::GC.available? }
       end
 
       def gc_metrics
-        Hash[
-          GC.stat.flat_map do |k, v|
-            nested_gc_metric(Ext::Runtime::Metrics::METRIC_GC_PREFIX, k, v)
-          end
-        ]
+        Core::Environment::GC.stat.flat_map do |k, v|
+          nested_gc_metric(Ext::Runtime::Metrics::METRIC_GC_PREFIX, k, v)
+        end.to_h
       end
 
       def try_flush

data/lib/ddtrace/sampler.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'forwardable'
 
 require 'ddtrace/ext/priority'

data/lib/ddtrace/sampling.rb

@@ -1,2 +1,3 @@
+# typed: strict
 require 'ddtrace/sampling/rule'
 require 'ddtrace/sampling/rule_sampler'

data/lib/ddtrace/sampling/matcher.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Sampling
     # Checks if a span conforms to a matching criteria.

data/lib/ddtrace/sampling/rate_limiter.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/utils/time'
 
 module Datadog

data/lib/ddtrace/sampling/rule.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'forwardable'
 
 require 'ddtrace/sampling/matcher'
@@ -28,7 +29,7 @@ module Datadog
       def match?(span)
         @matcher.match?(span)
       rescue => e
-        Datadog.logger.error("Matcher failed. Cause: #{e.message} Source: #{e.backtrace.first}")
+        Datadog.logger.error("Matcher failed. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
         nil
       end
 

data/lib/ddtrace/sampling/rule_sampler.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'forwardable'
 
 require 'ddtrace/ext/priority'
@@ -104,7 +105,7 @@ module Datadog
           set_limiter_metrics(span, rate_limiter.effective_rate)
         end
       rescue StandardError => e
-        Datadog.logger.error("Rule sampling failed. Cause: #{e.message} Source: #{e.backtrace.first}")
+        Datadog.logger.error("Rule sampling failed. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
         yield(span)
       end
 

data/lib/ddtrace/span.rb

@@ -1,10 +1,14 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'time'
 require 'ddtrace/utils'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/ext/environment'
 require 'ddtrace/ext/errors'
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/net'
 require 'ddtrace/ext/priority'
-require 'ddtrace/environment'
 require 'ddtrace/analytics'
 require 'ddtrace/forced_tracing'
 require 'ddtrace/diagnostics/health'
@@ -38,12 +42,28 @@ module Datadog
     # This limit is for numeric tags because uint64 could end up rounded.
     NUMERIC_TAG_SIZE_RANGE = (-1 << 53..1 << 53).freeze
 
-    attr_accessor :name, :service, :resource, :span_type,
+    # Some associated values should always be sent as Tags, never as Metrics, regardless
+    # if their value is numeric or not.
+    # The Datadog agent will look for these values only as Tags, not Metrics.
+    # @see https://github.com/DataDog/datadog-agent/blob/2ae2cdd315bcda53166dd8fa0dedcfc448087b9d/pkg/trace/stats/aggregation.go#L13-L17
+    ENSURE_AGENT_TAGS = {
+      Ext::DistributedTracing::ORIGIN_KEY => true,
+      Ext::Environment::TAG_VERSION => true,
+      Ext::HTTP::STATUS_CODE => true,
+      Ext::NET::TAG_HOSTNAME => true
+    }.freeze
+
+    # Simple indirection used to contain the latest resource name for a span.
+    # The profiler keeps a reference to these objects while sampling so it can extract the latest resource after the
+    # fact, as some integrations only set the correct name at the end of the span.
+    ResourceContainer = Struct.new(:latest)
+
+    attr_accessor :name, :service, :span_type,
                   :span_id, :trace_id, :parent_id,
                   :status, :sampled,
                   :tracer, :context
 
-    attr_reader :parent, :start_time, :end_time
+    attr_reader :parent, :start_time, :end_time, :resource_container
 
     attr_writer :duration
 
@@ -61,7 +81,7 @@ module Datadog
 
       @name = name
       @service = options.fetch(:service, nil)
-      @resource = options.fetch(:resource, name)
+      @resource_container = ResourceContainer.new(options.fetch(:resource, name))
       @span_type = options.fetch(:span_type, nil)
 
       @span_id = Datadog::Utils.next_id
@@ -101,11 +121,8 @@ module Datadog
       # Keys must be unique between tags and metrics
       @metrics.delete(key)
 
-      # Ensure `http.status_code` is always a string so it is added to
-      #   @meta instead of @metrics
-      # DEV: This is necessary because the agent looks to `meta['http.status_code']` for
-      #   tagging necessary metrics
-      value = value.to_s if key == Ext::HTTP::STATUS_CODE
+      # DEV: This is necessary because the agent looks at `meta[key]`, not `metrics[key]`.
+      value = value.to_s if ENSURE_AGENT_TAGS[key]
 
       # NOTE: Adding numeric tags as metrics is stop-gap support
       #       for numeric typed tags. Eventually they will become
@@ -272,7 +289,7 @@ module Datadog
         trace_id: @trace_id,
         name: @name,
         service: @service,
-        resource: @resource,
+        resource: resource,
         type: @span_type,
         meta: @meta,
         metrics: @metrics,
@@ -326,7 +343,7 @@ module Datadog
       packer.write('service')
       packer.write(@service)
       packer.write('resource')
-      packer.write(@resource)
+      packer.write(resource)
       packer.write('type')
       packer.write(@span_type)
       packer.write('meta')
@@ -358,7 +375,7 @@ module Datadog
         q.text "Trace ID: #{@trace_id}\n"
         q.text "Type: #{@span_type}\n"
         q.text "Service: #{@service}\n"
-        q.text "Resource: #{@resource}\n"
+        q.text "Resource: #{resource}\n"
         q.text "Error: #{@status}\n"
         q.text "Start: #{start_time}\n"
         q.text "End: #{end_time}\n"
@@ -397,6 +414,14 @@ module Datadog
       end
     end
 
+    def resource
+      @resource_container.latest
+    end
+
+    def resource=(resource)
+      @resource_container.latest = resource
+    end
+
     private
 
     def duration_marker

data/lib/ddtrace/sync_writer.rb

@@ -1,5 +1,6 @@
+# typed: true
 require 'ddtrace/ext/net'
-require 'ddtrace/runtime/socket'
+require 'datadog/core/environment/socket'
 require 'ddtrace/runtime/metrics'
 require 'ddtrace/utils/only_once'
 
@@ -20,7 +21,8 @@ module Datadog
     def initialize(options = {})
       @transport = options.fetch(:transport) do
         transport_options = options.fetch(:transport_options, {})
-        Transport::HTTP.default(transport_options)
+        transport_options[:agent_settings] = options[:agent_settings] if options.key?(:agent_settings)
+        Transport::HTTP.default(**transport_options)
       end
 
       @priority_sampler = options.fetch(:priority_sampler, nil)
@@ -59,7 +61,7 @@ module Datadog
 
     def inject_hostname!(trace)
       unless trace.first.nil?
-        hostname = Datadog::Runtime::Socket.hostname
+        hostname = Datadog::Core::Environment::Socket.hostname
         trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname) unless hostname.nil? || hostname.empty?
       end
     end

data/lib/ddtrace/tasks/exec.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Tasks
     # Wraps command with Datadog tracing
@@ -22,11 +23,9 @@ module Datadog
       private
 
       def set_rubyopt!
-        if ENV.key?('RUBYOPT')
-          ENV['RUBYOPT'] += " #{rubyopts.join(' ')}"
-        else
-          ENV['RUBYOPT'] = rubyopts.join(' ')
-        end
+        existing_rubyopt = ENV['RUBYOPT']
+
+        ENV['RUBYOPT'] = existing_rubyopt ? "#{existing_rubyopt} #{rubyopts.join(' ')}" : rubyopts.join(' ')
       end
 
       # If there's an error here, rather than throwing a cryptic stack trace, let's instead have clearer messages, and

data/lib/ddtrace/tasks/help.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Tasks
     # Prints help message for usage of `ddtrace`

data/lib/ddtrace/tracer.rb

@@ -1,12 +1,13 @@
+# typed: true
 require 'logger'
 require 'pathname'
 
-require 'ddtrace/environment'
+require 'ddtrace/ext/environment'
 require 'ddtrace/span'
 require 'ddtrace/context'
 require 'ddtrace/logger'
 require 'ddtrace/writer'
-require 'ddtrace/runtime/identity'
+require 'datadog/core/environment/identity'
 require 'ddtrace/sampler'
 require 'ddtrace/sampling'
 require 'ddtrace/correlation'
@@ -74,7 +75,9 @@ module Datadog
     #   by default.
     def initialize(options = {})
       # Configurable options
-      @context_flush = if options[:partial_flush]
+      @context_flush = if options[:context_flush]
+                         options[:context_flush]
+                       elsif options[:partial_flush]
                          Datadog::ContextFlush::Partial.new(options)
                        else
                          Datadog::ContextFlush::Finished.new
@@ -82,14 +85,13 @@ module Datadog
 
       @default_service = options[:default_service]
       @enabled = options.fetch(:enabled, true)
-      @provider = options.fetch(:context_provider, Datadog::DefaultContextProvider.new)
+      @provider = options[:context_provider] || Datadog::DefaultContextProvider.new
       @sampler = options.fetch(:sampler, Datadog::AllSampler.new)
       @tags = options.fetch(:tags, {})
       @writer = options.fetch(:writer) { Datadog::Writer.new }
 
       # Instance variables
       @mutex = Mutex.new
-      @provider ||= Datadog::DefaultContextProvider.new # @provider should never be nil
 
       # Enable priority sampling by default
       activate_priority_sampling!(@sampler)
@@ -118,8 +120,10 @@ module Datadog
 
       configure_writer(options)
 
-      if options.key?(:partial_flush)
-        @context_flush = if options[:partial_flush]
+      if options.key?(:context_flush) || options.key?(:partial_flush)
+        @context_flush = if options[:context_flush]
+                           options[:context_flush]
+                         elsif options[:partial_flush]
                            Datadog::ContextFlush::Partial.new(options)
                          else
                            Datadog::ContextFlush::Finished.new
@@ -145,15 +149,7 @@ module Datadog
     # for non-root spans which have a parent. However, root spans without
     # a service would be invalid and rejected.
     def default_service
-      return @default_service if instance_variable_defined?(:@default_service) && @default_service
-
-      begin
-        @default_service = File.basename($PROGRAM_NAME, '.*')
-      rescue StandardError => e
-        Datadog.logger.error("unable to guess default service: #{e}")
-        @default_service = 'ruby'.freeze
-      end
-      @default_service
+      @default_service ||= Datadog::Ext::Environment::FALLBACK_SERVICE_NAME
     end
 
     # Set the given key / value tag pair at the tracer level. These tags will be
@@ -162,7 +158,7 @@ module Datadog
     #
     #   tracer.set_tags('env' => 'prod', 'component' => 'core')
     def set_tags(tags)
-      string_tags = Hash[tags.collect { |k, v| [k.to_s, v] }]
+      string_tags = tags.collect { |k, v| [k.to_s, v] }.to_h
       @tags = @tags.merge(string_tags)
     end
 
@@ -205,7 +201,7 @@ module Datadog
         # root span
         @sampler.sample!(span)
         span.set_tag('system.pid', Process.pid)
-        span.set_tag(Datadog::Ext::Runtime::TAG_ID, Datadog::Runtime::Identity.id)
+        span.set_tag(Datadog::Ext::Runtime::TAG_ID, Datadog::Core::Environment::Identity.id)
 
         if ctx && ctx.trace_id
           span.trace_id = ctx.trace_id