ddtrace 0.49.0 → 1.12.1

data/lib/ddtrace/patcher.rb

@@ -1,68 +0,0 @@
-require 'ddtrace/utils/only_once'
-
-module Datadog
-  # Deprecated: This module should no longer be included. It's only being kept around for backwards compatibility
-  # concerns regarding customer usage.
-  module Patcher
-    INCLUDED_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-    DO_ONCE_USAGE_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-
-    def self.included(base)
-      INCLUDED_WARN_ONLY_ONCE.run do
-        Datadog.logger.warn(
-          'Including Datadog::Patcher is deprecated. ' \
-          'For the #do_once behavior, use Datadog::Utils::OnlyOnce instead. ' \
-          'For the #without_warnings behavior, use Datadog::Patcher.without_warnings { ... } as a module function.'
-        )
-      end
-
-      base.send(:extend, CommonMethods)
-      base.send(:include, CommonMethods)
-    end
-
-    # Defines some common methods for patching, that can be used
-    # at the instance, class, or module level.
-    module CommonMethods
-      def without_warnings
-        # This is typically used when monkey patching functions such as
-        # intialize, which Ruby advices you not to. Use cautiously.
-        v = $VERBOSE
-        $VERBOSE = nil
-        begin
-          yield
-        ensure
-          $VERBOSE = v
-        end
-      end
-
-      def do_once(key = nil, options = {})
-        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
-          Datadog.logger.warn('Datadog::Patcher#do_once is deprecated. Use Datadog::Utils::OnlyOnce instead.')
-        end
-
-        # If already done, don't do again
-        @done_once ||= Hash.new { |h, k| h[k] = {} }
-        return @done_once[key][options[:for]] if @done_once.key?(key) && @done_once[key].key?(options[:for])
-
-        # Otherwise 'do'
-        yield.tap do
-          # Then add the key so we don't do again.
-          @done_once[key][options[:for]] = true
-        end
-      end
-
-      def done?(key, options = {})
-        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
-          Datadog.logger.warn('Datadog::Patcher#done? is deprecated. Use Datadog::Utils::OnlyOnce instead.')
-        end
-
-        return false unless instance_variable_defined?(:@done_once)
-
-        !@done_once.nil? && @done_once.key?(key) && @done_once[key].key?(options[:for])
-      end
-    end
-
-    # Extend the common methods so they're available as a module function.
-    extend(CommonMethods)
-  end
-end

data/lib/ddtrace/pin.rb

@@ -1,85 +0,0 @@
-require 'ddtrace/patcher'
-require 'ddtrace/utils/only_once'
-
-# \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
-module Datadog
-  # A \Pin (a.k.a Patch INfo) is a small class which is used to
-  # set tracing metadata on a particular traced object.
-  # This is useful if you wanted to, say, trace two different
-  # database clusters.
-  class Pin
-    DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-
-    def self.get_from(obj)
-      return nil unless obj.respond_to? :datadog_pin
-
-      obj.datadog_pin
-    end
-
-    attr_accessor :app, :app_type, :config, :name, :service_name, :tags, :writer
-
-    alias service= service_name=
-    alias service service_name
-
-    def initialize(service_name, options = {})
-      deprecation_warning unless options[:tracer].is_a?(Proc) || options[:tracer].nil?
-
-      @app = options[:app]
-      @app_type = options[:app_type]
-      @config = options[:config]
-      @name = nil # this would rarely be overriden as it's really span-specific
-      @service_name = service_name
-      @tags = options[:tags]
-      @tracer = options[:tracer]
-    end
-
-    def tracer
-      @tracer.is_a?(Proc) ? @tracer.call : (@tracer || Datadog.tracer)
-    end
-
-    def enabled?
-      return tracer.enabled if tracer
-
-      false
-    end
-
-    # rubocop:disable Style/TrivialAccessors
-    def onto(obj)
-      unless obj.respond_to? :datadog_pin=
-        obj.instance_exec do
-          def datadog_pin=(pin)
-            @datadog_pin = pin
-          end
-        end
-      end
-
-      unless obj.respond_to? :datadog_pin
-        obj.instance_exec do
-          def datadog_pin
-            @datadog_pin
-          end
-        end
-      end
-
-      obj.datadog_pin = self
-    end
-
-    def to_s
-      "Pin(service:#{service},app:#{app},app_type:#{app_type},name:#{name})"
-    end
-
-    private
-
-    DEPRECATION_WARNING = %(
-      Explicitly providing a tracer instance is DEPRECATED.
-      It's recommended to not provide an explicit tracer instance
-      and let Datadog::Pin resolve the correct tracer internally.
-      ).freeze
-
-    def deprecation_warning
-      DEPRECATION_WARN_ONLY_ONCE.run do
-        Datadog.logger.warn("Datadog::Pin.new:#{DEPRECATION_WARNING}")
-      end
-    end
-  end
-end

