datadog 2.12.0 → 2.22.0

data/lib/datadog/di/instrumenter.rb

@@ -3,6 +3,7 @@
 require_relative '../core/utils/time'
 
 # rubocop:disable Lint/AssignmentInCondition
+# rubocop:disable Style/AndOr
 
 module Datadog
   module DI
@@ -52,6 +53,17 @@ module Datadog
     # (however, Probe instances can be replaced by OpenStruct instances
     # providing the same interface with not much effort).
     #
+    # Instrumenter (this class) is responsible for building snapshots.
+    # This is because to capture values on method entry, those values need to
+    # be duplicated or serialized into immutable values to prevent their
+    # modification by the instrumented method. Therefore this class must
+    # do at least some serialization/snapshot building and to keep the code
+    # well-encapsulated, all serialization/snapshot building should thus be
+    # initiated from this class rather than downstream code.
+    #
+    # As a consequence of Instrumenter building snapshots, it should not
+    # expose TracePoint objects to any downstream code.
+    #
     # @api private
     class Instrumenter
       def initialize(settings, serializer, logger, code_tracker: nil, telemetry: nil)
@@ -107,28 +119,57 @@ module Datadog
 
         mod = Module.new do
           define_method(method_name) do |*args, **kwargs, &target_block| # steep:ignore
-            if rate_limiter.nil? || rate_limiter.allow?
+            continue = true
+            if condition = probe.condition
+              begin
+                # This context will be recreated later, unlike for line probes.
+                context = Context.new(
+                  locals: serializer.combine_args(args, kwargs, self),
+                  target_self: self,
+                  probe: probe, settings: settings, serializer: serializer,
+                  caller_locations: caller_locations,
+                )
+                continue = condition.satisfied?(context)
+              rescue
+                raise if settings.dynamic_instrumentation.internal.propagate_all_exceptions
+
+                # TODO log / report via telemetry?
+                continue = false
+              end
+            end
+
+            if continue and rate_limiter.nil? || rate_limiter.allow?
               # Arguments may be mutated by the method, therefore
               # they need to be serialized prior to method invocation.
