newrelic_rpm 8.15.0 → 9.6.0

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

@@ -0,0 +1,85 @@
+# 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/notifications_subscriber'
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      # NOTE: as of v7.1.0.0.alpha, deliver.action_mailer will provide
+      # an empty payload hash ({}) to #start, so in this subscriber class
+      # we defer params population until #finish and start the segment with
+      # a temporary name that is later replaced
+      class ActionMailerSubscriber < NotificationsSubscriber
+        BASE_NAME = 'Ruby/ActionMailer'
+        PAYLOAD_KEYS = %i[action data key mailer message_id perform_deliveries subject]
+        PATTERN = /\A([^\.]+)\.action_mailer\z/
+        UNKNOWN_MAILER = %r{^#{BASE_NAME}/#{UNKNOWN}/}
+
+        METHOD_NAME_MAPPING = Hash.new do |h, k|
+          if PATTERN =~ k
+            h[k] = $1
+          else
+            h[k] = NewRelic::UNKNOWN
+          end
+        end
+
+        def start(name, id, payload)
+          return unless state.is_execution_traced?
+
+          start_segment(name, id, payload)
+        rescue => e
+          log_notification_error(e, name, 'start')
+        end
+
+        def finish(name, id, payload)
+          return unless state.is_execution_traced?
+
+          finish_segment(id, payload)
+        rescue => e
+          log_notification_error(e, name, 'finish')
+        end
+
+        private
+
+        def start_segment(name, id, payload)
+          segment = Tracer.start_segment(name: metric_name(name, payload))
+          push_segment(id, segment)
+        end
+
+        def finish_segment(id, payload)
+          segment = pop_segment(id)
+          return unless segment
+
+          if segment.name.match?(UNKNOWN_MAILER) && payload.key?(:mailer)
+            segment.name = segment.name.sub(UNKNOWN_MAILER, "#{BASE_NAME}/#{payload[:mailer]}/")
+          end
+
+          PAYLOAD_KEYS.each do |key|
+            segment.params[key] = payload[key] if payload.key?(key)
+          end
+
+          notice_exception(segment, payload)
+          segment.finish
+        end
+
+        def notice_exception(segment, payload)
+          if exception = exception_object(payload)
+            segment.notice_error(exception)
+          end
+        end
+
+        def metric_name(name, payload)
+          mailer = payload[:mailer] || UNKNOWN
+          method = method_from_name(name)
+          "#{BASE_NAME}/#{mailer}/#{method}"
+        end
+
+        def method_from_name(name)
+          METHOD_NAME_MAPPING[name]
+        end
+      end
+    end
+  end
+end

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

@@ -10,28 +10,25 @@ module NewRelic
   module Agent
     module Instrumentation
       class ActionViewSubscriber < NotificationsSubscriber
-        def start(name, id, payload) # THREAD_LOCAL_ACCESS
+        def start_segment(name, id, payload)
           parent = segment_stack[id].last
           metric_name = format_metric_name(name, payload, parent)
 
           event = ActionViewEvent.new(metric_name, payload[:identifier])
-          if state.is_execution_traced? && recordable?(name, metric_name)
+
+          if recordable?(name, metric_name)
             event.finishable = Tracer.start_segment(name: metric_name)
           end
           push_segment(id, event)
-        rescue => e
-          log_notification_error(e, name, 'start')
         end
 
-        def finish(name, id, payload)
+        def finish_segment(id, payload)
           if segment = pop_segment(id)
             if exception = exception_object(payload)
               segment.notice_error(exception)
             end
             segment.finish
           end
-        rescue => e
-          log_notification_error(e, name, 'finish')
         end
 
         def format_metric_name(event_name, payload, parent)
@@ -61,12 +58,15 @@ module NewRelic
         RENDER_TEMPLATE_EVENT_NAME = 'render_template.action_view'.freeze
         RENDER_PARTIAL_EVENT_NAME = 'render_partial.action_view'.freeze
         RENDER_COLLECTION_EVENT_NAME = 'render_collection.action_view'.freeze
+        RENDER_LAYOUT_EVENT_NAME = 'render_layout.action_view'.freeze
 
         def metric_action(name)
           case name
           when /#{RENDER_TEMPLATE_EVENT_NAME}$/o then 'Rendering'
           when RENDER_PARTIAL_EVENT_NAME then 'Partial'
           when RENDER_COLLECTION_EVENT_NAME then 'Partial'
+          when RENDER_LAYOUT_EVENT_NAME then 'Layout'
+          else NewRelic::UNKNOWN
           end
         end
 
@@ -75,7 +75,7 @@ module NewRelic
           # so do not mistake rendering a collection for rendering a file.
           if identifier.nil? && name != RENDER_COLLECTION_EVENT_NAME
             'file'
-          elsif identifier =~ /template$/
+          elsif /template$/.match?(identifier)
             identifier
           elsif identifier && (parts = identifier.split('/')).size > 1
             parts[-2..-1].join('/')
@@ -99,11 +99,11 @@ module NewRelic
         end
 
         def finish
-          @finishable.finish if @finishable
+          @finishable&.finish
         end
 
         def notice_error(error)
-          @finishable.notice_error(error) if @finishable
+          @finishable&.notice_error(error)
         end
       end
     end

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

@@ -12,7 +12,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    NewRelic::Agent.logger.info('Installing ActiveJob instrumentation')
+    NewRelic::Agent.logger.info('Installing base ActiveJob instrumentation')
 
     ActiveSupport.on_load(:active_job) do
       ActiveJob::Base.around_enqueue do |job, block|
@@ -26,6 +26,19 @@ DependencyDetection.defer do
       NewRelic::Agent::PrependSupportability.record_metrics_for(ActiveJob::Base)
     end
   end
+
+  executes do
+    if defined?(ActiveSupport) &&
+        ActiveJob.respond_to?(:gem_version) &&
+        ActiveJob.gem_version >= Gem::Version.new('6.0.0') &&
+        !NewRelic::Agent.config[:disable_activejob] &&
+        !NewRelic::Agent::Instrumentation::ActiveJobSubscriber.subscribed?
+      NewRelic::Agent.logger.info('Installing notifications based ActiveJob instrumentation')
+
+      ActiveSupport::Notifications.subscribe(/\A[^\.]+\.active_job\z/,
+        NewRelic::Agent::Instrumentation::ActiveJobSubscriber.new)
+    end
+  end
 end
 
 module NewRelic
@@ -44,7 +57,7 @@ module NewRelic
 
           # Don't nest transactions if we're already in a web transaction.
           # Probably inline processing the job if that happens, so just trace.
-          if txn && txn.recording_web_transaction?
+          if txn&.recording_web_transaction?
             run_in_trace(job, block, :Consume)
           elsif txn && !txn.recording_web_transaction?
             ::NewRelic::Agent::Transaction.set_default_transaction_name(
@@ -58,7 +71,7 @@ module NewRelic
         end
 
         def self.run_in_trace(job, block, event)
-          trace_execution_scoped("MessageBroker/#{adapter}/Queue/#{event}/Named/#{job.queue_name}",
+          trace_execution_scoped("ActiveJob/#{adapter.sub(/^ActiveJob::/, '')}/Queue/#{event}/Named/#{job.queue_name}",
             code_information: code_information_for_job(job)) do
             block.call
           end

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

@@ -0,0 +1,41 @@
+# 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/notifications_subscriber'
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      class ActiveJobSubscriber < NotificationsSubscriber
+        PAYLOAD_KEYS = %i[adapter db_runtime error job wait]
+
+        def add_segment_params(segment, payload)
+          PAYLOAD_KEYS.each do |key|
+            segment.params[key] = payload[key] if payload.key?(key)
+          end
+        end
+
+        def metric_name(name, payload)
+          queue = payload[:job].queue_name
+          method = method_from_name(name)
+          "Ruby/ActiveJob/#{queue}/#{method}"
+        end
+
+        PATTERN = /\A([^\.]+)\.active_job\z/
+
+        METHOD_NAME_MAPPING = Hash.new do |h, k|
+          if PATTERN =~ k
+            h[k] = $1
+          else
+            h[k] = NewRelic::UNKNOWN
+          end
+        end
+
+        def method_from_name(name)
+          METHOD_NAME_MAPPING[name]
+        end
+      end
+    end
+  end
+end

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

@@ -27,9 +27,9 @@ DependencyDetection.defer do
         actions = [:authorize, :purchase, :credit, :void, :capture, :recurring, :store, :unstore, :update]
         actions.each do |operation|
           if implemented_methods.include?(operation)
-            add_method_tracer operation, [-> (*) { "ActiveMerchant/gateway/#{gateway_name}/#{operation}" },
-              -> (*) { "ActiveMerchant/gateway/#{gateway_name}" },
-              -> (*) { "ActiveMerchant/operation/#{operation}" }]
+            add_method_tracer operation, [->(*) { "ActiveMerchant/gateway/#{gateway_name}/#{operation}" },
+              ->(*) { "ActiveMerchant/gateway/#{gateway_name}" },
+              ->(*) { "ActiveMerchant/operation/#{operation}" }]
           end
         end
       end

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

@@ -13,7 +13,8 @@ module NewRelic
             ::ActiveRecord::Base.send("#{statement.config[:adapter]}_connection",
               statement.config)
           end
-          if connection && connection.respond_to?(:execute)
+          # the following line needs else branch coverage
+          if connection && connection.respond_to?(:execute) # rubocop:disable Style/SafeNavigation
             return connection.execute("EXPLAIN #{statement.sql}")
           end
         end
@@ -43,7 +44,7 @@ module NewRelic
           end
         end
 
-        if RUBY_VERSION < "2.7.0"
+        if RUBY_VERSION < '2.7.0'
           def log_with_newrelic_instrumentation(*args, &block)
             state = NewRelic::Agent::Tracer.state
 
@@ -147,7 +148,7 @@ DependencyDetection.defer do
   end
 
   depends_on do
-    !NewRelic::Agent.config[:disable_activerecord_instrumentation]
+    !NewRelic::Agent.config[:disable_active_record_instrumentation]
   end
 
   executes do

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

@@ -49,7 +49,7 @@ module NewRelic
 
             alias_method(:delete_all_without_newrelic, :delete_all)
 
-            if RUBY_VERSION < "2.7.0"
+            if RUBY_VERSION < '2.7.0'
               def delete_all(*args, &blk)
                 ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
                   delete_all_without_newrelic(*args, &blk)
@@ -92,9 +92,9 @@ module NewRelic
           end
         end
 
-        ACTIVE_RECORD = "ActiveRecord".freeze
-        OTHER = "other".freeze
-        MAKARA_SUFFIX = "_makara".freeze
+        ACTIVE_RECORD = 'ActiveRecord'.freeze
+        OTHER = 'other'.freeze
+        MAKARA_SUFFIX = '_makara'.freeze
 
         # convert vendor (makara, etc.) wrapper names to their bare names
         # ex: postgresql_makara -> postgresql
@@ -102,7 +102,7 @@ module NewRelic
           # TODO: OLD RUBIES - RUBY_VERSION < 2.5
           # With Ruby 2.5+ we could use #delete_suffix instead of #chomp for a
           # potential speed boost
-          return adapter_name.chomp(MAKARA_SUFFIX) if adapter_name && adapter_name.end_with?(MAKARA_SUFFIX)
+          return adapter_name.chomp(MAKARA_SUFFIX) if adapter_name&.end_with?(MAKARA_SUFFIX)
 
           adapter_name
         end
@@ -118,7 +118,7 @@ module NewRelic
         SPACE = ' '.freeze
 
         def split_name(name)
-          if name && name.respond_to?(:split)
+          if name&.respond_to?(:split)
             name.split(SPACE)
           else
             NewRelic::EMPTY_ARRAY
@@ -163,47 +163,50 @@ module NewRelic
         end
 
         PRODUCT_NAMES = {
-          "mysql" => "MySQL",
-          "mysql2" => "MySQL",
+          'mysql' => 'MySQL',
+          'mysql2' => 'MySQL',
 
-          "postgresql" => "Postgres",
+          'postgresql' => 'Postgres',
 
-          "sqlite3" => "SQLite",
+          'sqlite3' => 'SQLite',
 
           # https://rubygems.org/gems/activerecord-jdbcpostgresql-adapter
-          "jdbcmysql" => "MySQL",
+          'jdbcmysql' => 'MySQL',
 
           # https://rubygems.org/gems/activerecord-jdbcpostgresql-adapter
-          "jdbcpostgresql" => "Postgres",
+          'jdbcpostgresql' => 'Postgres',
 
           # https://rubygems.org/gems/activerecord-postgis-adapter
-          "postgis" => "Postgres",
+          'postgis' => 'Postgres',
 
           # https://rubygems.org/gems/activerecord-jdbcsqlite3-adapter
-          "jdbcsqlite3" => "SQLite",
+          'jdbcsqlite3' => 'SQLite',
 
           # https://rubygems.org/gems/activerecord-jdbcderby-adapter
-          "derby" => "Derby",
-          "jdbcderby" => "Derby",
+          'derby' => 'Derby',
+          'jdbcderby' => 'Derby',
 
           # https://rubygems.org/gems/activerecord-jdbc-adapter
-          "jdbc" => "JDBC",
+          'jdbc' => 'JDBC',
 
           # https://rubygems.org/gems/activerecord-jdbcmssql-adapter
-          "jdbcmssql" => "MSSQL",
-          "mssql" => "MSSQL",
+          'jdbcmssql' => 'MSSQL',
+          'mssql' => 'MSSQL',
 
           # https://rubygems.org/gems/activerecord-sqlserver-adapter
-          "sqlserver" => "MSSQL",
+          'sqlserver' => 'MSSQL',
 
           # https://rubygems.org/gems/activerecord-odbc-adapter
-          "odbc" => "ODBC",
+          'odbc' => 'ODBC',
 
           # https://rubygems.org/gems/activerecord-oracle_enhanced-adapter
-          "oracle_enhanced" => "Oracle"
+          'oracle_enhanced' => 'Oracle',
+
+          # https://rubygems.org/gems/activerecord-amazon-timestream-adapter
+          'amazon_timestream' => 'Timestream'
         }.freeze
 
-        ACTIVE_RECORD_DEFAULT_PRODUCT_NAME = "ActiveRecord".freeze
+        ACTIVE_RECORD_DEFAULT_PRODUCT_NAME = 'ActiveRecord'.freeze
 
         def map_product(adapter_name)
           PRODUCT_NAMES.fetch(adapter_name, ACTIVE_RECORD_DEFAULT_PRODUCT_NAME)
@@ -213,24 +216,23 @@ module NewRelic
           extend self
 
           PRODUCT_SYMBOLS = {
-            "mysql" => :mysql,
-            "mysql2" => :mysql,
-            "jdbcmysql" => :mysql,
+            'mysql' => :mysql,
+            'mysql2' => :mysql,
+            'jdbcmysql' => :mysql,
 
-            "postgresql" => :postgres,
-            "jdbcpostgresql" => :postgres,
-            "postgis" => :postgres
+            'postgresql' => :postgres,
+            'jdbcpostgresql' => :postgres,
+            'postgis' => :postgres
           }.freeze
 
           DATASTORE_DEFAULT_PORTS = {
-            :mysql => "3306",
-            :postgres => "5432"
+            :mysql => '3306',
+            :postgres => '5432'
           }.freeze
 
-          DEFAULT = "default".freeze
-          UNKNOWN = "unknown".freeze
-          SLASH = "/".freeze
-          LOCALHOST = "localhost".freeze
+          DEFAULT = 'default'.freeze
+          UNKNOWN = 'unknown'.freeze
+          LOCALHOST = 'localhost'.freeze
 
           def adapter_from_config(config)
             bare_name = NewRelic::Agent::Instrumentation::ActiveRecordHelper.bare_adapter_name(config[:adapter])
@@ -285,7 +287,7 @@ module NewRelic
           private
 
           def postgres_unix_domain_socket_case?(host, adapter)
-            adapter == :postgres && host && host.start_with?(SLASH)
+            adapter == :postgres && host && host.start_with?(NewRelic::SLASH)
           end
 
           def mysql_default_case?(config, adapter)

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

@@ -16,7 +16,7 @@ module NewRelic
 
         module BaseExtensions4x
           # https://github.com/rails/rails/blob/4-1-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L371
-          def log(sql, name = "SQL", binds = [], statement_name = nil)
+          def log(sql, name = 'SQL', binds = [], statement_name = nil)
             @instrumenter.instrument(
               SQL_ACTIVE_RECORD,
               :sql => sql,
@@ -38,7 +38,7 @@ module NewRelic
 
         module BaseExtensions50
           # https://github.com/rails/rails/blob/5-0-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L582
-          def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil)
+          def log(sql, name = 'SQL', binds = [], type_casted_binds = [], statement_name = nil)
             @instrumenter.instrument(
               SQL_ACTIVE_RECORD,
               sql: sql,
@@ -56,7 +56,7 @@ module NewRelic
 
         module BaseExtensions51
           # https://github.com/rails/rails/blob/5-1-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L603
-          def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
+          def log(sql, name = 'SQL', binds = [], type_casted_binds = [], statement_name = nil) # :doc:
             @instrumenter.instrument(
               SQL_ACTIVE_RECORD,
               sql: sql,
@@ -90,7 +90,8 @@ DependencyDetection.defer do
   end
 
   depends_on do
-    !NewRelic::Agent.config[:disable_activerecord_instrumentation] &&
+    !NewRelic::Agent.config[:disable_active_record_instrumentation] &&
+      !NewRelic::Agent.config[:disable_active_record_notifications] &&
       !NewRelic::Agent::Instrumentation::ActiveRecordSubscriber.subscribed?
   end
 

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

@@ -11,7 +11,7 @@ module NewRelic
         ACTIVE_RECORD = 'ActiveRecord'.freeze
 
         module BaseExtensions
-          if RUBY_VERSION < "2.7.0"
+          if RUBY_VERSION < '2.7.0'
             def save(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
                 super
@@ -46,7 +46,7 @@ module NewRelic
           # Starting in v5.1.6, this call no longer happens. We'll
           # have to set the database metrics explicitly now.
           #
-          if RUBY_VERSION < "2.7.0"
+          if RUBY_VERSION < '2.7.0'
             def touch(*args, **kwargs, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
                 super

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

@@ -33,7 +33,7 @@ module NewRelic
           # defensive.
           return if defined?(cached?)
 
-          if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::STRING >= "5.1.0"
+          if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::STRING >= '5.1.0'
             def cached?(payload)
               payload.fetch(:cached, false)
             end
@@ -74,7 +74,8 @@ module NewRelic
             ::ActiveRecord::Base.send("#{statement.config[:adapter]}_connection",
               statement.config)
           end
-          if connection && connection.respond_to?(:exec_query)
+          # the following line needs else branch coverage
+          if connection && connection.respond_to?(:exec_query) # rubocop:disable Style/SafeNavigation
             return connection.exec_query("EXPLAIN #{statement.sql}",
               "Explain #{statement.name}",
               statement.binds)

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

@@ -7,6 +7,10 @@ require 'new_relic/agent/instrumentation/active_storage_subscriber'
 DependencyDetection.defer do
   named :active_storage
 
+  depends_on do
+    !NewRelic::Agent.config[:disable_active_storage]
+  end
+
   depends_on do
     defined?(ActiveStorage) &&
       !NewRelic::Agent::Instrumentation::ActiveStorageSubscriber.subscribed?

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

@@ -8,36 +8,9 @@ module NewRelic
   module Agent
     module Instrumentation
       class ActiveStorageSubscriber < NotificationsSubscriber
-        def start(name, id, payload)
-          return unless state.is_execution_traced?
-
-          start_segment(name, id, payload)
-        rescue => e
-          log_notification_error(e, name, 'start')
-        end
-
-        def finish(name, id, payload)
-          return unless state.is_execution_traced?
-
-          finish_segment(id, payload)
-        rescue => e
-          log_notification_error(e, name, 'finish')
-        end
-
-        def start_segment(name, id, payload)
-          segment = Tracer.start_segment(name: metric_name(name, payload))
+        def add_segment_params(segment, payload)
           segment.params[:key] = payload[:key]
           segment.params[:exist] = payload[:exist] if payload.key?(:exist)
-          push_segment(id, segment)
-        end
-
-        def finish_segment(id, payload)
-          if segment = pop_segment(id)
-            if exception = exception_object(payload)
-              segment.notice_error(exception)
-            end
-            segment.finish
-          end
         end
 
         def metric_name(name, payload)
@@ -47,13 +20,12 @@ module NewRelic
         end
 
         PATTERN = /\Aservice_([^\.]*)\.active_storage\z/
-        UNKNOWN = "unknown".freeze
 
         METHOD_NAME_MAPPING = Hash.new do |h, k|
           if PATTERN =~ k
             h[k] = $1
           else
-            h[k] = UNKNOWN
+            h[k] = NewRelic::UNKNOWN
           end
         end
 

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

@@ -2,11 +2,26 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-# This is a helper file that will allow apps using ActiveSupport without Rails
-# to still leverage all ActiveSupport based instrumentation functionality
-# offered by the agent that would otherwise be gated by the detection of Rails.
+require 'new_relic/agent/instrumentation/active_support_subscriber'
 
-# ActiveSupport notifications custom events
-if !defined?(Rails) && defined?(ActiveSupport::Notifications) && defined?(ActiveSupport::IsolatedExecutionState)
-  require_relative 'rails_notifications/custom_events'
+DependencyDetection.defer do
+  named :active_support
+
+  depends_on do
+    !NewRelic::Agent.config[:disable_active_support]
+  end
+
+  depends_on do
+    defined?(ActiveSupport) &&
+      !NewRelic::Agent::Instrumentation::ActiveSupportSubscriber.subscribed?
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing ActiveSupport instrumentation')
+  end
+
+  executes do
+    ActiveSupport::Notifications.subscribe(/\.active_support$/,
+      NewRelic::Agent::Instrumentation::ActiveSupportSubscriber.new)
+  end
 end