newrelic_rpm 5.7.0.350 → 9.0.0

data/lib/new_relic/agent/instrumentation/action_mailbox.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_mailbox_subscriber'
+
+DependencyDetection.defer do
+  named :action_mailbox
+
+  depends_on do
+    !NewRelic::Agent.config[:disable_action_mailbox]
+  end
+
+  depends_on do
+    defined?(ActiveSupport) &&
+      defined?(ActionMailbox) &&
+      ActionMailbox.respond_to?(:gem_version) && # 'require "action_mailbox"' doesn't require version...
+      ActionMailbox.gem_version >= Gem::Version.new('7.1.0.alpha') && # notifications added in Rails 7.1
+      !NewRelic::Agent::Instrumentation::ActionMailboxSubscriber.subscribed?
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing ActionMailbox instrumentation')
+  end
+
+  executes do
+    ActiveSupport::Notifications.subscribe(/\A[^\.]+\.action_mailbox\z/,
+      NewRelic::Agent::Instrumentation::ActionMailboxSubscriber.new)
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 ActionMailboxSubscriber < NotificationsSubscriber
+        def metric_name(name, payload)
+          mailbox = payload[:mailbox].class.name
+          method = method_from_name(name)
+          "Ruby/ActionMailbox/#{mailbox}/#{method}"
+        end
+
+        PATTERN = /\A([^\.]*)\.action_mailbox\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/action_mailer.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_mailer_subscriber'
+
+DependencyDetection.defer do
+  named :action_mailer
+
+  depends_on do
+    !NewRelic::Agent.config[:disable_action_mailer]
+  end
+
+  depends_on do
+    defined?(ActiveSupport) &&
+      defined?(ActionMailer) &&
+      ActionMailer.respond_to?(:gem_version) &&
+      ActionMailer.gem_version >= Gem::Version.new('5.0') &&
+      !NewRelic::Agent::Instrumentation::ActionMailerSubscriber.subscribed?
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing ActionMailer instrumentation')
+  end
+
+  executes do
+    ActiveSupport::Notifications.subscribe(/\A(?:[^\.]+)\.action_mailer\z/,
+      NewRelic::Agent::Instrumentation::ActionMailerSubscriber.new)
+  end
+end

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

@@ -1,87 +1,111 @@
-# 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.
-require 'new_relic/agent/instrumentation/evented_subscriber'
+# 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'
 
 # Listen for ActiveSupport::Notifications events for ActionView render
 # events.  Write metric data and transaction trace nodes for each event.
 module NewRelic
   module Agent
     module Instrumentation
-      class ActionViewSubscriber < EventedSubscriber
+      class ActionViewSubscriber < NotificationsSubscriber
+        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])
 
-        def start(name, id, payload) #THREAD_LOCAL_ACCESS
-          event = RenderEvent.new(name, Time.now, nil, id, payload)
-          push_event(event)
-          if state.is_execution_traced? && event.recordable?
-            event.segment = NewRelic::Agent::Transaction.start_segment name: event.metric_name
+          if recordable?(name, metric_name)
+            event.finishable = Tracer.start_segment(name: metric_name)
           end
-        rescue => e
-          log_notification_error(e, name, 'start')
+          push_segment(id, event)
         end
 
-        def finish(name, id, payload) #THREAD_LOCAL_ACCESS
-          event = pop_event(id)
-          event.segment.finish if event.segment
-        rescue => e
-          log_notification_error(e, name, 'finish')
+        def finish_segment(id, payload)
+          if segment = pop_segment(id)
+            if exception = exception_object(payload)
+              segment.notice_error(exception)
+            end
+            segment.finish
+          end
         end
 
