datadog 2.38.0 → 2.47.0

data/lib/datadog/profiling/component.rb

@@ -65,6 +65,7 @@ module Datadog
           gvl_profiling_enabled: enable_gvl_profiling?(settings, logger),
           sighandler_sampling_enabled: settings.profiling.advanced.sighandler_sampling_enabled,
           cpu_sampling_interval_ms: cpu_sampling_interval_ms,
+          waiting_for_gvl_threshold_ns: settings.profiling.advanced.waiting_for_gvl_threshold_ns,
         )
 
         internal_metadata = {
@@ -72,7 +73,7 @@ module Datadog
           heap_sample_every: heap_sample_every,
         }.freeze
 
-        exporter = build_profiler_exporter(settings, recorder, worker, internal_metadata: internal_metadata)
+        exporter = build_profiler_exporter(settings, worker, internal_metadata: internal_metadata)
         transport = build_profiler_transport(settings, agent_settings)
         scheduler = Profiling::Scheduler.new(exporter: exporter, transport: transport, interval: upload_period_seconds)
         profiler = Profiling::Profiler.new(worker: worker, scheduler: scheduler)
@@ -102,19 +103,18 @@ module Datadog
           max_frames: settings.profiling.advanced.max_frames,
           tracer: optional_tracer,
           endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled,
-          waiting_for_gvl_threshold_ns: settings.profiling.advanced.waiting_for_gvl_threshold_ns,
           otel_context_enabled: settings.profiling.advanced.preview_otel_context_enabled,
           native_filenames_enabled: settings.profiling.advanced.native_filenames_enabled,
+          show_classes: settings.profiling.advanced.experimental_show_classes_enabled,
         )
       end
 
