ddtrace 0.51.1 → 0.54.1

data/lib/ddtrace/profiling.rb

@@ -1,28 +1,36 @@
+# typed: true
+require 'datadog/core/environment/variable_helpers'
+require 'ddtrace/utils/only_once'
+
 module Datadog
   # Contains profiler for generating stack profiles, etc.
-  module Profiling
-    module_function
-
+  module Profiling # rubocop:disable Metrics/ModuleLength
     GOOGLE_PROTOBUF_MINIMUM_VERSION = Gem::Version.new('3.0')
     private_constant :GOOGLE_PROTOBUF_MINIMUM_VERSION
 
-    def supported?
+    SKIPPED_NATIVE_EXTENSION_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    private_constant :SKIPPED_NATIVE_EXTENSION_ONLY_ONCE
+
+    def self.supported?
       unsupported_reason.nil?
     end
 
-    def unsupported_reason
+    def self.unsupported_reason
       # NOTE: Only the first matching reason is returned, so try to keep a nice order on reasons -- e.g. tell users
       # first that they can't use this on JRuby before telling them that they are missing protobuf
 
-      ruby_engine_unsupported? || protobuf_gem_unavailable? || protobuf_version_unsupported? || protobuf_failed_to_load?
+      ruby_engine_unsupported? ||
+        native_library_failed_to_load? ||
+        protobuf_gem_unavailable? ||
+        protobuf_version_unsupported? ||
+        protobuf_failed_to_load?
     end
 
-    def self.ruby_engine_unsupported?
+    private_class_method def self.ruby_engine_unsupported?
       'JRuby is not supported' if RUBY_ENGINE == 'jruby'
     end
-    private_class_method :ruby_engine_unsupported?
 
-    def self.protobuf_gem_unavailable?
+    private_class_method def self.protobuf_gem_unavailable?
       # NOTE: On environments where protobuf is already loaded, we skip the check. This allows us to support environments
       # where no Gem.loaded_version is NOT available but customers are able to load protobuf; see for instance
       # https://github.com/teamcapybara/capybara/commit/caf3bcd7664f4f2691d0ca9ef3be9a2a954fecfb
@@ -30,9 +38,8 @@ module Datadog
         "Missing google-protobuf dependency; please add `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
       end
     end
-    private_class_method :protobuf_gem_unavailable?
 
-    def self.protobuf_version_unsupported?
+    private_class_method def self.protobuf_version_unsupported?
       # See above for why we skip the check when protobuf is already loaded; note that when protobuf was already loaded
       # we skip the version check to avoid the call to Gem.loaded_specs. Unfortunately, protobuf does not seem to
       # expose the gem version constant elsewhere, so in that setup we are not able to check the version.
@@ -41,14 +48,12 @@ module Datadog
         "adding `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
       end
     end
-    private_class_method :protobuf_version_unsupported?
 
-    def self.protobuf_failed_to_load?
+    private_class_method def self.protobuf_failed_to_load?
       unless protobuf_loaded_successfully?
         'There was an error loading the google-protobuf library; see previous warning message for details'
       end
     end
-    private_class_method :protobuf_failed_to_load?
 
     # The `google-protobuf` gem depends on a native component, and its creators helpfully tried to provide precompiled
     # versions of this extension on rubygems.org.
@@ -59,7 +64,7 @@ module Datadog
     #
     # Thus, the gem can still be installed, but can be in a broken state. To avoid breaking customer applications, we
     # use this helper to load it and gracefully handle failures.
-    def self.protobuf_loaded_successfully?
+    private_class_method def self.protobuf_loaded_successfully?
       return @protobuf_loaded if defined?(@protobuf_loaded)
 
       begin
