newrelic_rpm 6.15.0 → 7.2.0

data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb

@@ -84,8 +84,6 @@ module NewRelic
         end
 
         def active_record_config(payload)
-          return unless payload[:connection_id]
-
           # handle if the notification payload provides the AR connection
           # available in Rails 6+ & our ActiveRecordNotifications#log extension
           if payload[:connection]
@@ -93,8 +91,8 @@ module NewRelic
             return connection_config if connection_config
           end
 
+          return unless connection_id = payload[:connection_id]
           connection = nil
-          connection_id = payload[:connection_id]
 
           ::ActiveRecord::Base.connection_handler.connection_pool_list.each do |handler|
             connection = handler.connections.detect do |conn|

data/lib/new_relic/agent/instrumentation/bunny.rb

@@ -3,6 +3,10 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
+require_relative 'bunny/instrumentation'
+require_relative 'bunny/chain'
+require_relative 'bunny/prepend'
+
 DependencyDetection.defer do
   named :bunny
 
@@ -18,158 +22,12 @@ DependencyDetection.defer do
   end
 
   executes do
-    module Bunny
-      class Exchange
-        alias_method :publish_without_new_relic, :publish
-
-        def publish payload, opts = {}
-          begin
-            destination = NewRelic::Agent::Instrumentation::Bunny.exchange_name(name)
-
-            tracing_enabled =
-              NewRelic::Agent::CrossAppTracing.cross_app_enabled? ||
-              NewRelic::Agent.config[:'distributed_tracing.enabled']
-            opts[:headers] ||= {} if tracing_enabled
-
-            segment = NewRelic::Agent::Messaging.start_amqp_publish_segment(
-              library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
-              destination_name: destination,
-              headers: opts[:headers],
-              routing_key: opts[:routing_key] || opts[:key],
-              reply_to: opts[:reply_to],
-              correlation_id: opts[:correlation_id],
-              exchange_type: type
-            )
-          rescue => e
-            NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Exchange#publish", e
-            publish_without_new_relic payload, opts
-          else
-            NewRelic::Agent::Tracer.capture_segment_error segment do
-              publish_without_new_relic payload, opts
-            end
-          ensure
-            segment.finish if segment
-          end
-        end
-      end
-
-      class Queue
-        alias_method :pop_without_new_relic, :pop
-
-        def pop(opts = {:manual_ack => false}, &block)
-          bunny_error, delivery_info, message_properties, _payload = nil, nil, nil, nil
-          begin
-            t0 = Time.now
-            msg = pop_without_new_relic opts, &block
-            delivery_info, message_properties, _payload = msg
-          rescue StandardError => error
-            bunny_error = error
-          end
-
-          begin
-            exchange_name, exchange_type = if delivery_info
-              [ NewRelic::Agent::Instrumentation::Bunny.exchange_name(delivery_info.exchange),
-                NewRelic::Agent::Instrumentation::Bunny.exchange_type(delivery_info, channel) ]
-            else
-              [ NewRelic::Agent::Instrumentation::Bunny.exchange_name(NewRelic::EMPTY_STR),
-                NewRelic::Agent::Instrumentation::Bunny.exchange_type({}, channel) ]
-            end
-
-            segment = NewRelic::Agent::Messaging.start_amqp_consume_segment(
-              library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
-              destination_name: exchange_name,
-              delivery_info: (delivery_info || {}),
-              message_properties: (message_properties || {headers: {}}),
-              exchange_type: exchange_type,
-              queue_name: name,
-              start_time: t0
-            )
-          rescue => e
-            NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Queue#pop", e
-          else
-            if bunny_error
-              segment.notice_error bunny_error
-              raise bunny_error
-            end
-          ensure
-            segment.finish if segment
-          end
-
-          msg
-        end
-
-        alias_method :purge_without_new_relic, :purge
-
-        def purge *args
-          begin
-            type = server_named? ? :temporary_queue : :queue
-            segment = NewRelic::Agent::Tracer.start_message_broker_segment(
-              action: :purge,
-              library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
-              destination_type: type,
-              destination_name: name
-            )
-          rescue => e
-            NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Queue#purge", e
-            purge_without_new_relic(*args)
-          else
-            NewRelic::Agent::Tracer.capture_segment_error segment do
-              purge_without_new_relic(*args)
-            end
-          ensure
-            segment.finish if segment
-          end
-        end
-
-      end
-
-      class Consumer
-        alias_method :call_without_new_relic, :call
-
-        def call *args
-          delivery_info, message_properties, _ = args
-          queue_name = queue.respond_to?(:name) ? queue.name : queue
-
-          NewRelic::Agent::Messaging.wrap_amqp_consume_transaction(
-            library: NewRelic::Agent::Instrumentation::Bunny::LIBRARY,
-            destination_name: NewRelic::Agent::Instrumentation::Bunny.exchange_name(delivery_info.exchange),
-            delivery_info: delivery_info,
-            message_properties: message_properties,
-            exchange_type: NewRelic::Agent::Instrumentation::Bunny.exchange_type(delivery_info, channel),
-            queue_name: queue_name) do
-
-            call_without_new_relic(*args)
-          end
-        end
-
-      end
-    end
-  end
-end
-
-module NewRelic
-  module Agent
-    module Instrumentation
-      module Bunny
-        LIBRARY = 'RabbitMQ'
-        DEFAULT_NAME = 'Default'
-        DEFAULT_TYPE = :direct
-
-        SLASH   = '/'
-
-        class << self
-          def exchange_name name
-            name.empty? ? DEFAULT_NAME : name
-          end
-
-          def exchange_type delivery_info, channel
-            if di_exchange = delivery_info[:exchange]
-              return DEFAULT_TYPE if di_exchange.empty?
-              return channel.exchanges[delivery_info[:exchange]].type if channel.exchanges[di_exchange]
-            end
-          end
-        end
-      end
+    if use_prepend?
+      prepend_instrument ::Bunny::Exchange, ::NewRelic::Agent::Instrumentation::Bunny::Prepend::Exchange
+      prepend_instrument ::Bunny::Queue, ::NewRelic::Agent::Instrumentation::Bunny::Prepend::Queue
+      prepend_instrument ::Bunny::Consumer, ::NewRelic::Agent::Instrumentation::Bunny::Prepend::Consumer
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::Bunny
     end
   end
 end