-      private_class_method def self.build_profiler_exporter(settings, recorder, worker, internal_metadata:)
+      private_class_method def self.build_profiler_exporter(settings, worker, internal_metadata:)
         info_collector = Profiling::Collectors::Info.new(settings)
         code_provenance_collector =
           (Profiling::Collectors::CodeProvenance.new if settings.profiling.advanced.code_provenance_enabled)
 
         Profiling::Exporter.new(
-          pprof_recorder: recorder,
           worker: worker,
           info_collector: info_collector,
           code_provenance_collector: code_provenance_collector,
@@ -226,11 +226,13 @@ module Datadog
           return false
         end
 
-        # Heap profiling relies on `ObjectSpace._id2ref`, which was removed on Ruby 4.1
-        # (https://bugs.ruby-lang.org/issues/22135).
-        if RubyVersion.is?(">= 4.1")
+        # Heap profiling tracks live objects using an `ObjectSpace::WeakMap`, which could corrupt its internal
+        # state during compaction before these versions (https://bugs.ruby-lang.org/issues/19529).
+        if RubyVersion.is?("< 3.1.4") || RubyVersion.is?(">= 3.2", "< 3.2.3")
           logger.warn(
-            "Heap profiling is currently incompatible with Ruby 4.1+ and has been disabled."
+            "Current Ruby version (#{RUBY_VERSION}) cannot support heap profiling due to a VM bug. " \
+            "Please upgrade to Ruby >= 3.1.4 or >= 3.2.3 in order to use this feature. " \
+            "Heap profiling has been disabled."
           )
           return false
         end
@@ -251,17 +253,7 @@ module Datadog
       private_class_method def self.enable_heap_size_profiling?(settings, heap_profiling_enabled, logger)
         heap_size_profiling_enabled = settings.profiling.advanced.experimental_heap_size_enabled
 
-        return false unless heap_profiling_enabled && heap_size_profiling_enabled
-
-        if RubyVersion.is?(">= 4")
-          logger.info(
-            "Heap live size profiling is currently incompatible with Ruby 4 and has been disabled. " \
-            "Heap live objects is not affected and remains enabled."
-          )
-          return false
-        end
-
-        true
+        heap_profiling_enabled && heap_size_profiling_enabled
       end
 
       private_class_method def self.no_signals_workaround_enabled?(settings, logger) # rubocop:disable Metrics/MethodLength
@@ -435,33 +427,35 @@ module Datadog
         end
       end
 
-      # To add just a bit more complexity to our detection code, in https://github.com/DataDog/dd-trace-rb/issues/3334
-      # a user reported that our code was incorrectly flagging the mariadb variant of libmysqlclient as being
-      # incompatible. In fact we have no reports of the mariadb variant needing the "no signals" workaround,
-      # so we flag it as compatible when it's in use.
+      # MariaDB's client has diverged from Oracle's and has no reported need for the "no signals" workaround, as
+      # reported in https://github.com/DataDog/dd-trace-rb/issues/3334, so we flag it as compatible when it's in use.
       #
-      # A problem is that there doesn't seem to be an obvious way to query the mysql2 gem on which kind of
-      # libmysqlclient it's using, so we detect it by looking at the version.
+      # There's no way to ask the mysql2 gem which client it was built against, so we infer it from the two versions
+      # that `Mysql2::Client.info` exposes:
       #
-      # The info method for mysql2 with mariadb looks something like this:
-      # `{:id=>30308, :version=>"3.3.8", :header_version=>"11.2.2"}`
+      # * `version` is `mysql_get_client_info()`. For MariaDB that's the version of
+      #   https://github.com/mariadb-corporation/mariadb-connector-c, which is still 3.x.
+      # * `header_version` is a constant baked in when mysql2 was compiled. Up to mysql2 0.5.6 it was the MariaDB
+      #   server version, which is what people usually call "the mariadb version"; 0.5.7 switched it to the
+      #   Connector/C version (https://github.com/brianmario/mysql2/pull/1406) and that broke our detection, as
+      #   reported in https://github.com/DataDog/dd-trace-rb/issues/6536.
       #
-      # * The version seems to come from https://github.com/mariadb-corporation/mariadb-connector-c and the latest
-      # one is 3.x.
-      # * The header_version is what people usually see as the "mariadb version"
+      # So MariaDB shows up as `{version: "3.3.8", header_version: "11.2.2"}` with mysql2 < 0.5.7 and as
+      # `{version: "3.4.9", header_version: "3.4.9"}` from 0.5.7 on. We accept both shapes: a header that is a server
+      # version (10 or newer, a sane range for modern releases per https://endoflife.date/mariadb) or one that is a
+      # Connector/C version (3.x, matching the client version).
       #
-      # As a comparison, for libmysql the info looks like:
-      # * `{:id=>80035, :version=>"8.0.35", :header_version=>"8.0.35"}`
-      #
-      # Thus our detection is version 4 or older, because libmysqlclient 4 is almost 20 years old so it's most probably
-      # not that one + header_version being 10 or newer, since according to https://endoflife.date/mariadb that's a
-      # sane range for modern mariadb releases.
+      # Oracle's client repeats one version in both fields (`{version: "8.0.35", header_version: "8.0.35"}`), and our
+      # caller already considers 8.0.0 and above compatible, so only a client older than 5.0.0 gets this far -- and
+      # no Oracle release has been one since libmysqlclient 4.1, which is from 2004.
       private_class_method def self.looks_like_mariadb?(info, libmysqlclient_version)
         header_version = Gem::Version.new(info[:header_version]) if info[:header_version]
 
-        !!(header_version &&
-          libmysqlclient_version < Gem::Version.new("5.0.0") &&
-          header_version >= Gem::Version.new("10.0.0"))
+        return false unless header_version && libmysqlclient_version < Gem::Version.new("5.0.0")
+        return true if header_version >= Gem::Version.new("10.0.0")
+
+        connector_c_versions = Gem::Requirement.new(">= 3.0.0", "< 4.0.0")
+        connector_c_versions.satisfied_by?(libmysqlclient_version) && connector_c_versions.satisfied_by?(header_version)
       end
 
       private_class_method def self.dir_interruption_workaround_enabled?(settings, no_signals_workaround_enabled)

data/lib/datadog/profiling/exporter.rb

@@ -20,7 +20,6 @@ module Datadog
 
       private
 
-      attr_reader :pprof_recorder #: Datadog::Profiling::StackRecorder
       # The code provenance collector acts both as collector and as a recorder
       attr_reader :code_provenance_collector #: Datadog::Profiling::Collectors::CodeProvenance?
       attr_reader :minimum_duration_seconds #: ::Integer
@@ -28,12 +27,11 @@ module Datadog
       attr_reader :last_flush_finish_at #: ::Time?
       attr_reader :created_at #: ::Time
       attr_reader :internal_metadata #: ::Hash[::Symbol, untyped]
-      attr_reader :info_json #: ::String
+      attr_reader :info_collector #: Datadog::Profiling::Collectors::Info
       attr_reader :sequence_tracker #: singleton(Datadog::Profiling::SequenceTracker)
 
       public
 
-      # @rbs pprof_recorder: Datadog::Profiling::StackRecorder
       # @rbs worker: Datadog::Profiling::Collectors::CpuAndWallTimeWorker
       # @rbs info_collector: Datadog::Profiling::Collectors::Info
       # @rbs code_provenance_collector: Datadog::Profiling::Collectors::CodeProvenance?
@@ -43,7 +41,6 @@ module Datadog
       # @rbs sequence_tracker: singleton(Datadog::Profiling::SequenceTracker)
       # @rbs return: void
       def initialize(
-        pprof_recorder:,
         worker:,
         info_collector:,
         code_provenance_collector:,
@@ -52,7 +49,6 @@ module Datadog
         time_provider: Time,
         sequence_tracker: Datadog::Profiling::SequenceTracker
       )
-        @pprof_recorder = pprof_recorder
         @worker = worker
         @code_provenance_collector = code_provenance_collector
         @minimum_duration_seconds = minimum_duration_seconds
@@ -60,14 +56,13 @@ module Datadog
         @last_flush_finish_at = nil
         @created_at = time_provider.now.utc
         @internal_metadata = internal_metadata
-        # NOTE: At the time of this comment collected info does not change over time so we'll hardcode
-        #       it on startup to prevent serializing the same info on every flush.
-        @info_json = JSON.generate(info_collector.info).freeze
+        @info_collector = info_collector
         @sequence_tracker = sequence_tracker
       end
 
       #: () -> Datadog::Profiling::Flush?
       def flush
+        pprof_recorder = @worker.prepare_serialize
         worker_stats = @worker.stats_and_reset_not_thread_safe
         serialization_result = pprof_recorder.serialize
         return if serialization_result.nil?
@@ -93,7 +88,7 @@ module Datadog
         metrics << ["ruby_global_lock_wait_time_total", gvl_waiting_time_ns_total] if gvl_waiting_time_ns_total
 
         process_tags = Datadog.configuration.experimental_propagate_process_tags_enabled ?
-          Core::Environment::Process.serialized : ''
+          Core::Environment::Process.serialized : ""
 
         Flush.new(
           start: start,
@@ -111,10 +106,10 @@ module Datadog
               worker_stats: worker_stats,
               profile_stats: profile_stats,
               recorder_stats: pprof_recorder.stats,
-              gc: GC.stat,
+              gc: gc_stats,
             }
           ),
