datadog 2.17.0 → 2.37.0

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

@@ -5,17 +5,20 @@ 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"
@@ -24,10 +27,11 @@ module Datadog
 
         private
 
+        #: () -> untyped
         def set_rubyopt!
-          existing_rubyopt = ENV["RUBYOPT"]
+          existing_rubyopt = ENV["RUBYOPT"] # rubocop:disable CustomCops/EnvUsageCop
 
-          ENV["RUBYOPT"] = existing_rubyopt ? "#{existing_rubyopt} #{rubyopts.join(" ")}" : rubyopts.join(" ")
+          ENV["RUBYOPT"] = existing_rubyopt ? "#{existing_rubyopt} #{rubyopts.join(" ")}" : rubyopts.join(" ") # rubocop:disable CustomCops/EnvUsageCop
         end
 
         # If there's an error here, rather than throwing a cryptic stack trace, let's instead have clearer messages, and
@@ -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,9 +16,10 @@ 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")
           end
         end
 
@@ -30,9 +31,10 @@ 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")
           end
         end
       end

data/lib/datadog/profiling.rb

@@ -61,9 +61,7 @@ module Datadog
     end
 
     def self.enabled?
-      profiler = Datadog.send(:components).profiler
-      # Use .send(...) to avoid exposing the attr_reader as an API to the outside
-      !!profiler&.send(:scheduler)&.running?
+      !!Datadog.send(:components).profiler
     end
 
     def self.wait_until_running(timeout_seconds: 5)
@@ -121,15 +119,13 @@ module Datadog
     end
 
     private_class_method def self.try_loading_native_library
-      begin
-        require_relative 'profiling/load_native_extension'
+      require_relative 'profiling/load_native_extension'
 
-        success =
-          defined?(Profiling::NativeExtension) && Profiling::NativeExtension.send(:native_working?)
-        [success, nil]
-      rescue StandardError, LoadError => e
-        [false, e]
-      end
+      success =
+        defined?(Profiling::NativeExtension) && Profiling::NativeExtension.send(:native_working?)
+      [success, nil]
+    rescue StandardError, LoadError => e
+      [false, e]
     end
 
     # All requires for the profiler should be directly added here; and everything should be loaded eagerly.
@@ -157,6 +153,7 @@ module Datadog
       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

@@ -5,8 +5,17 @@
 #
 # This file's path is private. Do not reference this file.
 #
+
+module Datadog
+  # This module handles conditional loading of single step auto-instrumentation,
+  # which enables Datadog tracing and profiling features when available.
+  module SingleStepInstrument
+  end
+end
+
 begin
   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