data/lib/ddtrace/pipeline/span_filter.rb

@@ -1,38 +0,0 @@
-module Datadog
-  module Pipeline
-    # SpanFilter implements a processor that filters entire span subtrees
-    class SpanFilter
-      def initialize(filter = nil, &block)
-        callable = filter || block
-
-        raise(ArgumentError) unless callable.respond_to?(:call)
-
-        @criteria = filter || block
-      end
-
-      # NOTE: this SpanFilter implementation only handles traces in which child spans appear
-      # after parent spans in the trace array. If in the future child spans can be before
-      # parent spans, then the code below will need to be updated.
-      def call(trace)
-        deleted = Set.new
-
-        trace.delete_if do |span|
-          if deleted.include?(span.parent)
-            deleted << span
-            true
-          else
-            drop = drop_it?(span)
-            deleted << span if drop
-            drop
-          end
-        end
-      end
-
-      private
-
-      def drop_it?(span)
-        @criteria.call(span) rescue false
-      end
-    end
-  end
-end

data/lib/ddtrace/pipeline/span_processor.rb

@@ -1,20 +0,0 @@
-module Datadog
-  module Pipeline
-    # SpanProcessor
-    class SpanProcessor
-      def initialize(operation = nil, &block)
-        callable = operation || block
-
-        raise(ArgumentError) unless callable.respond_to?(:call)
-
-        @operation = operation || block
-      end
-
-      def call(trace)
-        trace.each do |span|
-          @operation.call(span) rescue next
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/pipeline.rb

@@ -1,46 +0,0 @@
-module Datadog
-  # Pipeline
-  module Pipeline
-    require_relative 'pipeline/span_filter'
-    require_relative 'pipeline/span_processor'
-
-    @mutex = Mutex.new
-    @processors = []
-
-    def self.before_flush(*processors, &processor_block)
-      processors = [processor_block] if processors.empty?
-
-      @mutex.synchronize do
-        @processors.concat(processors)
-      end
-    end
-
-    def self.process!(traces)
-      @mutex.synchronize do
-        traces
-          .map(&method(:apply_processors!))
-          .select(&:any?)
-      end
-    end
-
-    def self.processors=(value)
-      @processors = value
-    end
-
-    def self.apply_processors!(trace)
-      result = @processors.inject(trace) do |current_trace, processor|
-        processor.call(current_trace)
-      end
-
-      result || []
-    rescue => e
-      Datadog.logger.debug(
-        "trace dropped entirely due to `Pipeline.before_flush` error: #{e}"
-      )
-
-      []
-    end
-
-    private_class_method :apply_processors!
-  end
-end

data/lib/ddtrace/profiling/backtrace_location.rb

@@ -1,32 +0,0 @@
-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/ddtrace/profiling/buffer.rb

@@ -1,41 +0,0 @@
-require 'ddtrace/buffer'
-require 'ddtrace/utils/string_table'
-require 'ddtrace/utils/object_set'
-
-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 < Datadog::ThreadSafeBuffer
-      def initialize(*args)
-        super
-        @caches = {}
-        @string_table = Utils::StringTable.new
-      end
-
-      def cache(cache_name)
-        synchronize do
-          @caches[cache_name] ||= Utils::ObjectSet.new
-        end
-      end
-
-      def string_table
-        synchronize do
-          @string_table
-        end
-      end
-
-      protected
-
-      def drain!
-        items = super
-
-        # Clear caches
-        @caches = {}
-        @string_table = Utils::StringTable.new
-
-        items
-      end
-    end
-  end
-end

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