@@ -69,7 +74,8 @@ module Datadog
         # NOTE: We use Kernel#warn here because this code gets run BEFORE Datadog.logger is actually set up.
         # In the future it'd be nice to shuffle the logger startup to happen first to avoid this special case.
         Kernel.warn(
-          "[DDTRACE] Error while loading google-protobuf gem. Cause: '#{e.message}' Location: '#{e.backtrace.first}'. " \
+          '[DDTRACE] Error while loading google-protobuf gem. ' \
+          "Cause: '#{e.message}' Location: '#{Array(e.backtrace).first}'. " \
           'This can happen when google-protobuf is missing its native components. ' \
           'To fix this, try removing and reinstalling the gem, forcing it to recompile the components: ' \
           '`gem uninstall google-protobuf -a; BUNDLE_FORCE_RUBY_PLATFORM=true bundle install`. ' \
@@ -79,14 +85,50 @@ module Datadog
         @protobuf_loaded = false
       end
     end
-    private_class_method :protobuf_loaded_successfully?
 
-    def self.load_profiling
+    private_class_method def self.native_library_failed_to_load?
+      success, exception = try_loading_native_library
+
+      unless success
+        if exception
+          'There was an error loading the profiling native extension due to ' \
+          "'#{exception.message}' at '#{exception.backtrace.first}'"
+        else
+          'The profiling native extension did not load correctly. ' \
+          'If the error persists, please contact support via <https://docs.datadoghq.com/help/> or ' \
+          'file a bug at <https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug>.'
+        end
+      end
+    end
+
+    private_class_method def self.try_loading_native_library
+      if Datadog::Core::Environment::VariableHelpers.env_to_bool('DD_PROFILING_NO_EXTENSION', false)
+        SKIPPED_NATIVE_EXTENSION_ONLY_ONCE.run do
+          Kernel.warn(
+            '[DDTRACE] Skipped loading of profiling native extension due to DD_PROFILING_NO_EXTENSION environment ' \
+            'variable being set. ' \
+            'This option is experimental and will lead to the profiler not working in future releases. ' \
+            'If you needed to use this, please tell us why on <https://github.com/DataDog/dd-trace-rb/issues/new>.'
+          )
+        end
+
+        return [true, nil]
+      end
+
+      begin
+        require "ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
+        success =
+          defined?(Datadog::Profiling::NativeExtension) && Datadog::Profiling::NativeExtension.send(:native_working?)
+        [success, nil]
+      rescue StandardError, LoadError => e
+        [false, e]
+      end
+    end
+
+    private_class_method def self.load_profiling
       return false unless supported?
 
-      require 'ddtrace/profiling/ext/cpu'
       require 'ddtrace/profiling/ext/forking'
-
       require 'ddtrace/profiling/collectors/stack'
       require 'ddtrace/profiling/exporter'
       require 'ddtrace/profiling/recorder'
@@ -95,12 +137,12 @@ module Datadog
       require 'ddtrace/profiling/transport/io'
       require 'ddtrace/profiling/transport/http'
       require 'ddtrace/profiling/profiler'
-
+      require 'ddtrace/profiling/native_extension'
+      require 'ddtrace/profiling/trace_identifiers/helper'
       require 'ddtrace/profiling/pprof/pprof_pb'
 
       true
     end
-    private_class_method :load_profiling
 
     load_profiling if supported?
   end

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,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/integration'
 require 'ddtrace/ext/runtime'
 
@@ -6,6 +7,7 @@ require 'datadog/core/environment/class_count'
 require 'datadog/core/environment/gc'
 require 'datadog/core/environment/identity'
 require 'datadog/core/environment/thread_count'
+require 'datadog/core/environment/vm_cache'
 
 module Datadog
   module Runtime
@@ -57,12 +59,25 @@ module Datadog
             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? }
+
+        try_flush do
+          if Core::Environment::VMCache.available?
+            gauge(Ext::Runtime::Metrics::METRIC_GLOBAL_CONSTANT_STATE, Core::Environment::VMCache.global_constant_state)
+
+            # global_method_state is not available since Ruby >= 3.0,
+            # as method caching was moved to a per-class basis.
+            global_method_state = Core::Environment::VMCache.global_method_state
+            gauge(Ext::Runtime::Metrics::METRIC_GLOBAL_METHOD_STATE, global_method_state) if global_method_state
+          end
+        end
       end
 
       def gc_metrics

data/lib/ddtrace/sampler.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'forwardable'
 
 require 'ddtrace/ext/priority'
@@ -193,6 +194,12 @@ module Datadog
   class PrioritySampler
     extend Forwardable
 
+    # NOTE: We do not advise using a pre-sampler. It can save resources,
+    # but pre-sampling at rates < 100% may result in partial traces, unless
+    # the pre-sampler knows exactly how to drop a span without dropping its ancestors.
+    #
+    # Additionally, as service metrics are calculated in the Datadog Agent,
+    # the service's throughput will be underestimated.
     attr_reader :pre_sampler, :priority_sampler
 
     SAMPLE_RATE_METRIC_KEY = '_sample_rate'.freeze
