datadog 2.28.0 → 2.41.0

data/lib/datadog/profiling/profiler.rb

@@ -8,29 +8,37 @@ module Datadog
 
       private
 
-      attr_reader :worker, :scheduler
+      attr_reader :worker #: Datadog::Profiling::Collectors::CpuAndWallTimeWorker
+      attr_reader :scheduler #: Datadog::Profiling::Scheduler
 
       public
 
+      # @rbs worker: Datadog::Profiling::Collectors::CpuAndWallTimeWorker
+      # @rbs scheduler: Datadog::Profiling::Scheduler
+      # @rbs return: void
       def initialize(worker:, scheduler:)
         @worker = worker
         @scheduler = scheduler
       end
 
-      def enabled?
-        scheduler.running?
-      end
-
+      #: () -> void
       def start
         after_fork! do
           worker.reset_after_fork
           scheduler.reset_after_fork
         end
 
-        worker.start(on_failure_proc: proc { component_failed(:worker) })
+        worker.start(
+          on_failure_proc: ->(log_failure: true) do
+            # @type var log_failure: bool
+            component_failed(:worker, log_failure: log_failure)
+          end
+        )
         scheduler.start(on_failure_proc: proc { component_failed(:scheduler) })
       end
 
+      # @rbs report_last_profile: bool
+      # @rbs return: void
       def shutdown!(report_last_profile: true)
         Datadog.logger.debug("Shutting down profiler")
 
@@ -41,22 +49,29 @@ module Datadog
 
       private
 
+      #: () -> void
       def stop_worker
         worker.stop
       end
 
+      #: () -> void
       def stop_scheduler
         scheduler.enabled = false
         scheduler.stop(true)
       end
 
-      def component_failed(failed_component)
-        Datadog.logger.warn(
-          "Detected issue with profiler (#{failed_component} component), stopping profiling. " \
-          "See previous log messages for details."
-        )
-        Datadog::Core::Telemetry::Logger
-          .error("Detected issue with profiler (#{failed_component} component), stopping profiling")
+      # @rbs failed_component: :worker | :scheduler | ::Symbol
+      # @rbs log_failure: bool
+      # @rbs return: void
+      def component_failed(failed_component, log_failure: true)
+        if log_failure
+          Datadog.logger.warn(
+            "Detected issue with profiler (#{failed_component} component), stopping profiling. " \
+            "See previous log messages for details."
+          )
+          Datadog::Core::Telemetry::Logger
+            .error("Detected issue with profiler (#{failed_component} component), stopping profiling")
+        end
 
         if failed_component == :worker
           scheduler.disable_reporting

data/lib/datadog/profiling/scheduler.rb

@@ -65,7 +65,7 @@ module Datadog
       rescue Exception => e # rubocop:disable Lint/RescueException
         Datadog.logger.warn(
           "Profiling::Scheduler thread error. " \
-          "Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+          "Cause: #{e.class}: #{e.message} Location: #{Array(e.backtrace).first}"
         )
         on_failure_proc&.call
         Datadog::Core::Telemetry::Logger.report(e, description: "Profiling::Scheduler thread error")
@@ -136,7 +136,7 @@ module Datadog
           transport.export(flush)
         rescue => e
           Datadog.logger.warn(
-            "Unable to report profile. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+            "Unable to report profile. Cause: #{e.class}: #{e.message} Location: #{Array(e.backtrace).first}"
           )
           Datadog::Core::Telemetry::Logger.report(e, description: "Unable to report profile")
         end

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/stack_recorder.rb

@@ -9,12 +9,10 @@ module Datadog
     # Methods prefixed with _native_ are implemented in `stack_recorder.c`
     class StackRecorder
       def initialize(
-        cpu_time_enabled:,
         alloc_samples_enabled:,
         heap_samples_enabled:,
         heap_size_enabled:,
         heap_sample_every:,
-        timeline_enabled:,
         heap_clean_after_gc_enabled:
       )
         # This mutex works in addition to the fancy C-level mutexes we have in the native side (see the docs there).
@@ -27,33 +25,27 @@ module Datadog
 
         self.class._native_initialize(
           self_instance: self,
-          cpu_time_enabled: cpu_time_enabled,
           alloc_samples_enabled: alloc_samples_enabled,
           heap_samples_enabled: heap_samples_enabled,
           heap_size_enabled: heap_size_enabled,
           heap_sample_every: heap_sample_every,
-          timeline_enabled: timeline_enabled,
           heap_clean_after_gc_enabled: heap_clean_after_gc_enabled,
         )
       end
 
       def self.for_testing(
-        cpu_time_enabled: true,
         alloc_samples_enabled: false,
         heap_samples_enabled: false,
         heap_size_enabled: false,
         heap_sample_every: 1,
-        timeline_enabled: false,
         heap_clean_after_gc_enabled: true,
         **options
       )
         new(
-          cpu_time_enabled: cpu_time_enabled,
           alloc_samples_enabled: alloc_samples_enabled,
           heap_samples_enabled: heap_samples_enabled,
           heap_size_enabled: heap_size_enabled,
           heap_sample_every: heap_sample_every,
-          timeline_enabled: timeline_enabled,
           heap_clean_after_gc_enabled: heap_clean_after_gc_enabled,
           **options,
         )

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

