newrelic_rpm 6.15.0 → 9.7.1

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

@@ -1,10 +1,11 @@
-# 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
 
 require 'new_relic/agent/transaction'
 require 'new_relic/agent/instrumentation/queue_time'
 require 'new_relic/agent/instrumentation/ignore_actions'
+
 module NewRelic
   module Agent
     # @api public
@@ -22,7 +23,6 @@ module NewRelic
       # @api public
       #
       module ControllerInstrumentation
-
         def self.included(clazz) # :nodoc:
           clazz.extend(ClassMethods)
         end
@@ -30,7 +30,9 @@ module NewRelic
         # This module is for importing stubs when the agent is disabled
         module ClassMethodsShim # :nodoc:
           def newrelic_ignore(*args); end
+
           def newrelic_ignore_apdex(*args); end
+
           def newrelic_ignore_enduser(*args); end
         end
 
@@ -38,14 +40,14 @@ module NewRelic
           def self.included(clazz)
             clazz.extend(ClassMethodsShim)
           end
-          def new_relic_trace_controller_action(*args); yield; end
+
           def perform_action_with_newrelic_trace(*args); yield; end
         end
 
-        NR_DO_NOT_TRACE_KEY   = :'@do_not_trace'
-        NR_IGNORE_APDEX_KEY   = :'@ignore_apdex'
+        NR_DO_NOT_TRACE_KEY = :'@do_not_trace'
+        NR_IGNORE_APDEX_KEY = :'@ignore_apdex'
         NR_IGNORE_ENDUSER_KEY = :'@ignore_enduser'
-        NR_DEFAULT_OPTIONS    = {}.freeze
+        NR_DEFAULT_OPTIONS = NewRelic::EMPTY_HASH
 
         # @api public
         module ClassMethods
@@ -54,32 +56,33 @@ module NewRelic
           #
           # @api public
           #
-          def newrelic_ignore(specifiers={})
+          def newrelic_ignore(specifiers = {})
             NewRelic::Agent.record_api_supportability_metric(:newrelic_ignore)
             newrelic_ignore_aspect(NR_DO_NOT_TRACE_KEY, specifiers)
           end
+
           # Have NewRelic omit apdex measurements on the given actions.  Typically used for
           # actions that are not user facing or that skew your overall apdex measurement.
           # Accepts :except and :only options, as with #newrelic_ignore.
           #
           # @api public
           #
-          def newrelic_ignore_apdex(specifiers={})
+          def newrelic_ignore_apdex(specifiers = {})
             NewRelic::Agent.record_api_supportability_metric(:newrelic_ignore_apdex)
             newrelic_ignore_aspect(NR_IGNORE_APDEX_KEY, specifiers)
           end
 
           # @api public
-          def newrelic_ignore_enduser(specifiers={})
+          def newrelic_ignore_enduser(specifiers = {})
             NewRelic::Agent.record_api_supportability_metric(:newrelic_ignore_enduser)
             newrelic_ignore_aspect(NR_IGNORE_ENDUSER_KEY, specifiers)
           end
 
-          def newrelic_ignore_aspect(property, specifiers={}) # :nodoc:
+          def newrelic_ignore_aspect(property, specifiers = {}) # :nodoc:
             if specifiers.empty?
-              self.newrelic_write_attr property, true
-            elsif ! (Hash === specifiers)
-              ::NewRelic::Agent.logger.error "newrelic_#{property} takes an optional hash with :only and :except lists of actions (illegal argument type '#{specifiers.class}')"
+              self.newrelic_write_attr(property, true)
+            elsif !(Hash === specifiers)
+              ::NewRelic::Agent.logger.error("newrelic_#{property} takes an optional hash with :only and :except lists of actions (illegal argument type '#{specifiers.class}')")
             else
               # symbolize the incoming values
               specifiers = specifiers.inject({}) do |memo, (key, values)|
@@ -90,7 +93,7 @@ module NewRelic
                 end
                 memo
               end
-              self.newrelic_write_attr property, specifiers
+              self.newrelic_write_attr(property, specifiers)
             end
           end
 
@@ -158,13 +161,9 @@ module NewRelic
           #
           # @api public
           #
-          def add_transaction_tracer(method, options={})
+          def add_transaction_tracer(method, options = {})
             NewRelic::Agent.record_api_supportability_metric(:add_transaction_tracer)
 
-            # The metric path:
-            options[:name] ||= method.to_s
-
-            argument_list = generate_argument_list(options)
             traced_method, punctuation = parse_punctuation(method)
             with_method_name, without_method_name = build_method_names(traced_method, punctuation)
 
@@ -173,20 +172,27 @@ module NewRelic
               return
             end
 
