Contents

require 'ddtrace/utils/only_once'

module Datadog
  module Contrib
    # Common behavior for patcher modules
    module Patcher
      def self.included(base)
        base.singleton_class.send(:prepend, CommonMethods)
        base.send(:prepend, CommonMethods) if base.instance_of?(Class)
      end

      # Prepended instance methods for all patchers
      module CommonMethods
        def patch_name
          self.class != Class && self.class != Module ? self.class.name : name
        end

        def patched?
          patch_only_once.ran?
        end

        def patch
          return unless defined?(super)

          patch_only_once.run do
            begin
              super.tap do
                # Emit a metric
                Datadog.health_metrics.instrumentation_patched(1, tags: default_tags)
              end
            rescue StandardError => e
              on_patch_error(e)
            end
          end
        end

        # Processes patching errors. This default implementation logs the error and reports relevant metrics.
        # @param e [Exception]
        def on_patch_error(e)
          # Log the error
          Datadog.logger.error("Failed to apply #{patch_name} patch. Cause: #{e} Location: #{e.backtrace.first}")

          # Emit a metric
          tags = default_tags
          tags << "error:#{e.class.name}"

          Datadog.health_metrics.error_instrumentation_patch(1, tags: tags)
        end

        private

        def default_tags
          ["patcher:#{patch_name}"].tap do |tags|
            tags << "target_version:#{target_version}" if respond_to?(:target_version) && !target_version.nil?
          end
        end

        def patch_only_once
          # NOTE: This is not thread-safe
          @patch_only_once ||= Datadog::Utils::OnlyOnce.new
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ddtrace-0.49.0	lib/ddtrace/contrib/patcher.rb
ddtrace-0.48.0	lib/ddtrace/contrib/patcher.rb
ddtrace-0.47.0	lib/ddtrace/contrib/patcher.rb