data/lib/new_relic/agent/instrumentation/bunny/chain.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+
+module NewRelic::Agent::Instrumentation
+  module Bunny
+    def self.instrument!
+      ::Bunny::Exchange.class_eval do
+        include NewRelic::Agent::Instrumentation::Bunny::Exchange
+
+        alias_method :publish_without_new_relic, :publish
+
+        def publish payload, opts = {}
+          publish_with_tracing(payload, opts) { publish_without_new_relic payload, opts }
+        end
+      end
+
+      ::Bunny::Queue.class_eval do
+        include NewRelic::Agent::Instrumentation::Bunny::Queue
+
+        alias_method :pop_without_new_relic, :pop
+
+        def pop(opts = {:manual_ack => false}, &block)
+          pop_with_tracing { pop_without_new_relic opts, &block }
+        end
+
+        alias_method :purge_without_new_relic, :purge
+
+        def purge *args
+          purge_with_tracing { purge_without_new_relic(*args) }
+        end
+      end
+
+      ::Bunny::Consumer.class_eval do
+        include NewRelic::Agent::Instrumentation::Bunny::Consumer
+
+        alias_method :call_without_new_relic, :call
+
+        def call *args
+          call_with_tracing(*args) { call_without_new_relic(*args) }
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/bunny/instrumentation.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module Bunny
+        module_function
+
+        LIBRARY = 'RabbitMQ'
+        DEFAULT_NAME = 'Default'
+        DEFAULT_TYPE = :direct
+        SLASH   = '/'
+
+        def exchange_name name
+          name.empty? ? DEFAULT_NAME : name
+        end
+
+        def exchange_type delivery_info, channel
+          if di_exchange = delivery_info[:exchange]
+            return DEFAULT_TYPE if di_exchange.empty?
+            return channel.exchanges[delivery_info[:exchange]].type if channel.exchanges[di_exchange]
+          end
+        end
+
+        module Exchange
+          include Bunny
+
+          def publish_with_tracing payload, opts = {}
+            begin
+              destination = exchange_name(name)
+
+              tracing_enabled =
+                NewRelic::Agent::CrossAppTracing.cross_app_enabled? ||
+                NewRelic::Agent.config[:'distributed_tracing.enabled']
+              opts[:headers] ||= {} if tracing_enabled
+
+              segment = NewRelic::Agent::Messaging.start_amqp_publish_segment(
+                library: LIBRARY,
+                destination_name: destination,
+                headers: opts[:headers],
+                routing_key: opts[:routing_key] || opts[:key],
+                reply_to: opts[:reply_to],
+                correlation_id: opts[:correlation_id],
+                exchange_type: type
+              )
+            rescue => e
+              NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Exchange#publish", e
+              yield
+            else
+              NewRelic::Agent::Tracer.capture_segment_error segment do
+                yield
+              end
+            ensure
+              segment.finish if segment
+            end
+          end
+        end
+
+        module Queue
+          include Bunny
+
+          def pop_with_tracing
+            bunny_error, delivery_info, message_properties, _payload = nil, nil, nil, nil
+            begin
+              t0 = Time.now
+              msg = yield
+              delivery_info, message_properties, _payload = msg
+            rescue StandardError => error
+              bunny_error = error
+            end
+
+            begin
+              exch_name, exch_type = if delivery_info
+                [ exchange_name(delivery_info.exchange),
+                  exchange_type(delivery_info, channel) ]
+              else
+                [ exchange_name(NewRelic::EMPTY_STR),
+                  exchange_type({}, channel) ]
+              end
+
+              segment = NewRelic::Agent::Messaging.start_amqp_consume_segment(
+                library: LIBRARY,
+                destination_name: exch_name,
+                delivery_info: (delivery_info || {}),
+                message_properties: (message_properties || {headers: {}}),
+                exchange_type: exch_type,
+                queue_name: name,
+                start_time: t0
+              )
+            rescue => e
+              NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Queue#pop", e
+            else
+              if bunny_error
+                segment.notice_error bunny_error
+                raise bunny_error
+              end
+            ensure
+              segment.finish if segment
+            end
+
+            msg
+          end
+
+          def purge_with_tracing
+            begin
+              type = server_named? ? :temporary_queue : :queue
+              segment = NewRelic::Agent::Tracer.start_message_broker_segment(
+                action: :purge,
+                library: LIBRARY,
+                destination_type: type,
+                destination_name: name
+              )
+            rescue => e
+              NewRelic::Agent.logger.error "Error starting message broker segment in Bunny::Queue#purge", e
+              yield
+            else
+              NewRelic::Agent::Tracer.capture_segment_error segment do
+                yield
+              end
+            ensure
+              segment.finish if segment
+            end
+          end
+        end
+
+        module Consumer
+          include Bunny
+
+          def call_with_tracing *args
+            delivery_info, message_properties, _ = args
+            queue_name = queue.respond_to?(:name) ? queue.name : queue
+
+            NewRelic::Agent::Messaging.wrap_amqp_consume_transaction(
+              library: LIBRARY,
+              destination_name: exchange_name(delivery_info.exchange),
+              delivery_info: delivery_info,
+              message_properties: message_properties,
+              exchange_type: exchange_type(delivery_info, channel),
+              queue_name: queue_name) do
+
+              yield
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/bunny/prepend.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+
+module NewRelic::Agent::Instrumentation
+  module Bunny::Prepend
+    module Exchange
+      include NewRelic::Agent::Instrumentation::Bunny::Exchange
+
+      def publish payload, opts = {}
+        publish_with_tracing(payload, opts) { super }
+      end
+    end
+
+    module Queue
+      include NewRelic::Agent::Instrumentation::Bunny::Queue
+
+      def pop(opts = {:manual_ack => false}, &block)
+        pop_with_tracing { super }
+      end
+
+      def purge *args
+        purge_with_tracing { super }
+      end
+    end
+
+    module Consumer
+      include NewRelic::Agent::Instrumentation::Bunny::Consumer
+
+      def call *args
+        call_with_tracing(*args) { super }
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb

