ddtrace 0.53.0 → 0.54.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.54.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: debase-ruby_core_source
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.10.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.10.12
 description: |
   ddtrace is Datadog’s tracing client for Ruby. It is used to trace requests
   as they flow across web servers, databases and microservices so that developers
@@ -66,7 +66,13 @@ files:
 - docs/DevelopmentGuide.md
 - docs/GettingStarted.md
 - docs/ProfilingDevelopment.md
+- ext/ddtrace_profiling_native_extension/NativeExtensionDesign.md
+- ext/ddtrace_profiling_native_extension/clock_id.h
+- ext/ddtrace_profiling_native_extension/clock_id_from_pthread.c
+- ext/ddtrace_profiling_native_extension/clock_id_noop.c
 - ext/ddtrace_profiling_native_extension/extconf.rb
+- ext/ddtrace_profiling_native_extension/private_vm_api_access.c
+- ext/ddtrace_profiling_native_extension/private_vm_api_access.h
 - ext/ddtrace_profiling_native_extension/profiling.c
 - lib/datadog/ci.rb
 - lib/datadog/ci/configuration/components.rb
@@ -374,6 +380,7 @@ files:
 - lib/ddtrace/contrib/redis/configuration/resolver.rb
 - lib/ddtrace/contrib/redis/configuration/settings.rb
 - lib/ddtrace/contrib/redis/ext.rb
+- lib/ddtrace/contrib/redis/instrumentation.rb
 - lib/ddtrace/contrib/redis/integration.rb
 - lib/ddtrace/contrib/redis/patcher.rb
 - lib/ddtrace/contrib/redis/quantize.rb
@@ -505,8 +512,6 @@ files:
 - lib/ddtrace/profiling/event.rb
 - lib/ddtrace/profiling/events/stack.rb
 - lib/ddtrace/profiling/exporter.rb
-- lib/ddtrace/profiling/ext/cpu.rb
-- lib/ddtrace/profiling/ext/cthread.rb
 - lib/ddtrace/profiling/ext/forking.rb
 - lib/ddtrace/profiling/flush.rb
 - lib/ddtrace/profiling/native_extension.rb

data/lib/ddtrace/profiling/ext/cpu.rb