-              entry_args = if probe.capture_snapshot?
-                serializer.serialize_args(args, kwargs,
+              serialized_entry_args = if probe.capture_snapshot?
+                serializer.serialize_args(args, kwargs, self,
                   depth: probe.max_capture_depth || settings.dynamic_instrumentation.max_capture_depth,
                   attribute_count: probe.max_capture_attribute_count || settings.dynamic_instrumentation.max_capture_attribute_count)
               end
               start_time = Core::Utils::Time.get_time
-              # Under Ruby 2.6 we cannot just call super(*args, **kwargs)
-              # for methods defined via method_missing.
-              rv = if args.any?
-                if kwargs.any?
-                  super(*args, **kwargs, &target_block)
+
+              rv = nil
+              begin
+                # Under Ruby 2.6 we cannot just call super(*args, **kwargs)
+                # for methods defined via method_missing.
+                rv = if args.any?
+                  if kwargs.any?
+                    super(*args, **kwargs, &target_block)
+                  else
+                    super(*args, &target_block)
+                  end
+                elsif kwargs.any?
+                  super(**kwargs, &target_block)
                 else
-                  super(*args, &target_block)
+                  super(&target_block)
                 end
-              elsif kwargs.any?
-                super(**kwargs, &target_block)
-              else
-                super(&target_block)
+              rescue NoMemoryError, Interrupt, SystemExit
+                raise
+              rescue Exception => exc # standard:disable Lint/RescueException
+                # We will raise the exception captured here later, after
+                # the instrumentation callback runs.
               end
+
               duration = Core::Utils::Time.get_time - start_time
               # The method itself is not part of the stack trace because
               # we are getting the stack trace from outside of the method.
@@ -147,10 +188,20 @@ module Datadog
               end
               caller_locs = method_frame + caller_locations # steep:ignore
               # TODO capture arguments at exit
+
+              context = Context.new(locals: nil, target_self: self,
+                probe: probe, settings: settings, serializer: serializer,
+                serialized_entry_args: serialized_entry_args,
+                caller_locations: caller_locs,
+                return_value: rv, duration: duration, exception: exc,)
+
               # & is to stop steep complaints, block is always present here.
-              block&.call(probe: probe, rv: rv, duration: duration, caller_locations: caller_locs,
-                serialized_entry_args: entry_args)
-              rv
+              block&.call(context)
+              if exc
+                raise exc
+              else
+                rv
+              end
             else
               # stop standard from trying to mess up my code
               _ = 42
@@ -294,14 +345,57 @@ module Datadog
             # are invoked for *each* line of Ruby executed.
             # TODO find out exactly when the path in trace point is relative.
             # Looks like this is the case when line trace point is not targeted?
-            if iseq || tp.lineno == probe.line_no && (
+            continue = iseq || tp.lineno == probe.line_no && (
               probe.file == tp.path || probe.file_matches?(tp.path)
             )
-              if rate_limiter.nil? || rate_limiter.allow?
-                # & is to stop steep complaints, block is always present here.
-                block&.call(probe: probe, trace_point: tp, caller_locations: caller_locations)
+
+            # We set the trace point on :return to be able to instrument
+            # 'end' lines. This also causes the trace point to be invoked on
+            # non-'end' lines when a line raises an exception, since the
+            # exception causes the method to stop executing and stack unwends.
+            # We do not want two invocations of the trace point.
+            # Therefore, if a trace point is invoked with a :line event,
+            # mark it as such and ignore subsequent :return events.
+            continue &&= if probe.executed_on_line?
+              tp.event == :line
+            else
+              if tp.event == :line
+                probe.executed_on_line!
+              end
+              true
+            end
+
+            if continue
+              if condition = probe.condition
+                context = Context.new(
+                  locals: Instrumenter.get_local_variables(tp),
+                  target_self: tp.self,
+                  probe: probe, settings: settings, serializer: serializer,
+                  path: tp.path,
+                  caller_locations: caller_locations,
+                )
+                continue = condition.satisfied?(context)
               end
             end
+
+            continue &&= rate_limiter.nil? || rate_limiter.allow? # standard:disable Style/AndOr
+
+            if continue
+              # The context creation is relatively expensive and we don't
+              # want to run it if the callback won't be executed due to the
+              # rate limit.
+              # Thus the copy-paste of the creation call here.
+              context ||= Context.new(
+                locals: Instrumenter.get_local_variables(tp),
+                target_self: tp.self,
+                probe: probe, settings: settings, serializer: serializer,
+                path: tp.path,
+                caller_locations: caller_locations,
+              )
+
+              # & is to stop steep complaints, block is always present here.
+              block&.call(context)
+            end
           rescue => exc
             raise if settings.dynamic_instrumentation.internal.propagate_all_exceptions
             logger.debug { "di: unhandled exception in line trace point: #{exc.class}: #{exc}" }
@@ -371,6 +465,23 @@ module Datadog
         end
       end
 
+      class << self
+        def get_local_variables(trace_point)
+          # binding appears to be constructed on access, therefore
+          # 1) we should attempt to cache it and
+          # 2) we should not call +binding+ until we actually need variable values.
+          binding = trace_point.binding
+
+          # steep hack - should never happen
+          return {} unless binding
+
+          binding.local_variables.each_with_object({}) do |name, map|
+            value = binding.local_variable_get(name)
+            map[name] = value
+          end
+        end
+      end
+
       private
 
       attr_reader :lock
@@ -406,3 +517,4 @@ module Datadog
 end
 
 # rubocop:enable Lint/AssignmentInCondition
+# rubocop:enable Style/AndOr

data/lib/datadog/di/probe.rb

@@ -17,7 +17,7 @@ module Datadog
     # and remote config code must be prepared to deal with exceptions
     # raised by Probe constructor in particular. Therefore, Probe constructor
     # will raise an exception if it determines that there is not enough
-    # information (or confilcting information) in the arguments to create a
+    # information (or conflicting information) in the arguments to create a
     # functional probe, and upstream code is tasked with not spamming logs
     # with notifications of such errors (and potentially limiting the
     # attempts to construct probe from a given payload).
@@ -36,8 +36,9 @@ module Datadog
 
       def initialize(id:, type:,
         file: nil, line_no: nil, type_name: nil, method_name: nil,
-        template: nil, capture_snapshot: false, max_capture_depth: nil,
-        max_capture_attribute_count: nil,
+        template: nil, template_segments: nil,
+        capture_snapshot: false, max_capture_depth: nil,
+        max_capture_attribute_count: nil, condition: nil,
         rate_limit: nil)
         # Perform some sanity checks here to detect unexpected attribute
         # combinations, in order to not do them in subsequent code.
@@ -45,9 +46,17 @@ module Datadog
           raise ArgumentError, "Unknown probe type: #{type}"
         end
 
-        if line_no && method_name
-          raise ArgumentError, "Probe contains both line number and method name: #{id}"
-        end
+        # Probe should be inferred to be a line probe if the specification
+        # contains a line number. This how Java tracer works and Go tracer
+        # is implementing the same behavior, and Go will have all 3 fields
+        # (file path, line number and method name) for line probes.
+        # Do not raise if line number and method name both exist - instead
+        # treat the probe as a line probe.
+        #
+        # In the future we want to provide type name and method name to line
+        # probes, so that the library can verify that the instrumented line
+        # is in the method that the frontend showed to the user when the
+        # user created the probe.
 
         if line_no && !file
           raise ArgumentError, "Probe contains line number but not file: #{id}"
@@ -57,6 +66,10 @@ module Datadog
           raise ArgumentError, "Partial method probe definition: #{id}"
         end
 
+        if line_no.nil? && method_name.nil?
+          raise ArgumentError, "Unhandled probe type: neither method nor line probe: #{id}"
+        end
+
         @id = id
         @type = type
         @file = file
@@ -64,17 +77,11 @@ module Datadog
         @type_name = type_name
         @method_name = method_name
         @template = template
+        @template_segments = template_segments
         @capture_snapshot = !!capture_snapshot
         @max_capture_depth = max_capture_depth
         @max_capture_attribute_count = max_capture_attribute_count
-
-        # These checks use instance methods that have more complex logic
-        # than checking a single argument value. To avoid duplicating
-        # the logic here, use the methods and perform these checks after
-        # instance variable assignment.
-        unless method? || line?
-          raise ArgumentError, "Unhandled probe type: neither method nor line probe: #{id}"
-        end
+        @condition = condition
 
         @rate_limit = rate_limit || (@capture_snapshot ? 1 : 5000)
         @rate_limiter = Datadog::Core::TokenBucket.new(@rate_limit)
@@ -89,6 +96,10 @@ module Datadog
       attr_reader :type_name
       attr_reader :method_name
       attr_reader :template
+      attr_reader :template_segments
+
+      # The compiled condition for the probe, as a String.
+      attr_reader :condition
 
       # Configured maximum capture depth. Can be nil in which case
       # the global default will be used.
@@ -122,7 +133,7 @@ module Datadog
 
       # Returns whether the probe is a method probe.
       def method?
-        !!(type_name && method_name)
+        line_no.nil?
       end
 
       # Returns the line number associated with the probe, raising
@@ -186,6 +197,15 @@ module Datadog
       def emitting_notified?
         !!@emitting_notified
       end
+
+      def executed_on_line?
+        !!@executed_on_line
+      end
+
+      def executed_on_line!
+        # TODO lock?
+        @executed_on_line = true
+      end
     end
   end
 end

data/lib/datadog/di/probe_builder.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/AssignmentInCondition
+
 require_relative "probe"
+require_relative 'el'
 
 module Datadog
   module DI
@@ -21,10 +24,19 @@ module Datadog
         'LOG_PROBE' => :log,
       }.freeze
 
-      module_function def build_from_remote_config(config)
+      module_function
+
+      def build_from_remote_config(config)
         # The validations here are not yet comprehensive.
         type = config.fetch('type')
         type_symbol = PROBE_TYPES[type] or raise ArgumentError, "Unrecognized probe type: #{type}"
+        cond = if cond_spec = config['when']
+          unless cond_spec['dsl'] && cond_spec['json']
+            raise ArgumentError, "Malformed condition specification for probe: #{config}"
+          end
+          compiled = EL::Compiler.new.compile(cond_spec['json'])
+          EL::Expression.new(cond_spec['dsl'], compiled)
+        end
         Probe.new(
           id: config.fetch("id"),
           type: type_symbol,
@@ -34,15 +46,41 @@ module Datadog
           line_no: config["where"]&.[]("lines")&.compact&.map(&:to_i)&.first,
           type_name: config["where"]&.[]("typeName"),
           method_name: config["where"]&.[]("methodName"),
+          # We should not be using the template for anything - we instead
+          # use +segments+ - but keep the template for debugging.
           template: config["template"],
+          template_segments: build_template_segments(config['segments']),
           capture_snapshot: !!config["captureSnapshot"],
           max_capture_depth: config["capture"]&.[]("maxReferenceDepth"),
           max_capture_attribute_count: config["capture"]&.[]("maxFieldCount"),
           rate_limit: config["sampling"]&.[]("snapshotsPerSecond"),
+          condition: cond,
         )
       rescue KeyError => exc
         raise ArgumentError, "Malformed remote configuration entry for probe: #{exc.class}: #{exc}: #{config}"
       end
+
+      def build_template_segments(segments)
+        segments&.map do |segment|
+          if Hash === segment
+            if str = segment['str']
+              str
+            elsif ast = segment['json']
+              unless dsl = segment['dsl']
+                raise ArgumentError, "Missing dsl for json in segment: #{segment}"
+              end
+              compiled = EL::Compiler.new.compile(ast)
+              EL::Expression.new(dsl, compiled)
+            else
+              # TODO report to telemetry?
+            end
+          else
+            # TODO report to telemetry?
+          end
+        end&.compact
+      end
     end
   end
 end
+
+# rubocop:enable Lint/AssignmentInCondition

data/lib/datadog/di/probe_file_loader/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Datadog
+  module DI
+    module ProbeFileLoader
+      # Railtie class initializes dynamic instrumentation contrib code
+      # in Rails environments.
+      class Railtie < Rails::Railtie
+        initializer 'datadog.dynamic_instrumentation.load_probe_file' do |app| # steep:ignore
+          ProbeFileLoader.load_now
+        end
+      end
+    end
+  end
+end

data/lib/datadog/di/probe_file_loader.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Datadog
+  module DI
+    module ProbeFileLoader
+      module_function def load_now_or_later
+        if Datadog::Core::Contrib::Rails::Utils.railtie_supported?
+          Datadog.logger.debug('di: loading probe_file_loader/railtie')
+          require_relative 'probe_file_loader/railtie'
+        else
+          load_now
+        end
+      end
+
+      # This method can be called more than once, to attempt to load
+      # DI components that depend on third-party libraries after additional
+      # dependencies are loaded (or potentially loaded).
+      module_function def load_now
+        should_propagate = false
+
+        probe_file_path = DATADOG_ENV['DD_DYNAMIC_INSTRUMENTATION_PROBE_FILE']
+        if probe_file_path.nil? || probe_file_path.empty?
+          return
+        end
+
+        # We want to initialize the component tree here if it was not already
+        # initialized.
+        component = Datadog::DI.component
+        return unless component
+
+        begin
+          probe_specs = File.open(probe_file_path) do |f|
+            # The probe file should contain an array, JSON.parse does not work
+            JSON.load(f) # standard:disable Security/JSONLoad
+          end
+
+          probe_specs.each do |probe_spec|
+            probe = component.parse_probe_spec_and_notify(probe_spec)
+            component.logger.debug { "di: received #{probe.type} probe at #{probe.location} (#{probe.id}) via probe file: #{probe_file_path}" }
+
+            begin
+              component.probe_manager.add_probe(probe)
+            rescue DI::Error::DITargetNotInRegistry => exc
+              component.telemetry&.report(exc, description: "Line probe is targeting a loaded file that is not in code tracker")
+
+              payload = component.probe_notification_builder.build_errored(probe, exc)
+              component.probe_notifier_worker.add_status(payload)
+            rescue => exc
+              raise if component.settings.dynamic_instrumentation.internal.propagate_all_exceptions
+
+              component.logger.debug { "di: unhandled exception adding #{probe.type} probe at #{probe.location} (#{probe.id}) in DI probe file loader: #{exc.class}: #{exc}" }
+              component.telemetry&.report(exc, description: "Unhandled exception adding probe in DI probe file loader")
+
+              # TODO test this path
+              payload = component.probe_notification_builder.build_errored(probe, exc)
+              component.probe_notifier_worker.add_status(payload)
+            end
+          end
+        rescue => exc
+          if component.settings.dynamic_instrumentation.internal.propagate_all_exceptions
+            should_propagate = true
+            raise
+          end
+
+          component.logger.debug { "di: unhandled exception handling a probe in DI probe file loader: #{exc.class}: #{exc}" }
+          component.telemetry&.report(exc, description: "Unhandled exception handling probe in DI probe file loader")
+        end
+      rescue
+        # We should generally never get here, but if component tree
+        # initialization fails for some unexpected reason, don't nuke
+        # the customer application.
+        #
+        # For the same reason, we do not check
+        # component.settings.dynamic_instrumentation.internal.propagate_all_exceptions
+        # here again, but rely on the local variable storing that value.
+        raise if should_propagate
+      end
+    end
+  end
+end

data/lib/datadog/di/probe_manager.rb

@@ -229,7 +229,8 @@ module Datadog
       # This method is responsible for queueing probe status to be sent to the
       # backend (once per the probe's lifetime) and a snapshot corresponding
       # to the current invocation.
-      def probe_executed_callback(probe:, **opts)
+      def probe_executed_callback(context)
+        probe = context.probe
         logger.trace { "di: executed #{probe.type} probe at #{probe.location} (#{probe.id})" }
         unless probe.emitting_notified?
           payload = probe_notification_builder.build_emitting(probe)
@@ -237,7 +238,7 @@ module Datadog
           probe.emitting_notified = true
         end
 
-        payload = probe_notification_builder.build_executed(probe, **opts)
+        payload = probe_notification_builder.build_executed(context)
         probe_notifier_worker.add_snapshot(payload)
       end