@@ -5,25 +5,29 @@ module Datadog
     module Tasks
       # Wraps command with Datadog profiling
       class Exec
-        attr_reader :args
+        attr_reader :args #: untyped
 
+        #: (untyped) -> void
         def initialize(args)
           @args = args
         end
 
+        #: () -> untyped
         def run
           set_rubyopt!
           exec_with_error_handling(args)
         end
 
+        #: () -> ::Array["-rdatadog/profiling/preload"]
         def rubyopts
           [
-            "-rdatadog/profiling/preload"
+            "-rdatadog/profiling/preload",
           ]
         end
 
         private
 
+        #: () -> untyped
         def set_rubyopt!
           existing_rubyopt = ENV["RUBYOPT"] # rubocop:disable CustomCops/EnvUsageCop
 
@@ -35,13 +39,14 @@ module Datadog
         # See also:
         # * https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html
         # * https://github.com/rubygems/rubygems/blob/dd93966cac224532035deda533cba2685dfa30cc/bundler/lib/bundler/cli/exec.rb#L45
+        #: (untyped) -> untyped
         def exec_with_error_handling(args)
           Kernel.exec(*args)
         rescue Errno::ENOENT => e
-          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(" ")}')"
+          Kernel.warn "ddprofrb exec failed: #{e.class}: #{e.message} (command was '#{args.join(" ")}')"
           Kernel.exit 127
         rescue Errno::EACCES, Errno::ENOEXEC => e
-          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(" ")}')"
+          Kernel.warn "ddprofrb exec failed: #{e.class}: #{e.message} (command was '#{args.join(" ")}')"
           Kernel.exit 126
         end
       end

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

@@ -5,6 +5,7 @@ module Datadog
     module Tasks
       # Prints help message for usage of `ddprofrb`
       class Help
+        #: () -> untyped
         def run
           puts %(
   Usage: ddprofrb [command] [arguments]

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

@@ -16,7 +16,7 @@ module Datadog
             setup_at_fork_hooks
           rescue StandardError, ScriptError => e
             Datadog.logger.warn do
-              "Profiler extensions unavailable. Cause: #{e.class.name} #{e.message} " \
+              "Profiler extensions unavailable. Cause: #{e.class}: #{e.message} " \
               "Location: #{Array(e.backtrace).first}"
             end
             Datadog::Core::Telemetry::Logger.report(e, description: "Profiler extensions unavailable")
@@ -31,7 +31,7 @@ module Datadog
             Profiling.start_if_enabled
           rescue => e
             Datadog.logger.warn do
-              "Error during post-fork hooks. Cause: #{e.class.name} #{e.message} " \
+              "Error during post-fork hooks. Cause: #{e.class}: #{e.message} " \
               "Location: #{Array(e.backtrace).first}"
             end
             Datadog::Core::Telemetry::Logger.report(e, description: "Error during post-fork hooks")

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
@@ -61,8 +65,7 @@ module Datadog
     end
 
     def self.enabled?
-      profiler = Datadog.send(:components).profiler
-      !!profiler&.enabled?
+      !!Datadog.send(:components).profiler
     end
 
     def self.wait_until_running(timeout_seconds: 5)
@@ -72,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
 
@@ -110,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?)
@@ -136,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/ruby_version.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Datadog
+  # Compares the running Ruby against version requirements.
+  #
+  # Lexical comparisons against `RUBY_VERSION` are subtly wrong: `RUBY_VERSION < "3.2.3"` is also
+  # `true` on 3.2.10 and 3.2.11, since those sort *before* "3.2.3" as strings.
+  #
+  # @example
+  #   RubyVersion.is?(">= 3.2", "< 3.2.3") # => true on Ruby 3.2.0, 3.2.1, 3.2.2 (NOT 3.2.3+, NOT 3.2.10+)
+  module RubyVersion
+    extend RubyVersion # steep currently needs this (instead of extend self or def self.is?) for the inline rbs to work
+
+    CURRENT_RUBY_VERSION = Gem::Version.new(RUBY_VERSION) #: ::Gem::Version
+    private_constant :CURRENT_RUBY_VERSION
+
+    # Returns `true` when the running Ruby satisfies ALL of the given requirements. Each uses the
+    # same syntax as a gem dependency (e.g. `">= 3.1"`, `">= 3.2"`, `"< 3.2.3"`).
+    #
+    # @rbs (*String requirements, ?ruby_version: ::Gem::Version) -> bool
+    def is?(*requirements, ruby_version: CURRENT_RUBY_VERSION)
+      Gem::Requirement.new(*requirements).satisfied_by?(ruby_version)
+    end
+  end
+end

data/lib/datadog/single_step_instrument.rb

@@ -14,8 +14,8 @@ 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")}"
+  warn "Single step instrumentation failed: #{e.class}: #{e.message}\n\tSource:\n\t#{Array(e.backtrace).join("\n\t")}"
 end