@@ -1,259 +0,0 @@
-require 'ddtrace/profiling/backtrace_location'
-require 'ddtrace/profiling/events/stack'
-require 'ddtrace/utils/only_once'
-require 'ddtrace/utils/time'
-require 'ddtrace/worker'
-require 'ddtrace/workers/polling'
-
-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.
-      #
-      # rubocop:disable Metrics/ClassLength
-      class Stack < Worker
-        include Workers::Polling
-
-        DEFAULT_MAX_TIME_USAGE_PCT = 2.0
-        MIN_INTERVAL = 0.01
-        THREAD_LAST_CPU_TIME_KEY = :datadog_profiler_last_cpu_time
-
-        attr_reader \
-          :recorder,
-          :max_frames,
-          :ignore_thread,
-          :max_time_usage_pct,
-          :thread_api
-
-        def initialize(
-          recorder,
-          max_frames:,
-          ignore_thread: nil,
-          max_time_usage_pct: DEFAULT_MAX_TIME_USAGE_PCT,
-          thread_api: Thread,
-          fork_policy: Workers::Async::Thread::FORK_POLICY_RESTART, # Restart in forks by default
-          interval: MIN_INTERVAL,
-          enabled: true
-        )
-          @recorder = recorder
-          @max_frames = max_frames
-          @ignore_thread = ignore_thread
-          @max_time_usage_pct = max_time_usage_pct
-          @thread_api = thread_api
-
-          # Workers::Async::Thread settings
-          self.fork_policy = fork_policy
-
-          # Workers::IntervalLoop settings
-          self.loop_base_interval = interval
-
-          # Workers::Polling settings
-          self.enabled = enabled
-
-          @warn_about_missing_cpu_time_instrumentation_only_once = Datadog::Utils::OnlyOnce.new
-
-          # 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]
-        end
-
-        def start
-          @last_wall_time = Datadog::Utils::Time.get_time
-          reset_cpu_time_tracking
-          perform
-        end
-
-        def perform
-          collect_and_wait
-        end
-
-        def loop_back_off?
-          false
-        end
-
-        def collect_and_wait
-          run_time = Datadog::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 = []
-
-          # Compute wall time interval
-          current_wall_time = Datadog::Utils::Time.get_time
-          last_wall_time = if instance_variable_defined?(:@last_wall_time)
-                             @last_wall_time
-                           else
-                             current_wall_time
-                           end
-
-          wall_time_interval_ns = ((current_wall_time - last_wall_time).round(9) * 1e9).to_i
-          @last_wall_time = current_wall_time
-
-          # Collect backtraces from each thread
-          thread_api.list.each do |thread|
-            next unless thread.alive?
-            next if ignore_thread.is_a?(Proc) && ignore_thread.call(thread)
-
-            event = collect_thread_event(thread, wall_time_interval_ns)
-            events << event unless event.nil?
-          end
-
-          # Send events to recorder
-          recorder.push(events) unless events.empty?
-
-          events
-        end
-
-        def collect_thread_event(thread, wall_time_interval_ns)
-          locations = thread.backtrace_locations
-          return if locations.nil?
-
-          # 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.respond_to?(:native_thread_id) ? thread.native_thread_id : thread.object_id
-          trace_id, span_id = get_trace_identifiers(thread)
-          cpu_time = get_cpu_time_interval!(thread)
-
-          Events::StackSample.new(
-            nil,
-            locations,
-            stack_size,
-            thread_id,
-            trace_id,
-            span_id,
-            cpu_time,
-            wall_time_interval_ns
-          )
-        end
-
-        def get_cpu_time_interval!(thread)
-          # Return if we can't get the current CPU time
-          unless thread.respond_to?(:cpu_time_instrumentation_installed?) && thread.cpu_time_instrumentation_installed?
-            warn_about_missing_cpu_time_instrumentation(thread)
-            return
-          end
-
-          current_cpu_time_ns = thread.cpu_time(:nanosecond)
-
-          # NOTE: This can still be nil even when all of the checks above passed because of a race: there's a bit of
-          # initialization that needs to be done by the thread itself, and it's possible for us to try to sample
-          # *before* the thread had time to finish the initialization
-          return unless current_cpu_time_ns
-
-          last_cpu_time_ns = (thread[THREAD_LAST_CPU_TIME_KEY] || current_cpu_time_ns)
-          interval = current_cpu_time_ns - last_cpu_time_ns
-
-          # Update CPU time for thread
-          thread[THREAD_LAST_CPU_TIME_KEY] = current_cpu_time_ns
-
-          # Return interval
-          interval
-        end
-
-        def get_trace_identifiers(thread)
-          return unless thread.is_a?(::Thread)
-          return unless Datadog.respond_to?(:tracer) && Datadog.tracer.respond_to?(:active_correlation)
-
-          identifier = Datadog.tracer.active_correlation(thread)
-          [identifier.trace_id, identifier.span_id]
-        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
-
-        def warn_about_missing_cpu_time_instrumentation(thread)
-          @warn_about_missing_cpu_time_instrumentation_only_once.run do
-            # Is the profiler thread instrumented? If it is, then we know instrumentation is available, but seems to be
-            # missing on this thread we just found.
-            #
-            # As far as we know, it can be missing due to one the following:
-            #
-            # a) The thread was started before we installed our instrumentation.
-            #    In this case, the fix is to make sure ddtrace gets loaded before any other parts of the application.
-            #
-            # b) The thread was started using the Ruby native APIs (e.g. from a C extension such as ffi).
-            #    We currently have no solution for this case; these threads will always be missing our CPU instrumentation.
-            #
-            # c) The thread was started with `Thread.start`/`Thread.fork` and hasn't yet enabled the instrumentation.
-            #    When threads are started using these APIs, there's a small time window during which the thread has started
-            #    but our code to apply the instrumentation hasn't run yet; in these cases it's just a matter of allowing
-            #    it to run and our instrumentation to be applied.
-            #
-            if thread_api.current.respond_to?(:cpu_time) && thread_api.current.cpu_time
-              Datadog.logger.debug("Detected thread ('#{thread}') with missing CPU profiling instrumentation.")
-            end
-          end
-        end
-
-        # If the profiler is started for a while, stopped and then restarted OR whenever the process forks, we need to
-        # clean up the per-thread cpu time counters we keep, 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 clock 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|
-            thread[THREAD_LAST_CPU_TIME_KEY] = nil if thread[THREAD_LAST_CPU_TIME_KEY]
-          end
-        end
-      end
-      # rubocop:enable Metrics/ClassLength
-    end
-  end
-end

data/lib/ddtrace/profiling/encoding/profile.rb

@@ -1,31 +0,0 @@
-require 'set'
-
-require 'ddtrace/profiling/flush'
-require 'ddtrace/profiling/pprof/template'
-
-module Datadog
-  module Profiling
-    module Encoding
-      module Profile
-        # Encodes gathered data into the pprof format
-        module Protobuf
-          module_function
-
-          def encode(flush)
-            return unless flush
-
-            # Create a pprof template from the list of event types
-            event_classes = flush.event_groups.collect(&:event_class).uniq
-            template = Pprof::Template.for_event_classes(event_classes)
-
-            # Add all events to the pprof
-            flush.event_groups.each { |event_group| template.add_events!(event_group.event_class, event_group.events) }
-
-            # Build the profile and encode it
-            template.to_pprof
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/profiling/event.rb

@@ -1,13 +0,0 @@
-module Datadog
-  module Profiling
-    # Describes a sample of some data obtained from the runtime.
-    class Event
-      attr_reader \
-        :timestamp
-
-      def initialize(timestamp = nil)
-        @timestamp = timestamp || Time.now.utc.to_f
-      end
-    end
-  end
-end