-        class RenderEvent < Event
-          attr_accessor :segment
-
-          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
-
-          # Nearly every "render_blah.action_view" event has a child
-          # in the form of "!render_blah.action_view".  The children
-          # are the ones we want to record.  There are a couple
-          # special cases of events without children.
-          def recordable?
-            name[0] == '!' ||
-              metric_name == 'View/text template/Rendering' ||
-              metric_name == "View/#{::NewRelic::Agent::UNKNOWN_METRIC}/Partial"
+        def format_metric_name(event_name, payload, parent)
+          return parent.name if parent \
+             && (payload[:virtual_path] \
+              || (parent.identifier =~ /template$/))
+
+          if payload.key?(:virtual_path)
+            identifier = payload[:virtual_path]
+          else
+            identifier = payload[:identifier]
           end
 
-          def metric_name
-            if parent && (payload[:virtual_path] ||
-                          (parent.payload[:identifier] =~ /template$/))
-              return parent.metric_name
-            elsif payload.key?(:virtual_path)
-              identifier = payload[:virtual_path]
-            else
-              identifier = payload[:identifier]
-            end
+          "View/#{metric_path(event_name, identifier)}/#{metric_action(event_name)}"
+        end
 
-            # memoize
-            @metric_name ||= "View/#{metric_path(name, identifier)}/#{metric_action(name)}"
-            @metric_name
-          end
+        # Nearly every "render_blah.action_view" event has a child
+        # in the form of "!render_blah.action_view".  The children
+        # are the ones we want to record.  There are a couple
+        # special cases of events without children.
+        def recordable?(event_name, metric_name)
+          event_name[0] == '!' \
+              || metric_name == 'View/text template/Rendering' \
+              || metric_name == "View/#{::NewRelic::Agent::UNKNOWN_METRIC}/Partial"
+        end
 
-          def metric_path(name, identifier)
-            # Rails 5 sets identifier to nil for empty collections,
-            # so do not mistake rendering a collection for rendering a file.
-            if identifier == nil && name != RENDER_COLLECTION_EVENT_NAME
-              'file'
-            elsif identifier =~ /template$/
-              identifier
-            elsif identifier && (parts = identifier.split('/')).size > 1
-              parts[-2..-1].join('/')
-            else
-              ::NewRelic::Agent::UNKNOWN_METRIC
-            end
+        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
 
-          def metric_action(name)
-            case name
-            when /#{RENDER_TEMPLATE_EVENT_NAME}$/ then 'Rendering'
-            when RENDER_PARTIAL_EVENT_NAME        then 'Partial'
-            when RENDER_COLLECTION_EVENT_NAME     then 'Partial'
-            end
+        def metric_path(name, identifier)
+          # Rails 5 sets identifier to nil for empty collections,
+          # so do not mistake rendering a collection for rendering a file.
+          if identifier.nil? && name != RENDER_COLLECTION_EVENT_NAME
+            'file'
+          elsif identifier =~ /template$/
+            identifier
+          elsif identifier && (parts = identifier.split('/')).size > 1
+            parts[-2..-1].join('/')
+          else
+            ::NewRelic::Agent::UNKNOWN_METRIC
           end
         end
       end
+
+      # This class holds state information between calls to `start`
+      # and `finish` for ActiveSupport events that we do not want to track
+      # as a transaction or segment.
+      class ActionViewEvent
+        attr_reader :name, :identifier
+        attr_accessor :finishable
+
+        def initialize(name, identifier)
+          @name = name
+          @identifier = identifier
+          @finishable = nil
+        end
+
+        def finish
+          @finishable.finish if @finishable
+        end
+
+        def notice_error(error)
+          @finishable.notice_error(error) if @finishable
+        end
+      end
     end
   end
 end

data/lib/new_relic/agent/instrumentation/active_job.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/prepend_supportability'
 
@@ -8,22 +8,35 @@ DependencyDetection.defer do
   named :activejob
 
   depends_on do
-    defined?(::ActiveJob::Base)
+    defined?(ActiveJob::Base)
   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|
-        ::NewRelic::Agent::Instrumentation::ActiveJobHelper.enqueue(job, block)
+      ActiveJob::Base.around_enqueue do |job, block|
+        NewRelic::Agent::Instrumentation::ActiveJobHelper.enqueue(job, block)
       end
 
