ddtrace 1.10.1 → 1.11.0.beta1

data/lib/datadog/core/utils/safe_dup.rb

@@ -16,8 +16,26 @@ module Datadog
           using RefineNil
         end
 
-        def self.frozen_or_dup(v)
-          v.frozen? ? v : v.dup
+        # String#+@ was introduced in Ruby 2.3
+        if String.method_defined?(:+@) && String.method_defined?(:-@)
+          def self.frozen_or_dup(v)
+            # If the string is not frozen, the +(-v) will:
+            # - first create a frozen deduplicated copy with -v
+            # - then it will dup it more efficiently with +v
+            v.frozen? ? v : +(-v)
+          end
+
+          def self.frozen_dup(v)
+            -v if v
+          end
+        else
+          def self.frozen_or_dup(v)
+            v.frozen? ? v : v.dup
+          end
+
+          def self.frozen_dup(v)
+            v.frozen? ? v : v.dup.freeze
+          end
         end
       end
     end

data/lib/datadog/core/utils/sequence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils/time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     # Base class for work tasks

data/lib/datadog/core/workers/interval_loop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Workers

data/lib/datadog/core/workers/queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Workers

data/lib/datadog/core/workers/runtime_metrics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../runtime/metrics'
 
 require_relative '../worker'

data/lib/datadog/kit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   # Datadog::Kit holds public-facing APIs for higher level user-facing
   # features, these features not belonging to a specific product. Contrary to

data/lib/datadog/opentracer/binary_propagator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/datadog/opentracer/carrier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # @public_api

data/lib/datadog/opentracer/global_tracer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # Patch for OpenTracing module

data/lib/datadog/opentracer/propagator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/datadog/opentracer/scope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for scope

data/lib/datadog/opentracer/scope_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # @public_api

data/lib/datadog/opentracer/span_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for SpanContext

data/lib/datadog/opentracer/span_context_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # Creates new Datadog::OpenTracer::SpanContext

data/lib/datadog/opentracer/thread_local_scope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scopes

data/lib/datadog/opentracer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'opentracing'
 require 'opentracing/carrier'
 require_relative 'tracing'

data/lib/datadog/profiling/backtrace_location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     # Entity class used to represent an entry in a stack trace.

data/lib/datadog/profiling/buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../core/buffer/thread_safe'
 require_relative '../core/utils/object_set'
 require_relative '../core/utils/string_table'

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

@@ -17,17 +17,33 @@ module Datadog
           recorder:,
           max_frames:,
           tracer:,
+          endpoint_collection_enabled:,
           gc_profiling_enabled:,
           allocation_counting_enabled:,
-          thread_context_collector: ThreadContext.new(recorder: recorder, max_frames: max_frames, tracer: tracer),
-          idle_sampling_helper: IdleSamplingHelper.new
+          thread_context_collector: ThreadContext.new(
+            recorder: recorder,
+            max_frames: max_frames,
+            tracer: tracer,
+            endpoint_collection_enabled: endpoint_collection_enabled,
+          ),
+          idle_sampling_helper: IdleSamplingHelper.new,
+          # **NOTE**: This should only be used for testing; disabling the dynamic sampling rate will increase the
+          # profiler overhead!
+          dynamic_sampling_rate_enabled: true
         )
+          unless dynamic_sampling_rate_enabled
+            Datadog.logger.warn(
+              'Profiling dynamic sampling rate disabled. This should only be used for testing, and will increase overhead!'
+            )
+          end
+
           self.class._native_initialize(
             self,
             thread_context_collector,
             gc_profiling_enabled,
             idle_sampling_helper,
-            allocation_counting_enabled
+            allocation_counting_enabled,
+            dynamic_sampling_rate_enabled,
           )
           @worker_thread = nil
           @failure_exception = nil

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     module Collectors

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

@@ -47,7 +47,7 @@ module Datadog
           true
         end
 
-        def stop(*_)
+        def stop(*_unused)
           @start_stop_mutex.synchronize do
             Datadog.logger.debug('Requesting IdleSamplingHelper thread shut down')
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     module Collectors

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