@@ -1,67 +0,0 @@
-# typed: true
-module Datadog
-  module Profiling
-    module Ext
-      # Monkey patches Ruby's `Thread` with our `Ext::CThread` to enable CPU-time profiling
-      module CPU
-        # We cannot apply our CPU extension if a broken rollbar is around because that can cause customer apps to fail
-        # with a SystemStackError: stack level too deep.
-        #
-        # This occurs whenever our extensions to Thread are applied BEFORE rollbar applies its own. This happens
-        # because a loop forms: our extension tries to call Thread#initialize, but it's intercepted by rollbar, which
-        # then tries to call the original Thread#initialize as well, but instead alls our extension, leading to stack
-        # exhaustion.
-        #
-        # See https://github.com/rollbar/rollbar-gem/pull/1018 for more details on the issue
-        ROLLBAR_INCOMPATIBLE_VERSIONS = Gem::Requirement.new('<= 3.1.1')
-
-        def self.supported?
-          unsupported_reason.nil?
-        end
-
-        def self.apply!
-          return false unless supported?
-
-          # Applying CThread to Thread will ensure any new threads
-          # will provide a thread/clock ID for CPU timing.
-          require 'ddtrace/profiling/ext/cthread'
-          ::Thread.prepend(Profiling::Ext::CThread)
-          ::Thread.singleton_class.prepend(Datadog::Profiling::Ext::WrapThreadStartFork)
-        end
-
-        def self.unsupported_reason
-          # NOTE: Only the first matching reason is returned, so try to keep a nice order on reasons -- e.g. tell users
-          # first that they can't use this on macOS before telling them that they have the wrong ffi version
-
-          if RUBY_ENGINE == 'jruby'
-            'JRuby is not supported'
-          elsif RUBY_PLATFORM.include?('darwin')
-            'Feature requires Linux; macOS is not supported'
-          elsif RUBY_PLATFORM =~ /(mswin|mingw)/
-            'Feature requires Linux; Windows is not supported'
-          elsif !RUBY_PLATFORM.include?('linux')
-            "Feature requires Linux; #{RUBY_PLATFORM} is not supported"
-          elsif Gem::Specification.find_all_by_name('rollbar', ROLLBAR_INCOMPATIBLE_VERSIONS).any?
-            'You have an incompatible rollbar gem version installed; ensure that you have rollbar >= 3.1.2 by ' \
-            "adding `gem 'rollbar', '>= 3.1.2'` to your Gemfile or gems.rb file. " \
-            'See https://github.com/rollbar/rollbar-gem/pull/1018 for details'
-          elsif Gem::Specification.find_all_by_name('logging').any? && logging_inherit_context_enabled?
-            'The `logging` gem is installed and its thread inherit context feature is enabled. ' \
-            "Please add LOGGING_INHERIT_CONTEXT=false to your application's environment variables to disable the " \
-            'conflicting `logging` gem feature. ' \
-            'See https://github.com/TwP/logging/pull/230 for details'
-          end
-        end
-
-        private_class_method def self.logging_inherit_context_enabled?
-          # The logging gem provides a mechanism to disable the conflicting behavior, see
-          # https://github.com/TwP/logging/blob/ae9872d093833b2a5a34cbe1faa4e895a81f6845/lib/logging/diagnostic_context.rb#L418
-          # Here we check if the behavior is enabled
-          inherit_context_configuration = ENV['LOGGING_INHERIT_CONTEXT']
-
-          inherit_context_configuration.nil? || !%w[false no 0].include?(inherit_context_configuration.downcase)
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/profiling/ext/cthread.rb

