datadog 2.31.0 → 2.32.0

data/lib/datadog/profiling/collectors/info.rb

@@ -14,11 +14,18 @@ module Datadog
       # could be seen as overkill for this case but it allows us to centralize information
       # gathering and easily support more flexible/dynamic info collection in the future.
       class Info
+        # @rbs @info: ::Hash[::Symbol, ::Hash[::Symbol, untyped]]
+        # @rbs @platform_info: ::Hash[::Symbol, untyped]
+        # @rbs @runtime_info: ::Hash[::Symbol, untyped]
+        # @rbs @application_info: ::Hash[::Symbol, untyped]
+        # @rbs @profiler_info: ::Hash[::Symbol, untyped]?
+        # @rbs @gc_tuning_info: ::Hash[::Symbol, ::String]
+
+        #: (untyped) -> void
         def initialize(settings)
           @profiler_info = nil
 
-          # Steep: https://github.com/soutaro/steep/issues/363
-          @info = { # steep:ignore IncompatibleAssignment
+          @info = {
             platform: collect_platform_info,
             runtime: collect_runtime_info,
             application: collect_application_info(settings),
@@ -26,7 +33,7 @@ module Datadog
           }.freeze
         end
 
-        attr_reader :info
+        attr_reader :info #: ::Hash[::Symbol, ::Hash[::Symbol, untyped]]
 
         private
 
@@ -69,6 +76,7 @@ module Datadog
         # gets initialized before a user has a chance to configure the library.
         START_TIME = Time.now.utc.freeze
 
+        #: () -> ::Hash[::Symbol, untyped]
         def collect_platform_info
           @platform_info ||= {
             container_id: Datadog::Core::Environment::Container.container_id,
@@ -79,6 +87,7 @@ module Datadog
           }.freeze
         end
 
+        #: () -> ::Hash[::Symbol, untyped]
         def collect_runtime_info
           @runtime_info ||= {
             engine: Datadog::Core::Environment::Identity.lang_engine,
@@ -88,6 +97,7 @@ module Datadog
           }.freeze
         end
 
+        #: (untyped) -> ::Hash[::Symbol, untyped]
         def collect_application_info(settings)
           @application_info ||= {
             start_time: START_TIME.iso8601,
@@ -97,6 +107,7 @@ module Datadog
           }.freeze
         end
 
+        #: (untyped) -> ::Hash[::Symbol, untyped]
         def collect_profiler_info(settings)
           @profiler_info ||= begin
             lib_datadog_gem = ::Gem.loaded_specs["libdatadog"]
@@ -123,6 +134,7 @@ module Datadog
         # instances without proper serialization.
         # This method navigates a settings object recursively, converting
         # it into more basic types that are trivially convertible to JSON.
+        #: (untyped) -> untyped
         def collect_settings_recursively(v)
           v = v.options_hash if v.respond_to?(:options_hash)
 
@@ -143,6 +155,7 @@ module Datadog
           end
         end
 
+        #: () -> ::Hash[::Symbol, ::String]
         def collect_gc_tuning_info
           return @gc_tuning_info if defined?(@gc_tuning_info)
 

data/lib/datadog/profiling/component.rb

@@ -10,8 +10,6 @@ module Datadog
       # * Profiling in the trace viewer, as well as scoping a profile down to a span
       # * Endpoint aggregation in the profiler UX, including normalization (resource per endpoint call)
       def self.build_profiler_component(settings:, agent_settings:, optional_tracer:, logger:) # rubocop:disable Metrics/MethodLength
-        return [nil, {profiling_enabled: false}] unless settings.profiling.enabled
-
         # Workaround for weird dependency direction: the Core::Configuration::Components class currently has a
         # dependency on individual products, in this case the Profiler.
         # (Note "currently": in the future we want to change this so core classes don't depend on specific products)
@@ -31,7 +29,7 @@ module Datadog
         # no-op if profiling is already loaded).
         require_relative "../profiling"
 
-        return [nil, {profiling_enabled: false}] unless Profiling.supported?
+        return [nil, {profiling_enabled: false}] unless settings.profiling.enabled && Profiling.supported?
 
         # Activate forking extensions
         Profiling::Tasks::Setup.new.run
@@ -94,7 +92,7 @@ module Datadog
         [profiler, {profiling_enabled: true}]
       rescue Exception => e # rubocop:disable Lint/RescueException
         logger.warn do
-          "Failed to initialize profiling: #{e.class}: #{e} " \
+          "Failed to initialize profiling: #{e.class}: #{e.message} " \
           "Location: #{Array(e.backtrace).first}"
         end
         Datadog::Core::Telemetry::Logger.report(e, description: "Failed to initialize profiling")
@@ -378,7 +376,7 @@ module Datadog
         rescue StandardError, LoadError => e
           logger.warn(
             "Failed to probe `mysql2` gem information. " \
-            "Cause: #{e.class}: #{e} Location: #{Array(e.backtrace).first}"
+            "Cause: #{e.class}: #{e.message} Location: #{Array(e.backtrace).first}"
           )
 
           true

data/lib/datadog/profiling/exporter.rb

@@ -13,24 +13,35 @@ module Datadog
     # recorders, so I've decided to make it specific until we actually need to support more recorders.
     #
     class Exporter
+      # @rbs @worker: Datadog::Profiling::Collectors::CpuAndWallTimeWorker
+
       # Profiles with duration less than this will not be reported
       PROFILE_DURATION_THRESHOLD_SECONDS = 1
 
       private
 
-      attr_reader \
-        :pprof_recorder,
-        :code_provenance_collector, # The code provenance collector acts both as collector and as a recorder
-        :minimum_duration_seconds,
-        :time_provider,
-        :last_flush_finish_at,
-        :created_at,
-        :internal_metadata,
-        :info_json,
-        :sequence_tracker
+      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
+      attr_reader :time_provider #: singleton(::Time)
+      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 :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?
+      # @rbs internal_metadata: ::Hash[::Symbol, untyped]
+      # @rbs minimum_duration_seconds: ::Integer
+      # @rbs time_provider: singleton(::Time)
+      # @rbs sequence_tracker: singleton(Datadog::Profiling::SequenceTracker)
+      # @rbs return: void
       def initialize(
         pprof_recorder:,
         worker:,
@@ -55,6 +66,7 @@ module Datadog
         @sequence_tracker = sequence_tracker
       end
 
+      #: () -> Datadog::Profiling::Flush?
       def flush
         worker_stats = @worker.stats_and_reset_not_thread_safe
         serialization_result = pprof_recorder.serialize
@@ -68,7 +80,17 @@ module Datadog
           return
         end
 
-        uncompressed_code_provenance = code_provenance_collector.refresh.generate_json if code_provenance_collector
+        uncompressed_code_provenance =
+          if (collector = code_provenance_collector)
+            collector.refresh.generate_json
+          end
+
+        metrics = [] #: Array[[::String, ::Numeric]]
+
+        # The key is always there, but the value might be nil if GVL profiling is disabled.
+        # We delete it to avoid reporting the same data point twice.
+        gvl_waiting_time_ns_total = worker_stats.delete(:gvl_waiting_time_ns_total)
+        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 : ''
@@ -77,8 +99,8 @@ module Datadog
           start: start,
           finish: finish,
           encoded_profile: encoded_profile,
-          code_provenance_file_name: Datadog::Profiling::Ext::Transport::HTTP::CODE_PROVENANCE_FILENAME,
           code_provenance_data: uncompressed_code_provenance,
+          metrics: metrics,
           tags_as_array: Datadog::Profiling::TagBuilder.call(
             settings: Datadog.configuration,
             profile_seq: sequence_tracker.get_next,
@@ -96,10 +118,12 @@ module Datadog
         )
       end
 
+      #: () -> bool
       def can_flush?
         !duration_below_threshold?(last_flush_finish_at || created_at, time_provider.now.utc)
       end
 
+      #: () -> void
       def reset_after_fork
         @last_flush_finish_at = time_provider.now.utc
         nil
@@ -107,6 +131,7 @@ module Datadog
 
       private
 
+      #: (::Time, ::Time) -> bool
       def duration_below_threshold?(start, finish)
         (finish - start) < minimum_duration_seconds
       end

data/lib/datadog/profiling/ext.rb

@@ -13,8 +13,6 @@ module Datadog
       module Transport
         module HTTP
           FORM_FIELD_TAG_PROFILER_VERSION = "profiler_version"
-
-          CODE_PROVENANCE_FILENAME = "code-provenance.json"
         end
       end
     end

data/lib/datadog/profiling/flush.rb

@@ -6,23 +6,32 @@ module Datadog
   module Profiling
     # Entity class used to represent metadata for a given profile
     class Flush
-      attr_reader \
-        :start,
-        :finish,
-        :encoded_profile,
-        :code_provenance_file_name,
-        :code_provenance_data,
-        :tags_as_array,
-        :process_tags,
-        :internal_metadata_json,
-        :info_json
+      attr_reader :start #: ::Time
+      attr_reader :finish #: ::Time
+      attr_reader :encoded_profile #: Datadog::Profiling::EncodedProfile
+      attr_reader :code_provenance_data #: ::String?
+      attr_reader :metrics #: ::String
+      attr_reader :tags_as_array #: Array[[::String, ::String]]
+      attr_reader :process_tags #: ::String
+      attr_reader :internal_metadata_json #: ::String
+      attr_reader :info_json #: ::String
 
+      # @rbs start: ::Time
+      # @rbs finish: ::Time
+      # @rbs encoded_profile: Datadog::Profiling::EncodedProfile
+      # @rbs code_provenance_data: ::String?
+      # @rbs metrics: Array[[::String, ::Numeric]]
+      # @rbs tags_as_array: Array[[::String, ::String]]
+      # @rbs process_tags: ::String
+      # @rbs internal_metadata: ::Hash[::Symbol, ::String | bool | ::Numeric]
+      # @rbs info_json: ::String
+      # @rbs return: void
       def initialize(
         start:,
         finish:,
         encoded_profile:,
-        code_provenance_file_name:,
         code_provenance_data:,
+        metrics:,
         tags_as_array:,
         process_tags:,
         internal_metadata:,
@@ -31,8 +40,8 @@ module Datadog
         @start = start
         @finish = finish
         @encoded_profile = encoded_profile
-        @code_provenance_file_name = code_provenance_file_name
         @code_provenance_data = code_provenance_data
+        @metrics = JSON.generate(metrics)
         @tags_as_array = tags_as_array
         @process_tags = process_tags
         @internal_metadata_json = JSON.generate(internal_metadata)

data/lib/datadog/profiling/http_transport.rb

@@ -8,8 +8,16 @@ module Datadog
     # Used to report profiling data to Datadog.
     # Methods prefixed with _native_ are implemented in `http_transport.c`
     class HttpTransport
-      attr_reader :exporter_configuration
+      # @rbs @exporter_configuration: exporter_configuration_array
 
+      attr_reader :exporter_configuration #: exporter_configuration_array
+
+      # @rbs agent_settings: Datadog::Core::Configuration::AgentSettings
+      # @rbs site: ::String?
+      # @rbs api_key: ::String?
+      # @rbs upload_timeout_seconds: ::Integer
+      # @rbs use_system_dns: bool
+      # @rbs return: void
       def initialize(agent_settings:, site:, api_key:, upload_timeout_seconds:, use_system_dns:)
         timeout_milliseconds = (upload_timeout_seconds * 1_000).to_i
 
@@ -28,6 +36,7 @@ module Datadog
         raise(ArgumentError, "Failed to initialize transport: #{result}") if status == :error
       end
 
+      #: (Datadog::Profiling::Flush) -> bool
       def export(flush)
         status, result = self.class._native_do_export(
           exporter_configuration,
@@ -57,10 +66,12 @@ module Datadog
 
       private
 
+      #: (::String?, ::String?) -> bool?
       def agentless?(site, api_key)
         site && api_key && %w[1 true].include?(ENV[Profiling::Ext::ENV_AGENTLESS] || '') # rubocop:disable CustomCops/EnvUsageCop
       end
 
+      #: () -> ::String
       def config_without_api_key
         "#{exporter_configuration[0]}: #{exporter_configuration[3]}"
       end

data/lib/datadog/profiling/load_native_extension.rb

@@ -5,5 +5,5 @@ begin
 rescue LoadError => e
   raise LoadError,
     "Failed to load the profiling native extension. To fix this, please remove and then reinstall datadog " \
-    "(Details: #{e.message})"
+    "(Details: #{e.class}: #{e.message})"
 end

data/lib/datadog/profiling/profiler.rb

@@ -8,15 +8,20 @@ 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
 
+      #: () -> void
       def start
         after_fork! do
           worker.reset_after_fork
@@ -32,6 +37,8 @@ module Datadog
         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")
 
@@ -42,15 +49,20 @@ module Datadog
 
       private
 
+      #: () -> void
       def stop_worker
         worker.stop
       end
 
+      #: () -> void
       def stop_scheduler
         scheduler.enabled = false
         scheduler.stop(true)
       end
 
+      # @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(

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}: #{e} 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}: #{e} 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/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,6 +27,7 @@ module Datadog
 
         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}: #{e} (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}: #{e} (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}: #{e} " \
+              "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}: #{e} " \
+              "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/single_step_instrument.rb

@@ -17,5 +17,5 @@ begin
   require_relative 'auto_instrument'
   Datadog::SingleStepInstrument.const_set(:LOADED, true)
 rescue StandardError, LoadError => e
-  warn "Single step instrumentation failed: #{e.class}: #{e}\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

data/lib/datadog/symbol_database/configuration.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Datadog
+  module SymbolDatabase
+    # Configuration for symbol database
+    module Configuration
+      # Configuration settings for symbol database upload feature.
+      #
+      # Public environment variable:
+      # - DD_SYMBOL_DATABASE_UPLOAD_ENABLED (default: true) - Feature gate
+      #
+      # Extended into: Core::Configuration::Settings (via extend)
+      # Accessed as: Datadog.configuration.symbol_database.enabled
+      # Used by: Component.build (checks if feature enabled)
+      module Settings
+        # Hook called when this module is extended into a class.
+        # @param base [Class, Module] The class or module being extended
+        # @return [void]
+        def self.extended(base)
+          base = base.singleton_class unless base.is_a?(Class)
+          add_settings!(base)
+        end
+
+        # Add symbol_database settings block to base class.
+        # @param base [Class] Base class
+        # @return [void]
+        def self.add_settings!(base)
+          base.class_eval do
+            # steep:ignore:start
+            settings :symbol_database do
+              option :enabled do |o|
+                o.type :bool
+                o.env 'DD_SYMBOL_DATABASE_UPLOAD_ENABLED'
+                o.default true
+              end
+
+              # Settings in the 'internal' group are for internal Datadog
+              # use only, and are needed to test symbol database or
+              # experiment with features not released to customers.
+              settings :internal do
+                # Bypass remote config — start extraction immediately.
+                # Matches Java's DD_INTERNAL_FORCE_SYMBOL_DATABASE_UPLOAD
+                # and Python's private force_upload setting.
+                option :force_upload do |o|
+                  o.type :bool
+                  o.env 'DD_INTERNAL_FORCE_SYMBOL_DATABASE_UPLOAD'
+                  o.default false
+                end
+
+                # Enable verbose trace-level logging for symdb operations.
+                # Activated by DD_TRACE_DEBUG (same trigger as DI trace logging).
+                option :trace_logging do |o|
+                  o.type :bool
+                  o.default false
+                  o.env 'DD_TRACE_DEBUG'
+                end
+              end
+            end
+            # steep:ignore:end
+          end
+        end
+      end
+    end
+  end
+end