@@ -208,17 +215,21 @@ module Datadog
 
     def sample!(span)
       # If pre-sampling is configured, do it first. (By default, this will sample at 100%.)
-      # NOTE: Pre-sampling at rates < 100% may result in partial traces; not recommended.
       span.sampled = pre_sample?(span) ? @pre_sampler.sample!(span) : true
 
       if span.sampled
-        # If priority sampling has already been applied upstream, use that, otherwise...
-        unless priority_assigned_upstream?(span)
-          # Roll the dice and determine whether how we set the priority.
-          priority = priority_sample!(span) ? Datadog::Ext::Priority::AUTO_KEEP : Datadog::Ext::Priority::AUTO_REJECT
+        # If priority sampling has already been applied upstream, use that value.
+        return true if priority_assigned?(span)
 
-          assign_priority!(span, priority)
-        end
+        # Check with post sampler how we set the priority.
+        sample = priority_sample!(span)
+
+        # Check if post sampler has already assigned a priority.
+        return true if priority_assigned?(span)
+
+        # If not, use agent priority values.
+        priority = sample ? Datadog::Ext::Priority::AUTO_KEEP : Datadog::Ext::Priority::AUTO_REJECT
+        assign_priority!(span, priority)
       else
         # If discarded by pre-sampling, set "reject" priority, so other
         # services for the same trace don't sample needlessly.
@@ -243,7 +254,7 @@ module Datadog
       end
     end
 
-    def priority_assigned_upstream?(span)
+    def priority_assigned?(span)
       span.context && !span.context.sampling_priority.nil?
     end
 

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'
@@ -96,18 +97,30 @@ module Datadog
         sampled = rule.sample?(span)
         sample_rate = rule.sample_rate(span)
 
+        set_priority(span, sampled)
         set_rule_metrics(span, sample_rate)
 
         return false unless sampled
 
-        rate_limiter.allow?(1).tap do
+        rate_limiter.allow?(1).tap do |allowed|
+          set_priority(span, allowed)
           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
 
+      # Span priority should only be set when the {RuleSampler}
+      # was responsible for the sampling decision.
+      def set_priority(span, sampled)
+        if sampled
+          ForcedTracing.keep(span)
+        else
+          ForcedTracing.drop(span)
+        end
+      end
+
       def set_rule_metrics(span, sample_rate)
         span.set_metric(Ext::Sampling::RULE_SAMPLE_RATE, sample_rate)
       end

data/lib/ddtrace/sampling.rb

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

data/lib/ddtrace/span.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'time'
@@ -57,7 +58,7 @@ module Datadog
                   :status, :sampled,
                   :tracer, :context
 
-    attr_reader :parent, :start_time, :end_time
+    attr_reader :parent, :start_time, :end_time, :resource_container
 
     attr_writer :duration
 
@@ -65,7 +66,8 @@ module Datadog
     # and then <tt>finish()</tt> once the tracer operation is over.
     #
     # * +service+: the service name for this span
-    # * +resource+: the resource this span refers, or +name+ if it's missing
+    # * +resource+: the resource this span refers, or +name+ if it's missing.
+    #     +nil+ can be used as a placeholder, when the resource value is not yet known at +#initialize+ time.
     # * +span_type+: the type of the span (such as +http+, +db+ and so on)
     # * +parent_id+: the identifier of the parent span
     # * +trace_id+: the identifier of the root span for this trace

data/lib/ddtrace/sync_writer.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/net'
 require 'datadog/core/environment/socket'
 require 'ddtrace/runtime/metrics'

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,3 +1,4 @@
+# typed: true
 require 'logger'
 require 'pathname'
 
@@ -84,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)
@@ -200,7 +200,7 @@ module Datadog
       if parent.nil?
         # root span
         @sampler.sample!(span)
-        span.set_tag('system.pid', Process.pid)
+        span.set_tag(Datadog::Ext::Runtime::TAG_PID, Process.pid)
         span.set_tag(Datadog::Ext::Runtime::TAG_ID, Datadog::Core::Environment::Identity.id)
 
         if ctx && ctx.trace_id

data/lib/ddtrace/transport/http/adapters/net.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/response'
 require 'ddtrace/vendor/multipart-post/net/http/post/multipart'
 
