newrelic_rpm 3.12.0.288 → 9.10.2

data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb

@@ -1,12 +1,16 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require 'new_relic/agent/parameter_filtering'
 
 module NewRelic
   module Agent
     module Instrumentation
       module Rails3
         module ActionController
+          INSTRUMENTATION_NAME = NewRelic::Agent.base_name(name)
+
           # determine the path that is used in the metric name for
           # the called controller action
           def newrelic_metric_path(action_name_override = nil)
@@ -18,17 +22,18 @@ module NewRelic
             end
           end
 
-          def process_action(*args) #THREAD_LOCAL_ACCESS
+          def process_action(*args) # THREAD_LOCAL_ACCESS
+            NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
             munged_params = NewRelic::Agent::ParameterFiltering.filter_rails_request_parameters(request.filtered_parameters)
             perform_action_with_newrelic_trace(:category => :controller,
-                                               :name => self.action_name,
-                                               :path => newrelic_metric_path,
-                                               :params => munged_params,
-                                               :class_name => self.class.name)  do
+              :name => self.action_name,
+              :path => newrelic_metric_path,
+              :params => munged_params,
+              :class_name => self.class.name) do
               super
             end
           end
-
         end
 
         module ActionView
@@ -36,15 +41,16 @@ module NewRelic
             extend self
             def template_metric(identifier, options = {})
               if options[:file]
-                "file"
+                'file'
               elsif identifier.nil?
                 ::NewRelic::Agent::UNKNOWN_METRIC
-              elsif identifier.include? '/' # this is a filepath
+              elsif identifier.include?('/') # this is a filepath
                 identifier.split('/')[-2..-1].join('/')
               else
                 identifier
               end
             end
+
             def render_type(file_path)
               file = File.basename(file_path)
               if file.starts_with?('_')
@@ -64,7 +70,7 @@ DependencyDetection.defer do
   @name = :rails3_controller
 
   depends_on do
-    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3
+    defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR.to_i == 3
   end
 
   depends_on do
@@ -72,7 +78,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing Rails 3 Controller instrumentation'
+    NewRelic::Agent.logger.info('Installing Rails 3 Controller instrumentation')
   end
 
   executes do
@@ -82,50 +88,16 @@ DependencyDetection.defer do
     end
   end
 end
-DependencyDetection.defer do
-  @name = :rails30_view
-
-  depends_on do
-    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3 && ::Rails::VERSION::MINOR.to_i == 0
-  end
-
-  depends_on do
-    !NewRelic::Agent.config[:disable_view_instrumentation]
-  end
-
-  executes do
-    ::NewRelic::Agent.logger.info 'Installing Rails 3.0 view instrumentation'
-  end
-
-  executes do
-    ActionView::Template.class_eval do
-      include NewRelic::Agent::MethodTracer
-      def render_with_newrelic(*args, &block)
-        options = if @virtual_path && @virtual_path.starts_with?('/') # file render
-          {:file => true }
-        else
-          {}
-        end
-        str = "View/#{NewRelic::Agent::Instrumentation::Rails3::ActionView::NewRelic.template_metric(@identifier, options)}/#{NewRelic::Agent::Instrumentation::Rails3::ActionView::NewRelic.render_type(@identifier)}"
-        trace_execution_scoped str do
-          render_without_newrelic(*args, &block)
-        end
-      end
-
-      alias_method :render_without_newrelic, :render
-      alias_method :render, :render_with_newrelic
-
-    end
-  end
-end
 
+# Though this uses the name :rails31_view, it is used only for rails 3.2 now
+# Rails 3.1 is no longer supported by the agent.
 DependencyDetection.defer do
   @name = :rails31_view
 
-  # We can't be sure that this will work with future versions of Rails 3.
-  # Currently enabled for Rails 3.1 and 3.2
+  # Enabled for Rails 3.2
   depends_on do
-    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3 && ([1,2].member?(::Rails::VERSION::MINOR.to_i))
+    defined?(Rails::VERSION::MAJOR) && defined?(Rails::VERSION::MINOR) &&
+      Rails::VERSION::MAJOR.to_i == 3 && Rails::VERSION::MINOR.to_i == 2
   end
 
   depends_on do
@@ -133,7 +105,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing Rails 3.1/3.2 view instrumentation'
+    NewRelic::Agent.logger.info('Installing Rails 3.2 view instrumentation')
   end
 
   executes do
@@ -143,10 +115,11 @@ DependencyDetection.defer do
 
       def render_with_newrelic(context, options)
         # This is needed for rails 3.2 compatibility