-          info_json: info_json,
+          info_json: info_collector.info_json,
         )
       end
 
@@ -131,6 +126,11 @@ module Datadog
 
       private
 
+      # @rbs return: Hash[Symbol, Integer | bool]
+      def gc_stats
+        GC.stat.merge(auto_compact: GC.respond_to?(:auto_compact) && GC.auto_compact)
+      end
+
       #: (::Time, ::Time) -> bool
       def duration_below_threshold?(start, finish)
         (finish - start) < minimum_duration_seconds

data/lib/datadog/profiling/http_transport.rb

@@ -68,7 +68,7 @@ module Datadog
 
       #: (::String?, ::String?) -> bool?
       def agentless?(site, api_key)
-        site && api_key && %w[1 true].include?(ENV[Profiling::Ext::ENV_AGENTLESS] || '') # rubocop:disable CustomCops/EnvUsageCop
+        site && api_key && %w[1 true].include?(ENV[Profiling::Ext::ENV_AGENTLESS] || "") # rubocop:disable CustomCops/EnvUsageCop
       end
 
       #: () -> ::String

data/lib/datadog/profiling/sequence_tracker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../core/utils/forking'
+require_relative "../core/utils/forking"
 
 module Datadog
   module Profiling

data/lib/datadog/profiling/tag_builder.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../core/tag_builder'
-require_relative '../core/utils'
+require_relative "../core/tag_builder"
+require_relative "../core/utils"
 