@@ -14,9 +14,9 @@ module Datadog
       #
       # Methods prefixed with _native_ are implemented in `collectors_thread_context.c`
       class ThreadContext
-        def initialize(recorder:, max_frames:, tracer:)
+        def initialize(recorder:, max_frames:, tracer:, endpoint_collection_enabled:)
           tracer_context_key = safely_extract_context_key_from(tracer)
-          self.class._native_initialize(self, recorder, max_frames, tracer_context_key)
+          self.class._native_initialize(self, recorder, max_frames, tracer_context_key, endpoint_collection_enabled)
         end
 
         def inspect

data/lib/datadog/profiling/component.rb

@@ -2,9 +2,12 @@
 
 module Datadog
   module Profiling
-    # Profiling component
+    # Responsible for wiring up the Profiler for execution
     module Component
-      def build_profiler(settings, agent_settings, tracer)
+      # Passing in a `nil` tracer is supported and will disable the following profiling features:
+      # * Code Hotspots panel 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:)
         return unless settings.profiling.enabled
 
         # Workaround for weird dependency direction: the Core::Configuration::Components class currently has a
@@ -61,7 +64,7 @@ module Datadog
 
         # NOTE: Please update the Initialization section of ProfilingDevelopment.md with any changes to this method
 
-        if settings.profiling.advanced.force_enable_new_profiler
+        if enable_new_profiler?(settings)
           print_new_profiler_warnings
 
           recorder = Datadog::Profiling::StackRecorder.new(
@@ -71,18 +74,14 @@ module Datadog
           collector = Datadog::Profiling::Collectors::CpuAndWallTimeWorker.new(
             recorder: recorder,
             max_frames: settings.profiling.advanced.max_frames,
-            tracer: tracer,
-            gc_profiling_enabled: should_enable_gc_profiling?(settings),
+            tracer: optional_tracer,
+            endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled,
+            gc_profiling_enabled: enable_gc_profiling?(settings),
             allocation_counting_enabled: settings.profiling.advanced.allocation_counting_enabled,
           )
         else
-          trace_identifiers_helper = Profiling::TraceIdentifiers::Helper.new(
-            tracer: tracer,
-            endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
-          )
-
           recorder = build_profiler_old_recorder(settings)
-          collector = build_profiler_oldstack_collector(settings, recorder, trace_identifiers_helper)
+          collector = build_profiler_oldstack_collector(settings, recorder, optional_tracer)
         end
 
         exporter = build_profiler_exporter(settings, recorder)
@@ -92,20 +91,23 @@ module Datadog
         Profiling::Profiler.new([collector], scheduler)
       end
 
-      private
-
-      def build_profiler_old_recorder(settings)
+      private_class_method def self.build_profiler_old_recorder(settings)
         Profiling::OldRecorder.new([Profiling::Events::StackSample], settings.profiling.advanced.max_events)
       end
 
-      def build_profiler_exporter(settings, recorder)
+      private_class_method def self.build_profiler_exporter(settings, recorder)
         code_provenance_collector =
           (Profiling::Collectors::CodeProvenance.new if settings.profiling.advanced.code_provenance_enabled)
 
         Profiling::Exporter.new(pprof_recorder: recorder, code_provenance_collector: code_provenance_collector)
       end
 
-      def build_profiler_oldstack_collector(settings, old_recorder, trace_identifiers_helper)
+      private_class_method def self.build_profiler_oldstack_collector(settings, old_recorder, tracer)
+        trace_identifiers_helper = Profiling::TraceIdentifiers::Helper.new(
+          tracer: tracer,
+          endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
+        )
+
         Profiling::Collectors::OldStack.new(
           old_recorder,
           trace_identifiers_helper: trace_identifiers_helper,
@@ -113,7 +115,7 @@ module Datadog
         )
       end
 
-      def build_profiler_transport(settings, agent_settings)
+      private_class_method def self.build_profiler_transport(settings, agent_settings)
         settings.profiling.exporter.transport ||
           Profiling::HttpTransport.new(
             agent_settings: agent_settings,
@@ -123,7 +125,7 @@ module Datadog
           )
       end
 
-      def should_enable_gc_profiling?(settings)
+      private_class_method def self.enable_gc_profiling?(settings)
         # See comments on the setting definition for more context on why it exists.
         if settings.profiling.advanced.force_enable_gc_profiling
           if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3')
@@ -139,21 +141,93 @@ module Datadog
         end
       end
 
-      def print_new_profiler_warnings
-        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+      private_class_method def self.print_new_profiler_warnings
+        return if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+
+        # For more details on the issue, see the "BIG Issue" comment on `gvl_owner` function in
+        # `private_vm_api_access.c`.
+        Datadog.logger.warn(
+          'The new CPU Profiling 2.0 profiler has been force-enabled on a legacy Ruby version (< 2.6). This is not ' \
+          'recommended in production environments, as due to limitations in Ruby APIs, we suspect it may lead to crashes ' \
+          'in very rare situations. Please report any issues you run into to Datadog support or ' \
+          'via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+        )
+      end
+
+      private_class_method def self.enable_new_profiler?(settings)
+        if settings.profiling.advanced.force_enable_legacy_profiler
           Datadog.logger.warn(
-            'New Ruby profiler has been force-enabled. This is a beta feature. Please report any issues ' \
-            'you run into to Datadog support or via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+            'Legacy profiler has been force-enabled via configuration. Do not use unless instructed to by support.'
           )
-        else
-          # For more details on the issue, see the "BIG Issue" comment on `gvl_owner` function in
-          # `private_vm_api_access.c`.
+          return false
+        end
+
+        return true if settings.profiling.advanced.force_enable_new_profiler
+
+        return false if RUBY_VERSION.start_with?('2.3.', '2.4.', '2.5.')
+
+        if Gem.loaded_specs['mysql2'] && incompatible_libmysqlclient_version?(settings)
+          Datadog.logger.warn(
+            'Falling back to legacy profiler because an incompatible version of the mysql2 gem is installed. ' \
+            'Older versions of libmysqlclient (the C ' \
+            'library used by the mysql2 gem) have a bug in their signal handling code that the new profiler can trigger. ' \
+            'This bug (https://bugs.mysql.com/bug.php?id=83109) is fixed in libmysqlclient versions 8.0.0 and above. '
+          )
+          return false
+        end
+
+        if Gem.loaded_specs['rugged']
           Datadog.logger.warn(
-            'New Ruby profiler has been force-enabled on a legacy Ruby version (< 2.6). This is not recommended in ' \
-            'production environments, as due to limitations in Ruby APIs, we suspect it may lead to crashes in very ' \
-            'rare situations. Please report any issues you run into to Datadog support or ' \
-            'via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+            'Falling back to legacy profiler because rugged gem is installed. Some operations on this gem are ' \
+            'currently incompatible with the new CPU Profiling 2.0 profiler, as detailed in ' \
+            '<https://github.com/datadog/dd-trace-rb/issues/2721>. If you still want to try out the new profiler, you ' \
+            'can force-enable it by using the `DD_PROFILING_FORCE_ENABLE_NEW` environment variable or the ' \
+            '`c.profiling.advanced.force_enable_new_profiler` setting.'
           )
+          return false
+        end
+
+        true
+      end
+
+      # Versions of libmysqlclient prior to 8.0.0 are known to have buggy handling of system call interruptions.
+      # The profiler can sometimes cause system call interruptions, and so this combination can cause queries to fail.
+      #
+      # See https://bugs.mysql.com/bug.php?id=83109 and
+      # https://docs.datadoghq.com/profiler/profiler_troubleshooting/ruby/#unexpected-run-time-failures-and-errors-from-ruby-gems-that-use-native-extensions-in-dd-trace-rb-1110
+      # for details.
+      #
+      # The `mysql2` gem's `info` method can be used to determine which `libmysqlclient` version is in use, and thus to
+      # detect if it's safe for the profiler to use signals or if we need to employ a fallback.
+      private_class_method def self.incompatible_libmysqlclient_version?(settings)
+        return true if settings.profiling.advanced.skip_mysql2_check
+
+        Datadog.logger.debug(
+          'Requiring `mysql2` to check if the `libmysqlclient` version it uses is compatible with profiling'
+        )
+
+        begin
+          require 'mysql2'
+
+          return true unless defined?(Mysql2::Client) && Mysql2::Client.respond_to?(:info)
+
+          libmysqlclient_version = Gem::Version.new(Mysql2::Client.info[:version])
+
+          compatible = libmysqlclient_version >= Gem::Version.new('8.0.0')
+
+          Datadog.logger.debug(
+            "The `mysql2` gem is using #{compatible ? 'a compatible' : 'an incompatible'} version of " \
+            "the `libmysqlclient` library (#{libmysqlclient_version})"
+          )
+
+          !compatible
+        rescue StandardError, LoadError => e
+          Datadog.logger.warn(
+            'Failed to probe `mysql2` gem information. ' \
+            "Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+          )
+
+          true
         end
       end
     end

data/lib/datadog/profiling/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     # Describes a sample of some data obtained from the runtime.

data/lib/datadog/profiling/events/stack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../event'
 
 module Datadog

data/lib/datadog/profiling/ext.rb

@@ -1,41 +1,43 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     module Ext
-      ENV_ENABLED = 'DD_PROFILING_ENABLED'.freeze
-      ENV_UPLOAD_TIMEOUT = 'DD_PROFILING_UPLOAD_TIMEOUT'.freeze
-      ENV_MAX_FRAMES = 'DD_PROFILING_MAX_FRAMES'.freeze
-      ENV_AGENTLESS = 'DD_PROFILING_AGENTLESS'.freeze
-      ENV_ENDPOINT_COLLECTION_ENABLED = 'DD_PROFILING_ENDPOINT_COLLECTION_ENABLED'.freeze
+      ENV_ENABLED = 'DD_PROFILING_ENABLED'
+      ENV_UPLOAD_TIMEOUT = 'DD_PROFILING_UPLOAD_TIMEOUT'
+      ENV_MAX_FRAMES = 'DD_PROFILING_MAX_FRAMES'
+      ENV_AGENTLESS = 'DD_PROFILING_AGENTLESS'
+      ENV_ENDPOINT_COLLECTION_ENABLED = 'DD_PROFILING_ENDPOINT_COLLECTION_ENABLED'
 
       # TODO: Consider removing this once the Ruby-based pprof encoding is removed and replaced by libdatadog
       module Pprof
-        LABEL_KEY_LOCAL_ROOT_SPAN_ID = 'local root span id'.freeze
-        LABEL_KEY_SPAN_ID = 'span id'.freeze
-        LABEL_KEY_THREAD_ID = 'thread id'.freeze
-        LABEL_KEY_TRACE_ENDPOINT = 'trace endpoint'.freeze
+        LABEL_KEY_LOCAL_ROOT_SPAN_ID = 'local root span id'
+        LABEL_KEY_SPAN_ID = 'span id'
+        LABEL_KEY_THREAD_ID = 'thread id'
+        LABEL_KEY_TRACE_ENDPOINT = 'trace endpoint'
         SAMPLE_VALUE_NO_VALUE = 0
-        VALUE_TYPE_CPU = 'cpu-time'.freeze
-        VALUE_TYPE_WALL = 'wall-time'.freeze
-        VALUE_UNIT_NANOSECONDS = 'nanoseconds'.freeze
+        VALUE_TYPE_CPU = 'cpu-time'
+        VALUE_TYPE_WALL = 'wall-time'
+        VALUE_UNIT_NANOSECONDS = 'nanoseconds'
       end
 
       module Transport
         module HTTP
-          FORM_FIELD_TAG_ENV = 'env'.freeze
-          FORM_FIELD_TAG_HOST = 'host'.freeze
-          FORM_FIELD_TAG_LANGUAGE = 'language'.freeze
-          FORM_FIELD_TAG_PID = 'process_id'.freeze
-          FORM_FIELD_TAG_PROFILER_VERSION = 'profiler_version'.freeze
-          FORM_FIELD_TAG_RUNTIME = 'runtime'.freeze
-          FORM_FIELD_TAG_RUNTIME_ENGINE = 'runtime_engine'.freeze
-          FORM_FIELD_TAG_RUNTIME_ID = 'runtime-id'.freeze
-          FORM_FIELD_TAG_RUNTIME_PLATFORM = 'runtime_platform'.freeze
-          FORM_FIELD_TAG_RUNTIME_VERSION = 'runtime_version'.freeze
-          FORM_FIELD_TAG_SERVICE = 'service'.freeze
-          FORM_FIELD_TAG_VERSION = 'version'.freeze
+          FORM_FIELD_TAG_ENV = 'env'
+          FORM_FIELD_TAG_HOST = 'host'
+          FORM_FIELD_TAG_LANGUAGE = 'language'
+          FORM_FIELD_TAG_PID = 'process_id'
+          FORM_FIELD_TAG_PROFILER_VERSION = 'profiler_version'
+          FORM_FIELD_TAG_RUNTIME = 'runtime'
+          FORM_FIELD_TAG_RUNTIME_ENGINE = 'runtime_engine'
+          FORM_FIELD_TAG_RUNTIME_ID = 'runtime-id'
+          FORM_FIELD_TAG_RUNTIME_PLATFORM = 'runtime_platform'
+          FORM_FIELD_TAG_RUNTIME_VERSION = 'runtime_version'
+          FORM_FIELD_TAG_SERVICE = 'service'
+          FORM_FIELD_TAG_VERSION = 'version'
 
-          PPROF_DEFAULT_FILENAME = 'rubyprofile.pprof'.freeze
-          CODE_PROVENANCE_FILENAME = 'code-provenance.json'.freeze
+          PPROF_DEFAULT_FILENAME = 'rubyprofile.pprof'
+          CODE_PROVENANCE_FILENAME = 'code-provenance.json'
         end
       end
     end

data/lib/datadog/profiling/flush.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     # Represents a collection of events of a specific type being flushed.

data/lib/datadog/profiling/native_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     # This module contains classes and methods which are implemented using native code in the

data/lib/datadog/profiling/pprof/message_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../core/utils/object_set'
 
 module Datadog

data/lib/datadog/profiling/pprof/payload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Profiling
     module Pprof

data/lib/datadog/profiling/pprof/string_table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../core/utils/string_table'
 
 module Datadog

data/lib/datadog/profiling/preload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../ddtrace'
 
 Datadog::Profiling.start_if_enabled

data/lib/datadog/profiling/scheduler.rb

@@ -118,7 +118,9 @@ module Datadog
         begin
           transport.export(flush)
         rescue StandardError => e
-          Datadog.logger.error("Unable to report profile. Cause: #{e} Location: #{Array(e.backtrace).first}")
+          Datadog.logger.error(
+            "Unable to report profile. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+          )
         end
 
         true

data/lib/datadog/profiling/stack_recorder.rb

@@ -48,24 +48,6 @@ module Datadog
         end
       end
 
-      def clear
-        status, result = @no_concurrent_synchronize_mutex.synchronize { self.class._native_clear(self) }
-
-        if status == :ok
-          finish_timestamp = result
-
-          Datadog.logger.debug { "Cleared profile at #{finish_timestamp}" }
-
-          finish_timestamp
-        else
-          error_message = result
-
-          Datadog.logger.error("Failed to clear profiling data: #{error_message}")
-
-          nil
-        end
-      end
-
       def reset_after_fork
         self.class._native_reset_after_fork(self)
       end

data/lib/datadog/profiling/tag_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../core/utils'
 
 module Datadog