-        @details = extract_details(options) if respond_to? :extract_details, true
-        identifier = determine_template(options) ? determine_template(options).identifier : nil
+        @details = extract_details(options) if respond_to?(:extract_details, true)
+        # this file can't be found in SimpleCov, need to check test coverage
+        identifier = determine_template(options) ? determine_template(options).identifier : nil # rubocop:disable Style/SafeNavigation
         scope_name = "View/#{NewRelic::Agent::Instrumentation::Rails3::ActionView::NewRelic.template_metric(identifier, options)}/Rendering"
-        trace_execution_scoped scope_name do
+        trace_execution_scoped(scope_name) do
           render_without_newrelic(context, options)
         end
       end

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/agent/instrumentation/middleware_proxy'
 
@@ -8,15 +8,15 @@ DependencyDetection.defer do
   named :rails_middleware
 
   depends_on do
-    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
+    !NewRelic::Agent.config[:disable_middleware_instrumentation]
   end
 
   depends_on do
-    !::NewRelic::Agent.config[:disable_middleware_instrumentation]
+    defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR.to_i >= 3
   end
 
   executes do
-    ::NewRelic::Agent.logger.info("Installing Rails 3+ middleware instrumentation")
+    NewRelic::Agent.logger.info('Installing Rails 3+ middleware instrumentation')
     module ActionDispatch
       class MiddlewareStack
         class Middleware

data/lib/new_relic/agent/instrumentation/rails_notifications/action_cable.rb

@@ -0,0 +1,36 @@
+# 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/instrumentation/action_cable_subscriber'
+require 'new_relic/agent/prepend_supportability'
+
+DependencyDetection.defer do
+  @name = :action_cable_notifications
+
+  depends_on do
+    defined?(ActionCable::VERSION::MAJOR) &&
+      ActionCable::VERSION::MAJOR.to_i >= 5 &&
+      defined?(ActiveSupport)
+  end
+
+  depends_on do
+    !NewRelic::Agent.config[:disable_action_cable_instrumentation] &&
+      !NewRelic::Agent::Instrumentation::ActionCableSubscriber.subscribed?
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing notifications based Action Cable instrumentation')
+  end
+
+  executes do
+    # enumerate the specific events we want so that we do not get unexpected additions in the future
+    ActiveSupport::Notifications.subscribe(/\A(?:perform_action|transmit.*|broadcast)\.action_cable\z/,
+      NewRelic::Agent::Instrumentation::ActionCableSubscriber.new)
+
+    ActiveSupport.on_load(:action_cable) do
+      NewRelic::Agent::PrependSupportability.record_metrics_for(ActionCable::Engine) if defined?(ActionCable::Engine)
+      NewRelic::Agent::PrependSupportability.record_metrics_for(ActionCable::RemoteConnections) if defined?(ActionCable::RemoteConnections)
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/rails_notifications/action_controller.rb

@@ -0,0 +1,46 @@
+# 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/instrumentation/action_controller_subscriber'
+require 'new_relic/agent/instrumentation/action_controller_other_subscriber'
+require 'new_relic/agent/prepend_supportability'
+
+DependencyDetection.defer do
+  @name = :action_controller_notifications
+
+  depends_on do
+    defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR.to_i >= 4
+  end
+
+  depends_on do
+    !NewRelic::Agent.config[:disable_action_controller] &&
+      defined?(ActionController) && (defined?(ActionController::Base) || defined?(ActionController::API))
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing notifications based Action Controller instrumentation')
+  end
+
+  executes do
+    ActiveSupport.on_load(:action_controller) do
+      include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+      NewRelic::Agent::PrependSupportability.record_metrics_for(self)
+    end
+
+    NewRelic::Agent::Instrumentation::ActionControllerSubscriber \
+      .subscribe(/^process_action.action_controller$/)
+
+    subs = %w[send_file
+      send_data
+      send_stream
+      redirect_to
+      halted_callback
+      unpermitted_parameters]
+
+    # have to double escape period because its going from string -> regex
+    NewRelic::Agent::Instrumentation::ActionControllerOtherSubscriber \
+      .subscribe(Regexp.new("^(#{subs.join('|')})\\.action_controller$"))
+  end
+end

data/lib/new_relic/agent/instrumentation/rails_notifications/action_view.rb