-require 'set'
+require "set"
 
 module Datadog
   module Profiling
@@ -23,21 +23,21 @@ module Datadog
       # easy to end up with different tags in different languages.
       ALLOWED_TAGS = Set.new(
         [
-          'env',
-          'service',
-          'version',
-          'git.commit.sha',
-          'git.repository_url',
-          'host',
-          'language',
-          'runtime',
-          'runtime_engine',
-          'runtime_platform',
-          'runtime_version',
-          'runtime-id',
-          'process_id',
-          'profiler_version',
-          'profile_seq',
+          "env",
+          "service",
+          "version",
+          "git.commit.sha",
+          "git.repository_url",
+          "host",
+          "language",
+          "runtime",
+          "runtime_engine",
+          "runtime_platform",
+          "runtime_version",
+          "runtime-id",
+          "process_id",
+          "profiler_version",
+          "profile_seq",
         ]
       ).freeze
 
@@ -48,7 +48,7 @@ module Datadog
       )
         hash = Core::TagBuilder.tags(settings).merge(
           FORM_FIELD_TAG_PROFILER_VERSION => profiler_version,
-          'profile_seq' => profile_seq.to_s,
+          "profile_seq" => profile_seq.to_s,
         )
 
         user_tag_keys = settings.tags.keys

data/lib/datadog/profiling/tasks/exec.rb

@@ -21,7 +21,7 @@ module Datadog
         #: () -> ::Array["-rdatadog/profiling/preload"]
         def rubyopts
           [
-            "-rdatadog/profiling/preload"
+            "-rdatadog/profiling/preload",
           ]
         end
 

data/lib/datadog/profiling.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-require_relative 'core'
-require_relative 'core/environment/variable_helpers'
-require_relative 'core/utils/only_once'
+require "rbconfig"
+require_relative "core"
+require_relative "core/environment/variable_helpers"
+require_relative "core/utils/only_once"
 
 module Datadog
   # Datadog Continuous Profiler implementation: https://docs.datadoghq.com/profiler/
   module Profiling
+    STATIC_RUBY_PATH = (RbConfig::CONFIG["ENABLE_SHARED"] == "no") ? RbConfig.ruby.freeze : nil
+    private_constant :STATIC_RUBY_PATH
+
     def self.supported?
       unsupported_reason.nil?
     end
@@ -71,7 +75,7 @@ module Datadog
         worker = profiler.send(:worker)
         worker.wait_until_running(timeout_seconds: timeout_seconds)
       else
-        raise 'Profiler not enabled or available'
+        raise "Profiler not enabled or available"
       end
     end
 
@@ -109,17 +113,17 @@ module Datadog
 
       unless success
         if exception
-          'There was an error loading the profiling native extension due to ' \
+          "There was an error loading the profiling native extension due to " \
           "'#{exception.class.name} #{exception.message}' at '#{Array(exception.backtrace).first}'"
         else
-          'The profiling native extension did not load correctly. ' \
-          'For help solving this issue, please contact Datadog support at <https://docs.datadoghq.com/help/>.' \
+          "The profiling native extension did not load correctly. " \
+          "For help solving this issue, please contact Datadog support at <https://docs.datadoghq.com/help/>." \
         end
       end
     end
 
     private_class_method def self.try_loading_native_library
-      require_relative 'profiling/load_native_extension'
+      require_relative "profiling/load_native_extension"
 
       success =
         defined?(Profiling::NativeExtension) && Profiling::NativeExtension.send(:native_working?)
@@ -135,25 +139,25 @@ module Datadog
     private_class_method def self.load_profiling
       return false unless supported?
 