@@ -15,13 +16,23 @@ module Datadog
 
           DEFAULT_TIMEOUT = 30
 
-          def initialize(hostname, port, options = {})
-            @hostname = hostname
-            @port = port
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(hostname = nil, port = nil, **options)
+            @hostname = hostname || options.fetch(:hostname)
+            @port = port || options.fetch(:port)
             @timeout = options[:timeout] || DEFAULT_TIMEOUT
             @ssl = options.key?(:ssl) ? options[:ssl] == true : false
           end
 
+          def self.build(agent_settings)
+            new(
+              hostname: agent_settings.hostname,
+              port: agent_settings.port,
+              timeout: agent_settings.timeout_seconds,
+              ssl: agent_settings.ssl
+            )
+          end
+
           def open(&block)
             # DEV Initializing +Net::HTTP+ directly help us avoid expensive
             # options processing done in +Net::HTTP.start+:

data/lib/ddtrace/transport/http/adapters/registry.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/adapters/test.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/response'
 
 module Datadog
@@ -10,8 +11,10 @@ module Datadog
             :buffer,
             :status
 
-          def initialize(buffer = nil)
-            @buffer = buffer
+          # @param buffer [Array] an optional array that will capture all spans sent to this adapter, defaults to +nil+
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(buffer = nil, **options)
+            @buffer = buffer || options[:buffer]
             @mutex = Mutex.new
             @status = 200
           end

data/lib/ddtrace/transport/http/adapters/unix_socket.rb

@@ -1,4 +1,6 @@
+# typed: false
 require 'net/http'
+require 'ddtrace/ext/transport'
 require 'ddtrace/transport/http/adapters/net'
 
 module Datadog
@@ -7,21 +9,29 @@ module Datadog
       module Adapters
         # Adapter for Unix sockets
         class UnixSocket < Adapters::Net
-          DEFAULT_TIMEOUT = 1
-
           attr_reader \
-            :filepath,
+            :filepath, # DEV(1.0): Rename to `uds_path`
             :timeout
 
-          def initialize(filepath, options = {})
-            @filepath = filepath
-            @timeout = options.fetch(:timeout, DEFAULT_TIMEOUT)
+          alias_method :uds_path, :filepath
+
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(uds_path = nil, **options)
+            @filepath = uds_path || options.fetch(:uds_path)
+            @timeout = options[:timeout] || Ext::Transport::UnixSocket::DEFAULT_TIMEOUT_SECONDS
+          end
+
+          def self.build(agent_settings)
+            new(
+              uds_path: agent_settings.uds_path,
+              timeout: agent_settings.timeout_seconds,
+            )
           end
 
           def open(&block)
             # Open connection
             connection = HTTP.new(
-              filepath,
+              uds_path,
               read_timeout: timeout,
               continue_timeout: timeout
             )
@@ -30,7 +40,7 @@ module Datadog
           end
 
           def url
-            "http+unix://#{filepath}?timeout=#{timeout}"
+            "http+unix://#{uds_path}?timeout=#{timeout}"
           end
 
           # Re-implements Net:HTTP with underlying Unix socket
@@ -38,19 +48,21 @@ module Datadog
             DEFAULT_TIMEOUT = 1
 
             attr_reader \
-              :filepath,
+              :filepath, # DEV(1.0): Rename to `uds_path`
               :unix_socket
 
-            def initialize(filepath, options = {})
+            alias_method :uds_path, :filepath
+
+            def initialize(uds_path, options = {})
               super('localhost', 80)
-              @filepath = filepath
+              @filepath = uds_path
               @read_timeout = options.fetch(:read_timeout, DEFAULT_TIMEOUT)
               @continue_timeout = options.fetch(:continue_timeout, DEFAULT_TIMEOUT)
               @debug_output = options[:debug_output] if options.key?(:debug_output)
             end
 
             def connect
-              @unix_socket = UNIXSocket.open(filepath)
+              @unix_socket = UNIXSocket.open(uds_path)
               @socket = ::Net::BufferedIO.new(@unix_socket).tap do |socket|
                 socket.read_timeout = @read_timeout
                 socket.continue_timeout = @continue_timeout

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'json'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Transport
     module HTTP

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     module HTTP

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     module HTTP

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/encoding'
 
 require 'ddtrace/transport/http/api/map'