@@ -0,0 +1,30 @@
+# 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/instrumentation/action_view_subscriber'
+require 'new_relic/agent/prepend_supportability'
+
+DependencyDetection.defer do
+  @name = :action_view_notifications
+
+  depends_on do
+    defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR.to_i >= 4
+  end
+
+  depends_on do
+    !NewRelic::Agent.config[:disable_view_instrumentation] &&
+      !NewRelic::Agent::Instrumentation::ActionViewSubscriber.subscribed?
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing notification based Action View instrumentation')
+  end
+
+  executes do
+    ActiveSupport.on_load(:action_view) do
+      NewRelic::Agent::Instrumentation::ActionViewSubscriber.subscribe(/render_.+\.action_view$/)
+      NewRelic::Agent::PrependSupportability.record_metrics_for(ActionView::Base, ActionView::Template, ActionView::Renderer)
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/rails_notifications/custom_events.rb

@@ -0,0 +1,30 @@
+# 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/instrumentation/custom_events_subscriber'
+require 'new_relic/agent/prepend_supportability'
+
+DependencyDetection.defer do
+  @name = :custom_event_notifications
+
+  depends_on do
+    defined?(ActiveSupport::Notifications) &&
+      defined?(ActiveSupport::IsolatedExecutionState)
+  end
+
+  depends_on do
+    !NewRelic::Agent.config[:active_support_custom_events_names].empty? &&
+      !NewRelic::Agent::Instrumentation::CustomEventsSubscriber.subscribed?
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing notifications based ActiveSupport custom events instrumentation')
+  end
+
+  executes do
+    NewRelic::Agent.config[:active_support_custom_events_names].each do |name|
+      ActiveSupport::Notifications.subscribe(name, NewRelic::Agent::Instrumentation::CustomEventsSubscriber.new)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# 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::Agent::Instrumentation
+  module Rake
+    module Chain
+      def self.instrument!
+        ::Rake::Task.class_eval do
+          include NewRelic::Agent::Instrumentation::Rake::Tracer
+          alias_method(:invoke_without_newrelic, :invoke)
+
+          def invoke(*args)
+            invoke_with_newrelic_tracing(*args) { invoke_without_newrelic(*args) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+# 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 Rake
+        module Tracer
+          INSTRUMENTATION_NAME = 'Rake'
+
+          def invoke_with_newrelic_tracing(*args)
+            unless NewRelic::Agent::Instrumentation::Rake.should_trace?(name)
+              return yield
+            end
+
+            NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
+            begin
+              timeout = NewRelic::Agent.config[:'rake.connect_timeout']
+              NewRelic::Agent.instance.wait_on_connect(timeout)
+            rescue => e
+              NewRelic::Agent.logger.error('Exception in wait_on_connect', e)
+              return yield
+            end
+
+            NewRelic::Agent::Instrumentation::Rake.before_invoke_transaction(self)
+
+            NewRelic::Agent::Tracer.in_transaction(name: "OtherTransaction/Rake/invoke/#{name}", category: :rake) do
+              NewRelic::Agent::Instrumentation::Rake.record_attributes(args, self)
+              yield
+            end
+          end
+        end
+
+        module_function
+
+        def should_install?
+          safe_from_third_party_gem?
+        end
+
+        def safe_from_third_party_gem?
+          return true unless NewRelic::LanguageSupport.bundled_gem?('newrelic-rake')
+
+          ::NewRelic::Agent.logger.info('Not installing New Relic supported Rake instrumentation because the third party newrelic-rake gem is present')
+          false
+        end
+
+        def should_trace?(name)
+          NewRelic::Agent.config[:'rake.tasks'].any? do |regex|
+            regex.match(name)
+          end
+        end
+
+        def instrument_execute_on_prereqs(task)
+          task.prerequisite_tasks.each do |child_task|
+            instrument_execute(child_task)
+          end
+        end
+
+        def instrument_execute(task)
+          return if task.instance_variable_get(:@__newrelic_instrumented_execute)
+
+          task.instance_variable_set(:@__newrelic_instrumented_execute, true)
+          task.instance_eval do
+            def execute(*args, &block)
+              NewRelic::Agent::MethodTracer.trace_execution_scoped("Rake/execute/#{self.name}") do
+                super
+              end
+            end
+          end
+
+          instrument_execute_on_prereqs(task)
+        end
+
+        def instrument_invoke_prerequisites_concurrently(task)
+          task.instance_eval do
+            def invoke_prerequisites_concurrently(*_)
+              NewRelic::Agent::MethodTracer.trace_execution_scoped('Rake/execute/multitask') do
+                super
+              end
+            end
+          end
+        end
+
+        def before_invoke_transaction(task)
+          ensure_at_exit
+
+          instrument_execute_on_prereqs(task)
+          if task.application.options.always_multitask
+            instrument_invoke_prerequisites_concurrently(task)
+          end
+        rescue => e
+          NewRelic::Agent.logger.error('Error during Rake task invoke', e)
+        end
+
+        def record_attributes(args, task)
+          command_line = task.application.top_level_tasks.join(' ')
+          NewRelic::Agent::Transaction.merge_untrusted_agent_attributes({:command => command_line},
+            :'job.rake',
+            NewRelic::Agent::AttributeFilter::DST_NONE)
+          named_args = name_the_args(args, task.arg_names)
+          unless named_args.empty?
+            NewRelic::Agent::Transaction.merge_untrusted_agent_attributes(named_args,
+              :'job.rake.args',
+              NewRelic::Agent::AttributeFilter::DST_NONE)
+          end
+        rescue => e
+          NewRelic::Agent.logger.error('Error during Rake task attribute recording.', e)
+        end
+
+        # Expects literal args passed to the task and array of task names
+        # If names are present without matching args, still sets them with nils
+        def name_the_args(args, names)
+          unfulfilled_names_length = names.length - args.length
+          if unfulfilled_names_length > 0
+            args.concat(Array.new(unfulfilled_names_length))
+          end
+
+          result = {}
+          args.zip(names).each_with_index do |(value, key), index|
+            result[key || index.to_s] = value
+          end
+          result
+        end
+
+        def ensure_at_exit
+          return if @installed_at_exit
+
+          at_exit do
+            # The agent's default at_exit might not default to installing, but
+            # if we are running an instrumented rake task, we always want it.
+            # No code coverage, as the strategy for mocking Kernel.exit prevents
+            # the at_exit block from being executed, and not mocking results in
+            # an early unwanted exit of MiniTest.
+            # :nocov:
+            NewRelic::Agent.shutdown
+            # :nocov:
+          end
+
+          @installed_at_exit = true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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::Agent::Instrumentation
+  module Rake
+    module Prepend
+      include NewRelic::Agent::Instrumentation::Rake::Tracer
+      def invoke(*args)
+        invoke_with_newrelic_tracing(*args) { super }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# 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 'rake/instrumentation'
+require_relative 'rake/chain'
+require_relative 'rake/prepend'
+
+DependencyDetection.defer do
+  # Why not :rake? newrelic-rake used that name, so avoid conflicting
+  @name = :rake_instrumentation
+  configure_with :rake
+
+  depends_on { defined?(Rake) && defined?(Rake::VERSION) }
+  depends_on { Gem::Version.new(Rake::VERSION) >= Gem::Version.new('10.0.0') }
+  depends_on { NewRelic::Agent.config[:'rake.tasks'].any? }
+  depends_on { NewRelic::Agent::Instrumentation::Rake.safe_from_third_party_gem? }
+
+  executes do
+    NewRelic::Agent.logger.info('Installing Rake instrumentation')
+    NewRelic::Agent.logger.debug("Instrumenting Rake tasks: #{NewRelic::Agent.config[:'rake.tasks']}")
+  end
+
+  executes do
+    if use_prepend?
+      prepend_instrument Rake::Task, NewRelic::Agent::Instrumentation::Rake::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::Rake::Chain
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# 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::Agent::Instrumentation
+  module Redis
+    module Chain
+      def self.instrument!
+        ::Redis::Client.class_eval do
+          include NewRelic::Agent::Instrumentation::Redis
+
+          if method_defined?(:call_v)
+            alias_method(:call_v_without_new_relic, :call_v)
+
+            def call_v(*args, &block)
+              call_with_tracing(args[0]) { call_v_without_new_relic(*args, &block) }
+            end
+          end
+
+          if method_defined?(:call)
+            alias_method(:call_without_new_relic, :call)
+
+            def call(*args, &block)
+              call_with_tracing(args[0]) { call_without_new_relic(*args, &block) }
+            end
+          end
+
+          if method_defined?(:call_pipeline)
+            alias_method(:call_pipeline_without_new_relic, :call_pipeline)
+
+            def call_pipeline(*args, &block)
+              call_pipeline_with_tracing(args[0]) { call_pipeline_without_new_relic(*args, &block) }
+            end
+          end
+
+          alias_method(:connect_without_new_relic, :connect)
+
+          def connect(*args, &block)
+            connect_with_tracing { connect_without_new_relic(*args, &block) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/redis/constants.rb

@@ -0,0 +1,17 @@
+# 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::Agent::Instrumentation::Redis
+  class Constants
+    PRODUCT_NAME = 'Redis'
+    CONNECT = 'connect'
+    UNKNOWN = 'unknown'
+    LOCALHOST = 'localhost'
+    MULTI_OPERATION = 'multi'
+    PIPELINE_OPERATION = 'pipeline'
+    HAS_REDIS_CLIENT = defined?(::Redis) &&
+      Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('5.0.0') &&
+      !defined?(::RedisClient).nil?
+  end
+end