-      require_relative 'profiling/ext/dir_monkey_patches'
-      require_relative 'profiling/collectors/info'
-      require_relative 'profiling/collectors/code_provenance'
-      require_relative 'profiling/collectors/cpu_and_wall_time_worker'
-      require_relative 'profiling/collectors/dynamic_sampling_rate'
-      require_relative 'profiling/collectors/idle_sampling_helper'
-      require_relative 'profiling/collectors/stack'
-      require_relative 'profiling/collectors/thread_context'
-      require_relative 'profiling/stack_recorder'
-      require_relative 'profiling/exporter'
-      require_relative 'profiling/encoded_profile'
-      require_relative 'profiling/flush'
-      require_relative 'profiling/scheduler'
-      require_relative 'profiling/tasks/setup'
-      require_relative 'profiling/profiler'
-      require_relative 'profiling/native_extension'
-      require_relative 'profiling/tag_builder'
-      require_relative 'profiling/http_transport'
-      require_relative 'profiling/sequence_tracker'
+      require_relative "profiling/ext/dir_monkey_patches"
+      require_relative "profiling/collectors/info"
+      require_relative "profiling/collectors/code_provenance"
+      require_relative "profiling/collectors/cpu_and_wall_time_worker"
+      require_relative "profiling/collectors/dynamic_sampling_rate"
+      require_relative "profiling/collectors/idle_sampling_helper"
+      require_relative "profiling/collectors/stack"
+      require_relative "profiling/collectors/thread_context"
+      require_relative "profiling/stack_recorder"
+      require_relative "profiling/exporter"
+      require_relative "profiling/encoded_profile"
+      require_relative "profiling/flush"
+      require_relative "profiling/scheduler"
+      require_relative "profiling/tasks/setup"
+      require_relative "profiling/profiler"
+      require_relative "profiling/native_extension"
+      require_relative "profiling/tag_builder"
+      require_relative "profiling/http_transport"
+      require_relative "profiling/sequence_tracker"
 
       replace_noop_allocation_count
 

data/lib/datadog/single_step_instrument.rb

@@ -14,7 +14,7 @@ module Datadog
 end
 
 begin
-  require_relative 'auto_instrument'
+  require_relative "auto_instrument"
   Datadog::SingleStepInstrument.const_set(:LOADED, true)
 rescue StandardError, LoadError => e
   warn "Single step instrumentation failed: #{e.class}: #{e.message}\n\tSource:\n\t#{Array(e.backtrace).join("\n\t")}"

data/lib/datadog/symbol_database/component.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../symbol_database'
-require_relative 'extractor'
-require_relative 'logger'
-require_relative 'scope_batcher'
-require_relative 'uploader'
-require_relative '../core/utils/time'
-require_relative '../di/fatal_exceptions'
+require_relative "../symbol_database"
+require_relative "extractor"
+require_relative "logger"
+require_relative "scope_batcher"
+require_relative "uploader"
+require_relative "../core/utils/time"
+require_relative "../di/fatal_exceptions"
 
 module Datadog
   module SymbolDatabase
@@ -237,7 +237,7 @@ module Datadog
       rescue Exception => e # standard:disable Lint/RescueException
         Datadog::DI.reraise_if_fatal(e)
         @logger.debug { "symdb: error scheduling upload: #{e.class}: #{e.message}" }
-        @telemetry&.report(e, description: 'symdb: error scheduling upload')
+        @telemetry&.report(e, description: "symdb: error scheduling upload")
       end
 
       # Stop symbol upload in response to remote config sending
@@ -498,7 +498,7 @@ module Datadog
       def self.environment_supported?(logger)
         return true if SymbolDatabase.supported_runtime?
 
-        if RUBY_ENGINE != 'ruby'
+        if RUBY_ENGINE != "ruby"
           logger.debug { "symdb: not supported on #{RUBY_ENGINE}, skipping" }
         else
           logger.debug { "symdb: requires Ruby 2.7+, running #{RUBY_VERSION}, skipping" }
@@ -570,7 +570,7 @@ module Datadog
       rescue Exception => e # standard:disable Lint/RescueException
         Datadog::DI.reraise_if_fatal(e)
         @logger.debug { "symdb: scheduler error: #{e.class}: #{e.message}" }