@@ -1,156 +0,0 @@
-# typed: false
-require 'ffi'
-
-module Datadog
-  module Profiling
-    module Ext
-      # C-struct for retrieving clock ID from pthread
-      class CClockId < FFI::Struct
-        layout :value, :int
-      end
-
-      # Enables interfacing with pthread via FFI
-      module NativePthread
-        extend FFI::Library
-        ffi_lib ['pthread', 'libpthread.so.0']
-        attach_function :pthread_self, [], :ulong
-        attach_function :pthread_getcpuclockid, [:ulong, CClockId], :int
-
-        # NOTE: Only returns thread ID for thread that evaluates this call.
-        #       a.k.a. evaluating `get_pthread_thread_id(thread_a)` from within
-        #       `thread_b` will return `thread_b`'s thread ID, not `thread_a`'s.
-        def self.get_pthread_thread_id(thread)
-          return unless ::Thread.current == thread
-
-          pthread_self
-        end
-
-        def self.get_clock_id(thread, pthread_id)
-          return unless ::Thread.current == thread && pthread_id
-
-          clock = CClockId.new
-          clock[:value] = 0
-          pthread_getcpuclockid(pthread_id, clock).zero? ? clock[:value] : nil
-        end
-      end
-
-      # Extension used to enable CPU-time profiling via use of pthread's `getcpuclockid`.
-      module CThread
-        def self.prepended(base)
-          # Threads that have already been created, will not have resolved
-          # a thread/clock ID. This is because these IDs can only be resolved
-          # from within the thread's execution context, which we do not control.
-          #
-          # We can mitigate this for the current thread via #update_native_ids,
-          # since we are currently running within its execution context. We cannot
-          # do this for any other threads that may have been created already.
-          # (This is why it's important that CThread is applied before anything else runs.)
-          base.current.send(:update_native_ids) if base.current.is_a?(CThread)
-        end
-
-        # Process::Waiter crash workaround:
-        #
-        # This is a workaround for a Ruby VM segfault (usually something like
-        # "[BUG] Segmentation fault at 0x0000000000000008") in the affected Ruby versions.
-        # See https://bugs.ruby-lang.org/issues/17807 and the regression tests added to this module's specs for details.
-        #
-        # In those Ruby versions, there's a very special subclass of `Thread` called `Process::Waiter` that causes VM
-        # crashes whenever something tries to read its instance variables. This subclass of thread only shows up when
-        # the `Process.detach` API gets used.
-        # In this module's specs you can find crash regression tests that include a way of reproducing it.
-        #
-        # The workaround is to use `defined?` to check first if the instance variable exists. This seems to be fine
-        # with Ruby.
-        # Note that this crash doesn't affect `@foo ||=` nor instance variable writes (after the first write ever of any
-        # instance variable on a `Process::Waiter`, then further reads and writes to that or any other instance are OK;
-        # it looks like there's some lazily-created structure that is missing and did not get created).
-        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3') &&
-           Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
-          attr_reader :pthread_thread_id
-        else
-          def pthread_thread_id
-            defined?(@pthread_thread_id) && @pthread_thread_id
-          end
-        end
-
-        def initialize(*args)
-          @pid = ::Process.pid
-          @pthread_thread_id = nil
-          @clock_id = nil
-
-          # Wrap the work block with our own
-          # so we can retrieve the native thread ID within the thread's context.
-          wrapped_block = proc do |*t_args|
-            # Set native thread ID & clock ID
-            update_native_ids
-            yield(*t_args)
-          end
-          wrapped_block.ruby2_keywords if wrapped_block.respond_to?(:ruby2_keywords, true)
-
-          super(*args, &wrapped_block)
-        end
-        ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
-
-        def cpu_time(unit = :float_second)
-          ::Process.clock_gettime(clock_id, unit) if clock_id
-        end
-
-        def cpu_time_instrumentation_installed?
-          # If this thread was started before this module was added to Thread OR if something caused the initialize
-          # method above not to be properly called on new threads, this instance variable is never defined (never set to
-          # any value at all, including nil).
-          #
-          # Thus, we can use @clock_id as a canary to detect a thread that has missing instrumentation, because we
-          # know that in initialize above we always set this variable to nil.
-          defined?(@clock_id) != nil
-        end
-
-        private
-
-        def clock_id
-          update_native_ids if forked?
-          defined?(@clock_id) && @clock_id
-        end
-
-        def forked?
-          ::Process.pid != (@pid ||= nil)
-        end
-
-        def update_native_ids
-          # Can only resolve if invoked from same thread
-          return unless ::Thread.current == self
-
-          @pid = ::Process.pid
-          @pthread_thread_id = NativePthread.get_pthread_thread_id(self)
-          @clock_id = NativePthread.get_clock_id(self, @pthread_thread_id)
-        end
-      end
-
-      # Threads in Ruby can be started by creating a new instance of `Thread` (or a subclass) OR by calling
-      # `start`/`fork` on `Thread` (or a subclass).
-      #
-      # This module intercepts calls to `start`/`fork`, ensuring that the `update_native_ids` operation is correctly
-      # called once the new thread starts.
-      #
-      # Note that unlike CThread above, this module should be prepended to the `Thread`'s singleton class, not to
-      # the class.
-      module WrapThreadStartFork
-        def start(*args)
-          # Wrap the work block with our own
-          # so we can retrieve the native thread ID within the thread's context.
-          wrapped_block = proc do |*t_args|
-            # Set native thread ID & clock ID
-            ::Thread.current.send(:update_native_ids)
-            yield(*t_args)
-          end
-          wrapped_block.ruby2_keywords if wrapped_block.respond_to?(:ruby2_keywords, true)
-
-          super(*args, &wrapped_block)
-        end
-        ruby2_keywords :start if respond_to?(:ruby2_keywords, true)
-
-        alias fork start
-      end
-    end
-  end
-end