-            class_eval <<-EOC
+            # The metric path:
+            options[:name] ||= method.to_s
+
+            code_info = NewRelic::Agent::MethodTracerHelpers.code_information(self, method)
+            argument_list = generate_argument_list(options.merge(code_info))
+
+            class_eval(<<~EOC)
               def #{with_method_name}(*args, &block)
                 perform_action_with_newrelic_trace(#{argument_list.join(',')}) do
                   #{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
+            visibility = NewRelic::Helper.instance_method_visibility(self, method)
 
-            alias_method without_method_name, method.to_s
-            alias_method method.to_s, with_method_name
-            send visibility, method
-            send visibility, with_method_name
+            alias_method(without_method_name, method.to_s)
+            alias_method(method.to_s, with_method_name)
+            send(visibility, method)
+            send(visibility, with_method_name)
             ::NewRelic::Agent.logger.debug("Traced transaction: class = #{self.name}, method = #{method.to_s}, options = #{options.inspect}")
           end
 
@@ -201,54 +207,54 @@ module NewRelic
               elsif key == :params
                 value.to_s
               else
-                %Q["#{value.to_s}"]
+                %Q("#{value.to_s}")
               end
 
-              %Q[:#{key} => #{value}]
+              %Q(:#{key} => #{value})
             end
           end
 
           def build_method_names(traced_method, punctuation)
-            [ "#{traced_method.to_s}_with_newrelic_transaction_trace#{punctuation}",
-              "#{traced_method.to_s}_without_newrelic_transaction_trace#{punctuation}" ]
+            ["#{traced_method.to_s}_with_newrelic_transaction_trace#{punctuation}",
+              "#{traced_method.to_s}_without_newrelic_transaction_trace#{punctuation}"]
           end
 
           def already_added_transaction_tracer?(target, with_method_name)
-            if NewRelic::Helper.instance_methods_include?(target, with_method_name)
-              true
-            else
-              false
-            end
+            NewRelic::Helper.instance_methods_include?(target, with_method_name)
           end
         end
 
         # @!parse extend ClassMethods
 
         class TransactionNamer
-          def self.name_for(txn, traced_obj, category, options={})
+          def self.name_for(txn, traced_obj, category, options = {})
+            return options[:transaction_name] if options[:transaction_name]
+
             "#{prefix_for_category(txn, category)}#{path_name(traced_obj, options)}"
           end
 
           def self.prefix_for_category(txn, category = nil)
-            category ||= (txn && txn.category)
+            # the following line needs else branch coverage
+            category ||= (txn && txn.category) # rubocop:disable Style/SafeNavigation
             case category
-            when :controller    then ::NewRelic::Agent::Transaction::CONTROLLER_PREFIX
-            when :web           then ::NewRelic::Agent::Transaction::CONTROLLER_PREFIX
-            when :task          then ::NewRelic::Agent::Transaction::TASK_PREFIX
-            when :background    then ::NewRelic::Agent::Transaction::TASK_PREFIX
-            when :rack          then ::NewRelic::Agent::Transaction::RACK_PREFIX
-            when :uri           then ::NewRelic::Agent::Transaction::CONTROLLER_PREFIX
-            when :sinatra       then ::NewRelic::Agent::Transaction::SINATRA_PREFIX
-            when :middleware    then ::NewRelic::Agent::Transaction::MIDDLEWARE_PREFIX
-            when :grape         then ::NewRelic::Agent::Transaction::GRAPE_PREFIX
-            when :rake          then ::NewRelic::Agent::Transaction::RAKE_PREFIX
-            when :action_cable  then ::NewRelic::Agent::Transaction::ACTION_CABLE_PREFIX
-            when :message       then ::NewRelic::Agent::Transaction::MESSAGE_PREFIX
+            when :controller then ::NewRelic::Agent::Transaction::CONTROLLER_PREFIX
+            when :web then ::NewRelic::Agent::Transaction::CONTROLLER_PREFIX
+            when :task then ::NewRelic::Agent::Transaction::TASK_PREFIX
+            when :background then ::NewRelic::Agent::Transaction::TASK_PREFIX
+            when :rack then ::NewRelic::Agent::Transaction::RACK_PREFIX
+            when :uri then ::NewRelic::Agent::Transaction::CONTROLLER_PREFIX
+            when :roda then ::NewRelic::Agent::Transaction::RODA_PREFIX
+            when :sinatra then ::NewRelic::Agent::Transaction::SINATRA_PREFIX
+            when :middleware then ::NewRelic::Agent::Transaction::MIDDLEWARE_PREFIX
+            when :grape then ::NewRelic::Agent::Transaction::GRAPE_PREFIX
+            when :rake then ::NewRelic::Agent::Transaction::RAKE_PREFIX
+            when :action_cable then ::NewRelic::Agent::Transaction::ACTION_CABLE_PREFIX
+            when :message then ::NewRelic::Agent::Transaction::MESSAGE_PREFIX
             else "#{category.to_s}/" # for internal use only
             end
           end
 
-          def self.path_name(traced_obj, options={})
+          def self.path_name(traced_obj, options = {})
             return options[:path] if options[:path]
 
             class_name = class_name(traced_obj, options)
@@ -265,9 +271,10 @@ module NewRelic
             end
           end
 
-          def self.class_name(traced_obj, options={})
+          def self.class_name(traced_obj, options = {})
             return options[:class_name] if options[:class_name]
-            if (traced_obj.is_a?(Class) || traced_obj.is_a?(Module))
+
+            if traced_obj.is_a?(Class) || traced_obj.is_a?(Module)
               traced_obj.name
             else
               traced_obj.class.name
@@ -276,7 +283,7 @@ module NewRelic
         end
 
         # Yield to the given block with NewRelic tracing.  Used by
-        # default instrumentation on controller actions in Rails and Merb.
+        # default instrumentation on controller actions in Rails.
         # But it can also be used in custom instrumentation of controller
         # methods and background tasks.
         #
@@ -333,7 +340,7 @@ module NewRelic
         #
         # Seldomly used options:
         #
-        # * <tt>:class_name => aClass.name</tt> is used to override the name
+        # * <tt>:class_name => Class.name</tt> is used to override the name
         #   of the class when used inside the metric name.  Default is the
         #   current class.
         # * <tt>:path => metric_path</tt> is *deprecated* in the public API.  It
@@ -344,7 +351,7 @@ module NewRelic
         #
         # @api public
         #
-        def perform_action_with_newrelic_trace(*args, &block) #THREAD_LOCAL_ACCESS
+        def perform_action_with_newrelic_trace(*args, &block) # THREAD_LOCAL_ACCESS
           NewRelic::Agent.record_api_supportability_metric(:perform_action_with_newrelic_trace)
           state = NewRelic::Agent::Tracer.state
           request = newrelic_request(args)
@@ -353,7 +360,7 @@ module NewRelic
           skip_tracing = do_not_trace? || !state.is_execution_traced?
 
           if skip_tracing
-            state.current_transaction.ignore! if state.current_transaction
+            state.current_transaction&.ignore!
             NewRelic::Agent.disable_all_tracing { return yield }
           end
 
@@ -362,8 +369,8 @@ module NewRelic
           # the *args method signature to ensure backwards compatibility.
 
           trace_options = args.last.is_a?(Hash) ? args.last : NR_DEFAULT_OPTIONS
-          category      = trace_options[:category] || :controller
-          txn_options   = create_transaction_options(trace_options, category, state, queue_start_time)
+          category = trace_options[:category] || :controller
+          txn_options = create_transaction_options(trace_options, category, state, queue_start_time)
 
           begin
             finishable = Tracer.start_transaction_or_segment(
@@ -378,9 +385,9 @@ module NewRelic
               NewRelic::Agent.notice_error(e)
               raise
             end
-
           ensure
-            finishable.finish if finishable
+            # the following line needs else branch coverage
+            finishable.finish if finishable # rubocop:disable Style/SafeNavigation
           end
         end
 
@@ -410,14 +417,14 @@ module NewRelic
           end
         end
 
-        # overrideable method to determine whether to trace an action
+        # overridable method to determine whether to trace an action
         # or not - you may override this in your controller and supply
         # your own logic for ignoring transactions.
         def do_not_trace?
           _is_filtered?(NR_DO_NOT_TRACE_KEY)
         end
 
-        # overrideable method to determine whether to trace an action
+        # overridable method to determine whether to trace an action
         # for purposes of apdex measurement - you can use this to
         # ignore things like api calls or other fast non-user-facing
         # actions
@@ -433,7 +440,7 @@ module NewRelic
 
         def create_transaction_options(trace_options, category, state, queue_start_time)
           txn_options = {}
-          txn_options[:request]   = trace_options[:request]
+          txn_options[:request] = trace_options[:request]
           txn_options[:request] ||= request if respond_to?(:request) rescue nil
           # params should have been filtered before calling perform_action_with_newrelic_trace
           txn_options[:filtered_params] = trace_options[:params]
@@ -441,6 +448,9 @@ module NewRelic
           txn_options[:apdex_start_time] = queue_start_time
           txn_options[:ignore_apdex] = ignore_apdex?
           txn_options[:ignore_enduser] = ignore_enduser?
+          NewRelic::Agent::MethodTracerHelpers::SOURCE_CODE_INFORMATION_PARAMETERS.each do |parameter|
+            txn_options[parameter] = trace_options[parameter]
+          end
           txn_options
         end
 
@@ -456,7 +466,8 @@ module NewRelic
           NewRelic::Agent::Instrumentation::IgnoreActions.is_filtered?(
             key,
             self.class,
-            name)
+            name
+          )
         end
 
         def detect_queue_start_time(request)

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

@@ -0,0 +1,91 @@
+# 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
+
+require_relative 'instrumentation'
+
+module NewRelic::Agent::Instrumentation
+  module Curb
+    module Chain
+      def self.instrument! # rubocop:disable Metrics/AbcSize
+        Curl::Easy.class_eval do
+          include NewRelic::Agent::Instrumentation::Curb::Easy
+
+          def http_head_with_newrelic(*args, &blk)
+            http_head_with_tracing { 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)
+            http_post_with_tracing { 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)
+            http_put_with_tracing { 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)
+            http_with_tracing(verb) { 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
+            perform_with_tracing { 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)
+            method_with_tracing(verb) { 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
+            header_str_with_tracing { header_str_without_newrelic }
+          end
+
+          alias_method(:header_str_without_newrelic, :header_str)
+          alias_method(:header_str, :header_str_with_newrelic)
+        end
+
+        Curl::Multi.class_eval do
+          include NewRelic::Agent::Instrumentation::Curb::Multi
+
+          # Add CAT with callbacks if the request is serial
+          def add_with_newrelic(curl)
+            add_with_tracing(curl) { 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)
+            perform_with_tracing { perform_without_newrelic(&blk) }
+          end
+
+          alias_method(:perform_without_newrelic, :perform)
+          alias_method(:perform, :perform_with_newrelic)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,225 @@
+# 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 Curb
+        module Easy
+          attr_accessor :_nr_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_tracing
+            self._nr_http_verb = :HEAD
+            yield
+          end
+
+          def http_post_with_tracing
+            self._nr_http_verb = :POST
+            yield
+          end
+
+          def http_put_with_tracing
+            self._nr_http_verb = :PUT
+            yield
+          end
+
+          # Hook the #http method to set the verb.
+          def http_with_tracing(verb)
+            self._nr_http_verb = verb.to_s.upcase
+            yield
+          end
+
+          # Hook the #perform method to mark the request as non-parallel.
+          def perform_with_tracing
+            self._nr_http_verb ||= :GET
+            self._nr_serial = true
+            yield
+          end
+
+          # Record the HTTP verb for future #perform calls
+          def method_with_tracing(verb)
+            self._nr_http_verb = verb.upcase
+            yield
+          end
+
+          # We override this method in order to ensure access to header_str even
+          # though we use an on_header callback
+          def header_str_with_tracing
+            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.
+              yield
+            end
+          end
+        end
+        ####################################################
+
+        module Multi
+          include NewRelic::Agent::MethodTracer
+
+          INSTRUMENTATION_NAME = 'Curb'
+
+          # Add CAT with callbacks if the request is serial
+          def add_with_tracing(curl)
+            if curl.respond_to?(:_nr_serial) && curl._nr_serial
+              hook_pending_request(curl) if NewRelic::Agent::Tracer.tracing_enabled?
+            end
+
+            return yield
+          end
+
+          # Trace as an External/Multiple call if the first request isn't serial.
+          def perform_with_tracing
+            return yield if first_request_is_serial?
+
+            NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
+            trace_execution_scoped('External/Multiple/Curb::Multi/perform') do
+              yield
+            end
+          end
+
+          # 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
+                ::NewRelic::Agent::Transaction::Segment.finish(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)
+                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
+          # @__newrelic_original_callback exists to prevent infinitely chaining
+          # our on_failure callback hook.
+          def install_failure_callback(request, _wrapped_response, segment)
+            original_callback = request.on_failure
+
+            nr_original_callback = original_callback.instance_variable_get(:@__newrelic_original_callback)
+            original_callback = nr_original_callback || original_callback
+
+            request._nr_original_on_failure = original_callback
+
+            newrelic_callback = proc do |failed_request, error|
+              begin
+                if segment
+                  noticeable_error = NewRelic::Agent::NoticeableError.new(error[0].name, error[-1])
+                  segment.notice_error(noticeable_error)
+                end
+              ensure
+                original_callback&.call(failed_request, error)
+                remove_failure_callback(failed_request)
+              end
+            end
+            newrelic_callback.instance_variable_set(:@__newrelic_original_callback, original_callback)
+
+            request.on_failure(&newrelic_callback)
+          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)
+          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
+      end
+    end
+  end
+end