-        @telemetry&.report(e, description: 'symdb: scheduler error')
+        @telemetry&.report(e, description: "symdb: scheduler error")
       end
 
       # Extract symbols and upload. First call runs extract_all (full ObjectSpace
@@ -611,7 +611,7 @@ module Datadog
           end
 
           extraction_duration = Datadog::Core::Utils::Time.get_time - start_time
-          @logger.debug { "symdb: #{mode_label} extracted #{extracted_count} scopes (#{targetable_count} methods with targetable lines) in #{'%.2f' % extraction_duration}s" }
+          @logger.debug { "symdb: #{mode_label} extracted #{extracted_count} scopes (#{targetable_count} methods with targetable lines) in #{"%.2f" % extraction_duration}s" }
 
           # Flush any remaining scopes (triggers upload)
           @scope_batcher.flush
@@ -624,7 +624,7 @@ module Datadog
         rescue Exception => e # standard:disable Lint/RescueException
           Datadog::DI.reraise_if_fatal(e)
           @logger.debug { "symdb: extraction error: #{e.class}: #{e.message}" }
-          @telemetry&.report(e, description: 'symdb: extraction error')
+          @telemetry&.report(e, description: "symdb: extraction error")
           @mutex.synchronize do
             @last_upload_time = Datadog::Core::Utils::Time.now
             @last_upload_time_cv.broadcast
@@ -681,7 +681,7 @@ module Datadog
           # nothing useful to do if logging is broken.
           begin
             logger.debug { "symdb: hot-load hook error: #{e.class}: #{e.message}" }
-            telemetry&.report(e, description: 'symdb: hot-load hook error')
+            telemetry&.report(e, description: "symdb: hot-load hook error")
           rescue Exception => report_exc # standard:disable Lint/RescueException
             Datadog::DI.reraise_if_fatal(report_exc)
             nil
@@ -712,7 +712,7 @@ module Datadog
       end
 
       def log_scope_tree(scope, depth)
-        indent = '  ' * depth
+        indent = "  " * depth
         @logger.trace { "symdb:   #{indent}#{scope.scope_type} #{scope.name}" }
         scope.scopes&.each { |child| log_scope_tree(child, depth + 1) }
       end
@@ -724,7 +724,7 @@ module Datadog
         count = 0
         file_scope.scopes&.each do |class_or_module|
           class_or_module.scopes&.each do |method_scope|
-            count += 1 if method_scope.scope_type == 'METHOD' && method_scope.targetable_lines?
+            count += 1 if method_scope.scope_type == "METHOD" && method_scope.targetable_lines?
           end
         end
         count

data/lib/datadog/symbol_database/configuration.rb

@@ -37,7 +37,7 @@ module Datadog
               # DD_SYMBOL_DATABASE_UPLOAD_ENABLED or c.symbol_database.enabled to
               # override: true uploads regardless of DI, false disables entirely.
               option :enabled do |o|
-                o.env 'DD_SYMBOL_DATABASE_UPLOAD_ENABLED'
+                o.env "DD_SYMBOL_DATABASE_UPLOAD_ENABLED"
                 o.default nil
                 o.type :bool, nilable: true
               end
@@ -51,7 +51,7 @@ module Datadog
                 # and Python's private force_upload setting.
                 option :force_upload do |o|
                   o.type :bool
-                  o.env 'DD_INTERNAL_FORCE_SYMBOL_DATABASE_UPLOAD'
+                  o.env "DD_INTERNAL_FORCE_SYMBOL_DATABASE_UPLOAD"
                   o.default false
                 end
 
@@ -60,7 +60,7 @@ module Datadog
                 option :trace_logging do |o|
                   o.type :bool
                   o.default false
-                  o.env 'DD_TRACE_DEBUG'
+                  o.env "DD_TRACE_DEBUG"
                 end
               end
             end

data/lib/datadog/symbol_database/extensions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../core/configuration'
-require_relative 'configuration'
+require_relative "../core/configuration"
+require_relative "configuration"
 
 module Datadog
   module SymbolDatabase