@@ -179,6 +179,7 @@ module NewRelic
                   #{without_method_name}(*args, &block)
                  end
               end
+              ruby2_keywords(:#{with_method_name}) if respond_to?(:ruby2_keywords, true)
             EOC
 
             visibility = NewRelic::Helper.instance_method_visibility self, method

data/lib/new_relic/agent/instrumentation/curb.rb

@@ -2,6 +2,9 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
+require_relative 'curb/chain'
+require_relative 'curb/prepend'
+
 DependencyDetection.defer do
   named :curb
 
@@ -19,246 +22,11 @@ DependencyDetection.defer do
   end
 
   executes do
-    class Curl::Easy
-
-      attr_accessor :_nr_instrumented,
-                    :_nr_failure_instrumented,
-                    :_nr_http_verb,
-                    :_nr_header_str,
-                    :_nr_original_on_header,
-                    :_nr_original_on_complete,
-                    :_nr_original_on_failure,
-                    :_nr_serial
-
-      # We have to hook these three methods separately, as they don't use
-      # Curl::Easy#http
-      def http_head_with_newrelic(*args, &blk)
-        self._nr_http_verb = :HEAD
-        http_head_without_newrelic(*args, &blk)
-      end
-
-
-      alias_method :http_head_without_newrelic, :http_head
-      alias_method :http_head, :http_head_with_newrelic
-
-      def http_post_with_newrelic(*args, &blk)
-        self._nr_http_verb = :POST
-        http_post_without_newrelic(*args, &blk)
-      end
-
-
-      alias_method :http_post_without_newrelic, :http_post
-      alias_method :http_post, :http_post_with_newrelic
-
-      def http_put_with_newrelic(*args, &blk)
-        self._nr_http_verb = :PUT
-        http_put_without_newrelic(*args, &blk)
-      end
-
-
-      alias_method :http_put_without_newrelic, :http_put
-      alias_method :http_put, :http_put_with_newrelic
-
-
-      # Hook the #http method to set the verb.
-      def http_with_newrelic verb
-        self._nr_http_verb = verb.to_s.upcase
-        http_without_newrelic( verb )
-      end
-
-      alias_method :http_without_newrelic, :http
-      alias_method :http, :http_with_newrelic
-
-      # Hook the #perform method to mark the request as non-parallel.
-      def perform_with_newrelic
-        self._nr_http_verb ||= :GET
-        self._nr_serial = true
-        perform_without_newrelic
-      end
-
-      alias_method :perform_without_newrelic, :perform
-      alias_method :perform, :perform_with_newrelic
-
-      # Record the HTTP verb for future #perform calls
-      def method_with_newrelic verb
-        self._nr_http_verb = verb.upcase
-        method_without_newrelic(verb)
-      end
-
-      alias_method :method_without_newrelic, :method
-      alias_method :method, :method_with_newrelic
-
-      # We override this method in order to ensure access to header_str even
-      # though we use an on_header callback
-      def header_str_with_newrelic
-        if self._nr_serial
-          self._nr_header_str
-        else
-          # Since we didn't install a header callback for a non-serial request,
-          # just fall back to the original implementation.
-          header_str_without_newrelic
-        end
-      end
-
-      alias_method :header_str_without_newrelic, :header_str
-      alias_method :header_str, :header_str_with_newrelic
-    end # class Curl::Easy
-
-
-    class Curl::Multi
-      include NewRelic::Agent::MethodTracer
-
-      # Add CAT with callbacks if the request is serial
-      def add_with_newrelic(curl)
-        if curl.respond_to?(:_nr_serial) && curl._nr_serial
-          hook_pending_request(curl) if NewRelic::Agent::Tracer.tracing_enabled?
-        end
-
-        return add_without_newrelic curl
-      end
-
-      alias_method :add_without_newrelic, :add
-      alias_method :add, :add_with_newrelic
-
-      # Trace as an External/Multiple call if the first request isn't serial.
-      def perform_with_newrelic(&blk)
-        return perform_without_newrelic if first_request_is_serial?
-
-        trace_execution_scoped("External/Multiple/Curb::Multi/perform") do
-          perform_without_newrelic(&blk)
-        end
-      end
-
-      alias_method :perform_without_newrelic, :perform
-      alias_method :perform, :perform_with_newrelic
-
-
-      # Instrument the specified +request+ (a Curl::Easy object)
-      # and set up cross-application tracing if it's enabled.
-      def hook_pending_request(request)
-        wrapped_request, wrapped_response = wrap_request(request)
-
-        segment = NewRelic::Agent::Tracer.start_external_request_segment(
-          library: wrapped_request.type,
-          uri: wrapped_request.uri,
-          procedure: wrapped_request.method
-        )
-
-        segment.add_request_headers wrapped_request
-
-        # install all callbacks
-        unless request._nr_instrumented
-          install_header_callback(request, wrapped_response)
-          install_completion_callback(request, wrapped_response, segment)
-          install_failure_callback(request, wrapped_response, segment)
-          request._nr_instrumented = true
-        end
-      rescue => err
-        NewRelic::Agent.logger.error("Untrapped exception", err)
-      end
-
-
-      # Create request and response adapter objects for the specified +request+
-      # NOTE: Although strange to wrap request and response at once, it works
-      # because curb's callback mechanism updates the instantiated wrappers
-      # during the life-cycle of external request
-      def wrap_request(request)
-        return NewRelic::Agent::HTTPClients::CurbRequest.new(request),
-               NewRelic::Agent::HTTPClients::CurbResponse.new(request)
-      end
-
-      # Install a callback that will record the response headers
-      # to enable CAT linking
-      def install_header_callback(request, wrapped_response)
-        original_callback = request.on_header
-        request._nr_original_on_header = original_callback
-        request._nr_header_str = nil
-        request.on_header do |header_data|
-          if original_callback
-            original_callback.call header_data
-          else
-            wrapped_response.append_header_data header_data
-            header_data.length
-          end
-        end
-      end
-
-      # Install a callback that will finish the trace.
-      def install_completion_callback(request, wrapped_response, segment)
-        original_callback = request.on_complete
-        request._nr_original_on_complete = original_callback
-        request.on_complete do |finished_request|
-          begin
-            segment.process_response_headers wrapped_response
-          ensure
-            segment.finish if segment
-            # Make sure the existing completion callback is run, and restore the
-            # on_complete callback to how it was before.
-            original_callback.call(finished_request) if original_callback
-            remove_instrumentation_callbacks(request)
-          end
-        end
-      end
-
-      # Install a callback that will fire on failures
-      # NOTE:  on_failure is not always called, so we're not always
-      # unhooking the callback.  No harm/no foul in production, but
-      # definitely something to beware of if debugging callback issues
-      # _nr_failure_instrumented exists to prevent infinitely chaining
-      # our on_failure callback hook.
-      def install_failure_callback(request, wrapped_response, segment)
-        return if request._nr_failure_instrumented
-        original_callback = request.on_failure
-        request._nr_original_on_failure = original_callback
-        request.on_failure do |failed_request, error|
-          begin
-            if segment
-              noticible_error = NewRelic::Agent::NoticibleError.new error[0].name, error[-1]
-              segment.notice_error noticible_error
-            end
-          ensure
-            original_callback.call(failed_request, error) if original_callback
-            remove_failure_callback(failed_request)
-          end
-          request._nr_failure_instrumented = true 
-        end
-      end
-
-      # on_failure callbacks cannot be removed in the on_complete
-      # callback where this method is invoked because on_complete
-      # fires before the on_failure!
-      def remove_instrumentation_callbacks(request)
-        request.on_complete(&request._nr_original_on_complete)
-        request.on_header(&request._nr_original_on_header)
-        request._nr_instrumented = false
-      end
-
-      # We execute customer's on_failure callback (if any) and 
-      # uninstall our hook here since the on_complete callback 
-      # fires before the on_failure callback.
-      def remove_failure_callback(request)
-        request.on_failure(&request._nr_original_on_failure)
-        request._nr_failure_instrumented = false
-      end
-
-      private
-
-      def first_request_is_serial?
-        return false unless (first = self.requests.first)
-
-        # Before curb 0.9.8, requests was an array of Curl::Easy
-        # instances.  Starting with 0.9.8, it's a Hash where the
-        # values are Curl::Easy instances.
-        #
-        # So, requests.first will either be an_obj or [a_key, an_obj].
-        # We need to handle either case.
-        #
-        first = first[-1] if first.is_a?(Array)
-
-        first.respond_to?(:_nr_serial) && first._nr_serial
-      end
-
-    end # class Curl::Multi
-
+    if use_prepend?
+      prepend_instrument ::Curl::Easy, NewRelic::Agent::Instrumentation::Curb::Easy::Prepend
+      prepend_instrument ::Curl::Multi, NewRelic::Agent::Instrumentation::Curb::Multi::Prepend
+    else
+      chain_instrument ::NewRelic::Agent::Instrumentation::Curb::Chain
+    end
   end
 end