ddtrace 1.4.2 → 1.19.0

data/lib/datadog/ci/test.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-# typed: false
-
-require_relative '../tracing/contrib/analytics'
-
-require_relative 'ext/app_types'
-require_relative 'ext/test'
-
-require 'rbconfig'
-
-module Datadog
-  module CI
-    # Common behavior for CI tests
-    module Test
-      # Creates a new span for a CI test
-      def self.trace(span_name, options = {})
-        span_options = {
-          span_type: Ext::AppTypes::TYPE_TEST
-        }.merge(options[:span_options] || {})
-
-        if block_given?
-          Tracing.trace(span_name, **span_options) do |span, trace|
-            set_tags!(trace, span, options)
-            yield(span, trace)
-          end
-        else
-          span = Tracing.trace(span_name, **span_options)
-          trace = Tracing.active_trace
-          set_tags!(trace, span, options)
-          span
-        end
-      end
-
-      # Adds tags to a CI test span.
-      def self.set_tags!(trace, span, tags = {})
-        tags ||= {}
-
-        # Set default tags
-        trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
-        Datadog::Tracing::Contrib::Analytics.set_measured(span)
-        span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_TEST)
-
-        # Set environment tags
-        @environment_tags ||= Ext::Environment.tags(ENV)
-        @environment_tags.each { |k, v| span.set_tag(k, v) }
-
-        # Set contextual tags
-        span.set_tag(Ext::Test::TAG_FRAMEWORK, tags[:framework]) if tags[:framework]
-        span.set_tag(Ext::Test::TAG_FRAMEWORK_VERSION, tags[:framework_version]) if tags[:framework_version]
-        span.set_tag(Ext::Test::TAG_NAME, tags[:test_name]) if tags[:test_name]
-        span.set_tag(Ext::Test::TAG_SUITE, tags[:test_suite]) if tags[:test_suite]
-        span.set_tag(Ext::Test::TAG_TYPE, tags[:test_type]) if tags[:test_type]
-
-        set_environment_runtime_tags!(span)
-
-        span
-      end
-
-      def self.passed!(span)
-        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::PASS)
-      end
-
-      def self.failed!(span, exception = nil)
-        span.status = 1
-        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::FAIL)
-        span.set_error(exception) unless exception.nil?
-      end
-
-      def self.skipped!(span, exception = nil)
-        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::SKIP)
-        span.set_error(exception) unless exception.nil?
-      end
-
-      private_class_method def self.set_environment_runtime_tags!(span)
-        span.set_tag(Ext::Test::TAG_OS_ARCHITECTURE, ::RbConfig::CONFIG['host_cpu'])
-        span.set_tag(Ext::Test::TAG_OS_PLATFORM, ::RbConfig::CONFIG['host_os'])
-        span.set_tag(Ext::Test::TAG_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
-        span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
-      end
-    end
-  end
-end

data/lib/datadog/ci.rb

@@ -1,20 +0,0 @@
-# typed: strict
-
-require_relative 'core'
-require_relative 'tracing'
-require_relative 'tracing/contrib'
-
-module Datadog
-  # Namespace for Datadog CI instrumentation:
-  # e.g. rspec, cucumber, etc...
-  module CI
-  end
-end
-
-# Integrations
-require_relative 'ci/contrib/cucumber/integration'
-require_relative 'ci/contrib/rspec/integration'
-
-# Extensions
-require_relative 'ci/extensions'
-Datadog::CI::Extensions.activate!

data/lib/datadog/core/configuration/dependency_resolver.rb

@@ -1,28 +0,0 @@
-# typed: false
-
-require 'tsort'
-
-module Datadog
-  module Core
-    module Configuration
-      # Resolver performs a topological sort over the dependency graph
-      class DependencyResolver
-        include TSort
-
-        def initialize(dependency_graph = {})
-          @dependency_graph = dependency_graph
-        end
-
-        def tsort_each_node(&blk)
-          @dependency_graph.each_key(&blk)
-        end
-
-        def tsort_each_child(node, &blk)
-          @dependency_graph.fetch(node).each(&blk)
-        end
-
-        alias call tsort
-      end
-    end
-  end
-end

data/lib/datadog/core/configuration/option_definition_set.rb

@@ -1,22 +0,0 @@
-# typed: true
-
-require_relative 'dependency_resolver'
-
-module Datadog
-  module Core
-    module Configuration
-      # Represents a set of configuration option definitions for an integration
-      class OptionDefinitionSet < Hash
-        def dependency_order
-          DependencyResolver.new(dependency_graph).call
-        end
-
-        def dependency_graph
-          each_with_object({}) do |(name, option), graph|
-            graph[name] = option.depends_on
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/core/configuration/option_set.rb

@@ -1,10 +0,0 @@
-# typed: true
-
-module Datadog
-  module Core
-    module Configuration
-      class OptionSet < Hash
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# typed: true
-
-require_relative 'sequence'
-
-module Datadog
-  module Core
-    module Utils
-      # Acts as a unique dictionary of objects
-      class ObjectSet
-        # You can provide a block that defines how the key
-        # for this message type is resolved.
-        def initialize(seed = 0, &block)
-          @sequence = Sequence.new(seed)
-          @items = {}
-          @key_block = block
-        end
-
-        # Submit an array of arguments that define the message.
-        # If they match an existing message, it will return the
-        # matching object. If it doesn't match, it will yield to
-        # the block with the next ID & args given.
-        def fetch(*args)
-          # TODO: Array hashing is **really** expensive, we probably want to get rid of it in the future
-          key = @key_block ? @key_block.call(*args) : args.hash
-          @items[key] ||= yield(@sequence.next, *args)
-        end
-
-        def length
-          @items.length
-        end
-
-        def objects
-          @items.values
-        end
-
-        def freeze
-          super
-          @items.freeze
-        end
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# typed: true
-
-require_relative 'sequence'
-
-module Datadog
-  module Core
-    module Utils
-      # Tracks strings and returns IDs
-      class StringTable
-        def initialize
-          @sequence = Sequence.new
-          @ids = { ''.freeze => @sequence.next }
-        end
-
-        # Returns an ID for the string
-        def fetch(string)
-          @ids[string.to_s] ||= @sequence.next
-        end
-
-        # Returns the canonical copy of this string
-        # Typically used for psuedo interning; reduce
-        # identical copies of a string to one object.
-        def fetch_string(string)
-          return nil if string.nil?
-
-          # Co-erce to string
-          string = string.to_s
-
-          # Add to string table if no match
-          @ids[string] = @sequence.next unless @ids.key?(string)
-
-          # Get and return matching string in table
-          # NOTE: Have to resolve the key and retrieve from table again
-          #       because "string" argument is not same object as string key.
-          id = @ids[string]
-          @ids.key(id)
-        end
-
-        def [](id)
-          @ids.key(id)
-        end
-
-        def strings
-          @ids.keys
-        end
-      end
-    end
-  end
-end

data/lib/datadog/profiling/backtrace_location.rb

@@ -1,34 +0,0 @@
-# typed: true
-
-module Datadog
-  module Profiling
-    # Entity class used to represent an entry in a stack trace.
-    # Its fields are a simplified struct version of `Thread::Backtrace::Location`.
-    class BacktraceLocation
-      attr_reader \
-        :base_label,
-        :lineno,
-        :path,
-        :hash
-
-      def initialize(
-        base_label,
-        lineno,
-        path
-      )
-        @base_label = base_label
-        @lineno = lineno
-        @path = path
-        @hash = [base_label, lineno, path].hash
-      end
-
-      def ==(other)
-        hash == other.hash
-      end
-
-      def eql?(other)
-        hash == other.hash
-      end
-    end
-  end
-end

data/lib/datadog/profiling/buffer.rb

@@ -1,43 +0,0 @@
-# typed: true
-
-require_relative '../core/buffer/thread_safe'
-require_relative '../core/utils/object_set'
-require_relative '../core/utils/string_table'
-
-module Datadog
-  module Profiling
-    # Profiling buffer that stores profiling events. The buffer has a maximum size and when
-    # the buffer is full, a random event is discarded. This class is thread-safe.
-    class Buffer < Core::Buffer::ThreadSafe
-      def initialize(*args)
-        super
-        @caches = {}
-        @string_table = Core::Utils::StringTable.new
-      end
-
-      def cache(cache_name)
-        synchronize do
-          @caches[cache_name] ||= Core::Utils::ObjectSet.new
-        end
-      end
-
-      def string_table
-        synchronize do
-          @string_table
-        end
-      end
-
-      protected
-
-      def drain!
-        items = super
-
-        # Clear caches
-        @caches = {}
-        @string_table = Core::Utils::StringTable.new
-
-        items
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# typed: false
-
-module Datadog
-  module Profiling
-    module Collectors
-      # Used to periodically sample threads, recording elapsed CPU-time and Wall-time between samples.
-      # Triggering of this component (e.g. deciding when to take a sample) is implemented in
-      # Collectors::CpuAndWallTimeWorker.
-      # The stack collection itself is handled using the Datadog::Profiling::Collectors::Stack.
-      # Almost all of this class is implemented as native code.
-      #
-      # Methods prefixed with _native_ are implemented in `collectors_cpu_and_wall_time.c`
-      class CpuAndWallTime
-        def initialize(recorder:, max_frames:)
-          self.class._native_initialize(self, recorder, max_frames)
-        end
-
-        def inspect
-          # Compose Ruby's default inspect with our custom inspect for the native parts
-          result = super()
-          result[-1] = "#{self.class._native_inspect(self)}>"
-          result
-        end
-      end
-    end
-  end
-end

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

@@ -1,298 +0,0 @@
-# typed: true
-
-require_relative '../../core/utils/only_once'
-require_relative '../../core/utils/time'
-require_relative '../../core/worker'
-require_relative '../../core/workers/polling'
-require_relative '../backtrace_location'
-require_relative '../events/stack'
-require_relative '../native_extension'
-
-module Datadog
-  module Profiling
-    module Collectors
-      # Collects stack trace samples from Ruby threads for both CPU-time (if available) and wall-clock.
-      # Runs on its own background thread.
-      #
-      # This class has the prefix "Old" because it will be deprecated by the new native CPU Profiler
-      class OldStack < Core::Worker # rubocop:disable Metrics/ClassLength
-        include Core::Workers::Polling
-
-        DEFAULT_MAX_TIME_USAGE_PCT = 2.0
-        MIN_INTERVAL = 0.01
-        THREAD_LAST_CPU_TIME_KEY = :datadog_profiler_last_cpu_time
-        THREAD_LAST_WALL_CLOCK_KEY = :datadog_profiler_last_wall_clock
-        SYNTHETIC_STACK_IN_NATIVE_CODE = [BacktraceLocation.new('', 0, 'In native code').freeze].freeze
-
-        # This default was picked based on the current sampling performance and on expected concurrency on an average
-        # Ruby MRI application. Lowering this optimizes for latency (less impact each time we sample), and raising
-        # optimizes for coverage (less chance to miss what a given thread is doing).
-        DEFAULT_MAX_THREADS_SAMPLED = 16
-
-        attr_reader \
-          :recorder,
-          :max_frames,
-          :trace_identifiers_helper,
-          :ignore_thread,
-          :max_time_usage_pct,
-          :thread_api,
-          :cpu_time_provider
-
-        def initialize(
-          recorder,
-          max_frames:,
-          trace_identifiers_helper:, # Usually an instance of Profiling::TraceIdentifiers::Helper
-          ignore_thread: nil,
-          max_time_usage_pct: DEFAULT_MAX_TIME_USAGE_PCT,
-          max_threads_sampled: DEFAULT_MAX_THREADS_SAMPLED,
-          thread_api: Thread,
-          cpu_time_provider: Profiling::NativeExtension,
-          fork_policy: Core::Workers::Async::Thread::FORK_POLICY_RESTART, # Restart in forks by default
-          interval: MIN_INTERVAL,
-          enabled: true
-        )
-          @recorder = recorder
-          @max_frames = max_frames
-          @trace_identifiers_helper = trace_identifiers_helper
-          @ignore_thread = ignore_thread
-          @max_time_usage_pct = max_time_usage_pct
-          @max_threads_sampled = max_threads_sampled
-          @thread_api = thread_api
-          # Only set the provider if it's able to work in the current Ruby/OS combo
-          @cpu_time_provider = cpu_time_provider unless cpu_time_provider.cpu_time_ns_for(thread_api.current).nil?
-
-          # Workers::Async::Thread settings
-          self.fork_policy = fork_policy
-
-          # Workers::IntervalLoop settings
-          self.loop_base_interval = interval
-
-          # Workers::Polling settings
-          self.enabled = enabled
-
-          # Cache this proc, since it's pretty expensive to keep recreating it
-          @build_backtrace_location = method(:build_backtrace_location).to_proc
-          # Cache this buffer, since it's pretty expensive to keep accessing it
-          @stack_sample_event_recorder = recorder[Events::StackSample]
-          # See below for details on why this is needed
-          @needs_process_waiter_workaround =
-            Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3') &&
-            Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
-        end
-
-        def start
-          reset_cpu_time_tracking
-          perform
-        end
-
-        def perform
-          collect_and_wait
-        end
-
-        def collect_and_wait
-          run_time = Core::Utils::Time.measure do
-            collect_events
-          end
-
-          # Update wait time to throttle profiling
-          self.loop_wait_time = compute_wait_time(run_time)
-        end
-
-        def collect_events
-          events = []
-          current_wall_time_ns = get_current_wall_time_timestamp_ns
-
-          # Collect backtraces from each thread
-          threads_to_sample.each do |thread|
-            next unless thread.alive?
-            next if ignore_thread.is_a?(Proc) && ignore_thread.call(thread)
-
-            event = collect_thread_event(thread, current_wall_time_ns)
-            events << event unless event.nil?
-          end
-
-          # Send events to recorder
-          recorder.push(events) unless events.empty?
-
-          events
-        end
-
-        def collect_thread_event(thread, current_wall_time_ns)
-          locations = thread.backtrace_locations
-          return if locations.nil?
-
-          # Having empty locations means that the thread is alive, but we don't know what it's doing:
-          #
-          # 1. It can be starting up
-          #    ```
-          #    > Thread.new { sleep }.backtrace
-          #    => [] # <-- note the thread hasn't actually started running sleep yet, we got there first
-          #    ```
-          # 2. It can be running native code
-          #    ```
-          #    > t = Process.detach(fork { sleep })
-          #    => #<Process::Waiter:0x00007ffe7285f7a0 run>
-          #    > t.backtrace
-          #    => [] # <-- this can happen even minutes later, e.g. it's not a race as in 1.
-          #    ```
-          #    This effect has been observed in threads created by the Iodine web server and the ffi gem
-          #
-          # To give customers visibility into these threads, we replace the empty stack with one containing a
-          # synthetic placeholder frame, so that these threads are properly represented in the UX.
-          locations = SYNTHETIC_STACK_IN_NATIVE_CODE if locations.empty?
-
-          # Get actual stack size then trim the stack
-          stack_size = locations.length
-          locations = locations[0..(max_frames - 1)]
-
-          # Convert backtrace locations into structs
-          locations = convert_backtrace_locations(locations)
-
-          thread_id = thread.object_id
-          root_span_id, span_id, trace_resource = trace_identifiers_helper.trace_identifiers_for(thread)
-          cpu_time = get_cpu_time_interval!(thread)
-          wall_time_interval_ns =
-            get_elapsed_since_last_sample_and_set_value(thread, THREAD_LAST_WALL_CLOCK_KEY, current_wall_time_ns)
-
-          Events::StackSample.new(
-            nil,
-            locations,
-            stack_size,
-            thread_id,
-            root_span_id,
-            span_id,
-            trace_resource,
-            cpu_time,
-            wall_time_interval_ns
-          )
-        end
-
-        def get_cpu_time_interval!(thread)
-          return unless cpu_time_provider
-
-          current_cpu_time_ns = cpu_time_provider.cpu_time_ns_for(thread)
-
-          return unless current_cpu_time_ns
-
-          get_elapsed_since_last_sample_and_set_value(thread, THREAD_LAST_CPU_TIME_KEY, current_cpu_time_ns)
-        end
-
-        def compute_wait_time(used_time)
-          # We took used_time to get the last sample.
-          #
-          # What we're computing here is -- if used_time corresponds to max_time_usage_pct of the time we should
-          # spend working, how much is (100% - max_time_usage_pct) of the time?
-          #
-          # For instance, if we took 10ms to sample, and max_time_usage_pct is 1%, then the other 99% is 990ms, which
-          # means we need to sleep for 990ms to guarantee that we don't spend more than 1% of the time working.
-          used_time_ns = used_time * 1e9
-          interval = (used_time_ns / (max_time_usage_pct / 100.0)) - used_time_ns
-          [interval / 1e9, MIN_INTERVAL].max
-        end
-
-        # Convert backtrace locations into structs
-        # Re-use old backtrace location objects if they already exist in the buffer
-        def convert_backtrace_locations(locations)
-          locations.collect do |location|
-            # Re-use existing BacktraceLocation if identical copy, otherwise build a new one.
-            @stack_sample_event_recorder.cache(:backtrace_locations).fetch(
-              # Function name
-              location.base_label,
-              # Line number
-              location.lineno,
-              # Filename
-              location.path,
-              # Build function
-              &@build_backtrace_location
-            )
-          end
-        end
-
-        def build_backtrace_location(_id, base_label, lineno, path)
-          string_table = @stack_sample_event_recorder.string_table
-
-          Profiling::BacktraceLocation.new(
-            string_table.fetch_string(base_label),
-            lineno,
-            string_table.fetch_string(path)
-          )
-        end
-
-        private
-
-        # If the profiler is started for a while, stopped and then restarted OR whenever the process forks, we need to
-        # clean up any leftover per-thread counters, so that the first sample after starting doesn't end up with:
-        #
-        # a) negative time: At least on my test docker container, and on the reliability environment, after the process
-        #    forks, the cpu time reference changes and (old cpu time - new cpu time) can be < 0
-        #
-        # b) large amount of time: if the profiler was started, then stopped for some amount of time, and then
-        #    restarted, we don't want the first sample to be "blamed" for multiple minutes of CPU time
-        #
-        # By resetting the last cpu time seen, we start with a clean slate every time we start the stack collector.
-        def reset_cpu_time_tracking
-          thread_api.list.each do |thread|
-            # See below for details on why this is needed
-            next if @needs_process_waiter_workaround && thread.is_a?(::Process::Waiter)
-
-            thread.thread_variable_set(THREAD_LAST_CPU_TIME_KEY, nil)
-            thread.thread_variable_set(THREAD_LAST_WALL_CLOCK_KEY, nil)
-          end
-        end
-
-        def get_elapsed_since_last_sample_and_set_value(thread, key, current_value)
-          # 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 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 or thread variables. This subclass of thread only
-          # shows up when the `Process.detach` API gets used.
-          # In the specs you'll find crash regression tests that include a way of reproducing it.
-          #
-          # As workaround for now we just skip it for the affected Rubies
-          return 0 if @needs_process_waiter_workaround && thread.is_a?(::Process::Waiter)
-
-          last_value = thread.thread_variable_get(key) || current_value
-          thread.thread_variable_set(key, current_value)
-
-          current_value - last_value
-        end
-
-        # Whenever there are more than max_threads_sampled active, we only sample a subset of them.
-        # We do this to avoid impacting the latency of the service being profiled. We want to avoid doing
-        # a big burst of work all at once (sample everything), and instead do a little work each time
-        # (sample a bit by bit).
-        #
-        # Because we pick the threads to sample randomly, we'll eventually sample all threads -- just not at once.
-        # Notice also that this will interact with our dynamic sampling mechanism -- if samples are faster, we take
-        # them more often, if they are slower, we take them less often -- which again means that over a longer period
-        # we should take sample roughly the same samples.
-        #
-        # One downside of this approach is that if there really are many threads, the resulting wall clock times
-        # in a one minute profile may "drift" around the 60 second mark, e.g. maybe we only sampled a thread once per
-        # second and only 59 times, so we'll report 59s, but on the next report we'll include the missing one, so
-        # then the result will be 61s. I've observed 60 +- 1.68 secs for an app with ~65 threads, given the
-        # default maximum of 16 threads. This seems a reasonable enough margin of error given the improvement to
-        # latency (especially on such a large application! -> even bigger latency impact if we tried to sample all
-        # threads).
-        #
-        def threads_to_sample
-          all_threads = thread_api.list
-
-          if all_threads.size > @max_threads_sampled
-            all_threads.sample(@max_threads_sampled)
-          else
-            all_threads
-          end
-        end
-
-        def get_current_wall_time_timestamp_ns
-          Core::Utils::Time.get_time(:nanosecond)
-        end
-      end
-    end
-  end
-end