-      ::ActiveJob::Base.around_perform do |job, block|
-        ::NewRelic::Agent::Instrumentation::ActiveJobHelper.perform(job, block)
+      ActiveJob::Base.around_perform do |job, block|
+        NewRelic::Agent::Instrumentation::ActiveJobHelper.perform(job, block)
       end
 
-      ::NewRelic::Agent::PrependSupportability.record_metrics_for(::ActiveJob::Base)
+      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
@@ -39,34 +52,40 @@ module NewRelic
         end
 
         def self.perform(job, block)
-          state = ::NewRelic::Agent::TransactionState.tl_get
+          state = ::NewRelic::Agent::Tracer.state
           txn = state.current_transaction
 
           # 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 && txn.recording_web_transaction?
             run_in_trace(job, block, :Consume)
           elsif txn && !txn.recording_web_transaction?
             ::NewRelic::Agent::Transaction.set_default_transaction_name(
               transaction_name_suffix_for_job(job),
-              transaction_category)
+              transaction_category
+            )
             block.call
           else
-            run_in_transaction(state, job, block)
+            run_in_transaction(job, block)
           end
         end
 
         def self.run_in_trace(job, block, event)
-          trace_execution_scoped("MessageBroker/#{adapter}/Queue/#{event}/Named/#{job.queue_name}") do
+          trace_execution_scoped("ActiveJob/#{adapter.sub(/^ActiveJob::/, '')}/Queue/#{event}/Named/#{job.queue_name}",
+            code_information: code_information_for_job(job)) do
             block.call
           end
         end
 
-        def self.run_in_transaction(state, job, block)
-          ::NewRelic::Agent::Transaction.wrap(state,
-                                              transaction_name_for_job(job),
-                                              :other,
-                                              &block)
+        def self.run_in_transaction(job, block)
+          options = code_information_for_job(job)
+          options = {} if options.frozen? # the hash will be added to later
+          ::NewRelic::Agent::Tracer.in_transaction(name: transaction_name_for_job(job),
+            category: :other, options: options, &block)
+        end
+
+        def self.code_information_for_job(job)
+          NewRelic::Agent::MethodTracerHelpers.code_information(job.class, :perform)
         end
 
         def self.transaction_category

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

@@ -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
 
 DependencyDetection.defer do
   @name = :active_merchant
@@ -12,7 +12,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing ActiveMerchant instrumentation'
+    NewRelic::Agent.logger.info('Installing ActiveMerchant instrumentation')
   end
 
   executes do
@@ -24,14 +24,28 @@ DependencyDetection.defer do
       gateway.class_eval do
         implemented_methods = public_instance_methods(false).map(&:to_sym)
         gateway_name = self.name.split('::').last
-        [:authorize, :purchase, :credit, :void, :capture, :recurring, :store, :unstore, :update].each do |operation|
+        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}"
-            add_method_tracer operation, "ActiveMerchant/gateway/#{gateway_name}", :push_scope => false
-            add_method_tracer operation, "ActiveMerchant/operation/#{operation}", :push_scope => false
+            add_method_tracer operation, [-> (*) { "ActiveMerchant/gateway/#{gateway_name}/#{operation}" },
+              -> (*) { "ActiveMerchant/gateway/#{gateway_name}" },
+              -> (*) { "ActiveMerchant/operation/#{operation}" }]
           end
         end
       end
     end
   end
+
+  executes do
+    next unless Gem::Version.new(ActiveMerchant::VERSION) < Gem::Version.new('1.65.0')
+
+    deprecation_msg = 'The Ruby Agent is dropping support for ActiveMerchant versions below 1.65.0 ' \
+      'in version 9.0.0. Please upgrade your ActiveMerchant version to continue receiving full support. ' \
+
+    NewRelic::Agent.logger.log_once(
+      :warn,
+      :deprecated_active_merchant_version,
+      deprecation_msg
+    )
+  end
 end