newrelic_rpm 6.15.0 → 8.13.1

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

@@ -1,11 +1,10 @@
-# 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/instrumentation/active_record_subscriber'
 require 'new_relic/agent/instrumentation/active_record_prepend'
 
-
 # Provides a way to send :connection through ActiveSupport notifications to avoid
 # looping through connection handlers to locate a connection by connection_id
 # This is not needed in Rails 6+: https://github.com/rails/rails/pull/34602
@@ -20,12 +19,13 @@ module NewRelic
           def log(sql, name = "SQL", binds = [], statement_name = nil)
             @instrumenter.instrument(
               SQL_ACTIVE_RECORD,
-              :sql            => sql,
-              :name           => name,
-              :connection_id  => object_id,
-              :connection     => self,
+              :sql => sql,
+              :name => name,
+              :connection_id => object_id,
+              :connection => self,
               :statement_name => statement_name,
-              :binds          => binds) { yield }
+              :binds => binds
+            ) { yield }
           rescue => e
             # The translate_exception_class method got introduced in 4.1
             if ::ActiveRecord::VERSION::MINOR == 0
@@ -41,13 +41,14 @@ module NewRelic
           def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil)
             @instrumenter.instrument(
               SQL_ACTIVE_RECORD,
-              sql:               sql,
-              name:              name,
-              binds:             binds,
+              sql: sql,
+              name: name,
+              binds: binds,
               type_casted_binds: type_casted_binds,
-              statement_name:    statement_name,
-              connection_id:     object_id,
-              connection:        self) { yield }
+              statement_name: statement_name,
+              connection_id: object_id,
+              connection: self
+            ) { yield }
           rescue => e
             raise translate_exception_class(e, sql)
           end
@@ -58,17 +59,18 @@ module NewRelic
           def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
             @instrumenter.instrument(
               SQL_ACTIVE_RECORD,
-              sql:               sql,
-              name:              name,
-              binds:             binds,
+              sql: sql,
+              name: name,
+              binds: binds,
               type_casted_binds: type_casted_binds,
-              statement_name:    statement_name,
-              connection_id:     object_id,
-              connection:        self) do
-                @lock.synchronize do
-                  yield
-                end
+              statement_name: statement_name,
+              connection_id: object_id,
+              connection: self
+            ) do
+              @lock.synchronize do
+                yield
               end
+            end
           rescue => e
             raise translate_exception_class(e, sql)
           end
@@ -92,24 +94,8 @@ DependencyDetection.defer do
       !NewRelic::Agent::Instrumentation::ActiveRecordSubscriber.subscribed?
   end
 
-
-  depends_on do
-    # If the deprecated :disable_active_record_4 setting is true, and
-    # the active record version is four, disable!
-    NewRelic::Agent.config[:disable_active_record_4] == false \
-        || ::ActiveRecord::VERSION::MAJOR.to_i != 4
-  end
-
-  depends_on do
-    # If the deprecated :disable_active_record_5 setting is true, and
-    # the active record version is five, disable!
-    NewRelic::Agent.config[:disable_active_record_5] == false \
-        || ::ActiveRecord::VERSION::MAJOR.to_i  != 5
-  end
-
-
   executes do
-    ::NewRelic::Agent.logger.info 'Installing notifications based Active Record instrumentation'
+    ::NewRelic::Agent.logger.info('Installing notifications based Active Record instrumentation')
   end
 
   executes do
@@ -120,8 +106,9 @@ DependencyDetection.defer do
   executes do
     ActiveSupport.on_load(:active_record) do
       ::NewRelic::Agent::PrependSupportability.record_metrics_for(
-          ::ActiveRecord::Base,
-          ::ActiveRecord::Relation)
+        ::ActiveRecord::Base,
+        ::ActiveRecord::Relation
+      )
 
       # Default to .prepending, unless the ActiveRecord version is <=4
       # **AND** the :prepend_active_record_instrumentation config is false
@@ -129,9 +116,9 @@ DependencyDetection.defer do
           || ::NewRelic::Agent.config[:prepend_active_record_instrumentation]
 
         ::ActiveRecord::Base.send(:prepend,
-            ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::BaseExtensions)
+          ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::BaseExtensions)
         ::ActiveRecord::Relation.send(:prepend,
-            ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::RelationExtensions)
+          ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::RelationExtensions)
       else
         ::NewRelic::Agent::Instrumentation::ActiveRecordHelper.instrument_additional_methods
       end
@@ -162,7 +149,7 @@ DependencyDetection.defer do
         && ::ActiveRecord::VERSION::MINOR.to_i == 1 \
         && ::ActiveRecord::VERSION::TINY.to_i >= 6
 
-      ::ActiveRecord::Base.prepend ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::BaseExtensions516
+      ::ActiveRecord::Base.prepend(::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::BaseExtensions516)
     end
   end
 end

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

@@ -1,6 +1,6 @@
-# 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/prepend_supportability'
 
@@ -11,13 +11,13 @@ module NewRelic
         ACTIVE_RECORD = 'ActiveRecord'.freeze
 
         module BaseExtensions
-
           if RUBY_VERSION < "2.7.0"
             def save(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
                 super
               end
             end
+
             def save!(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
                 super
@@ -30,11 +30,12 @@ module NewRelic
                 super
               end
             end
+
             def save!(*args, **kwargs, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
                 super
               end
-            end  
+            end
 
           end
         end
@@ -58,7 +59,6 @@ module NewRelic
               end
             end
           end
-
         end
 
         module RelationExtensions

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

@@ -1,6 +1,7 @@
-# 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/instrumentation/active_record_helper'
 require 'new_relic/agent/instrumentation/notifications_subscriber'
 
@@ -43,7 +44,7 @@ module NewRelic
           end
         end
 
-        def start(name, id, payload) #THREAD_LOCAL_ACCESS
+        def start(name, id, payload) # THREAD_LOCAL_ACCESS
           return if cached?(payload)
           return unless NewRelic::Agent.tl_is_execution_traced?
 
@@ -54,7 +55,7 @@ module NewRelic
           log_notification_error(e, name, 'start')
         end
 
-        def finish(name, id, payload) #THREAD_LOCAL_ACCESS
+        def finish(name, id, payload) # THREAD_LOCAL_ACCESS
           return if cached?(payload)
           return unless state.is_execution_traced?
 
@@ -64,7 +65,6 @@ module NewRelic
             end
             segment.finish
           end
-
         rescue => e
           log_notification_error(e, name, 'finish')
         end
@@ -72,20 +72,18 @@ module NewRelic
         def get_explain_plan(statement)
           connection = NewRelic::Agent::Database.get_connection(statement.config) do
             ::ActiveRecord::Base.send("#{statement.config[:adapter]}_connection",
-                                      statement.config)
+              statement.config)
           end
           if connection && connection.respond_to?(:exec_query)
             return connection.exec_query("EXPLAIN #{statement.sql}",
-                                         "Explain #{statement.name}",
-                                         statement.binds)
+              "Explain #{statement.name}",
+              statement.binds)
           end
         rescue => e
-          NewRelic::Agent.logger.debug "Couldn't fetch the explain plan for #{statement} due to #{e}"
+          NewRelic::Agent.logger.debug("Couldn't fetch the explain plan for #{statement} due to #{e}")
         end
 
         def active_record_config(payload)
-          return unless payload[:connection_id]
-
           # handle if the notification payload provides the AR connection
           # available in Rails 6+ & our ActiveRecordNotifications#log extension
           if payload[:connection]
@@ -93,22 +91,31 @@ module NewRelic
             return connection_config if connection_config
           end
 
-          connection = nil
-          connection_id = payload[:connection_id]
+          return unless connection_id = payload[:connection_id]
 
           ::ActiveRecord::Base.connection_handler.connection_pool_list.each do |handler|
-            connection = handler.connections.detect do |conn|
-              conn.object_id == connection_id
-            end
-
-            break if connection
+            connection = handler.connections.detect { |conn| conn.object_id == connection_id }
+            return connection.instance_variable_get(:@config) if connection
+
+            # when using makara, handler.connections will be empty, so use the
+            # spec config instead.
+            # https://github.com/newrelic/newrelic-ruby-agent/issues/507
+            # thank you @lucasklaassen
+            return handler.spec.config if use_spec_config?(handler)
           end
 
-          connection.instance_variable_get(:@config) if connection
+          nil
+        end
+
+        def use_spec_config?(handler)
+          handler.respond_to?(:spec) &&
+            handler.spec &&
+            handler.spec.config &&
+            handler.spec.config[:adapter].end_with?('makara')
         end
 
         def start_segment(config, payload)
-          sql = Helper.correctly_encoded payload[:sql]
+          sql = Helper.correctly_encoded(payload[:sql])
           product, operation, collection = ActiveRecordHelper.product_operation_collection_for(
             payload[:name],
             sql,
@@ -132,7 +139,7 @@ module NewRelic
             port_path_or_id: port_path_or_id,
             database_name: database)
 
-          segment._notice_sql sql, config, @explainer, payload[:binds], payload[:name]
+          segment._notice_sql(sql, config, @explainer, payload[:binds], payload[:name])
           segment
         end
       end

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

@@ -1,6 +1,6 @@
-# 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/instrumentation/active_storage_subscriber'
 
@@ -13,7 +13,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing ActiveStorage 5 instrumentation'
+    ::NewRelic::Agent.logger.info('Installing ActiveStorage instrumentation')
   end
 
   executes do

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

@@ -1,34 +1,37 @@
-# 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/instrumentation/notifications_subscriber'
 
 module NewRelic
   module Agent
     module Instrumentation
       class ActiveStorageSubscriber < NotificationsSubscriber
-        def start name, id, payload
+        def start(name, id, payload)
           return unless state.is_execution_traced?
-          start_segment name, id, payload
+
+          start_segment(name, id, payload)
         rescue => e
-          log_notification_error e, name, 'start'
+          log_notification_error(e, name, 'start')
         end
 
-        def finish name, id, payload
+        def finish(name, id, payload)
           return unless state.is_execution_traced?
-          finish_segment id, payload
+
+          finish_segment(id, payload)
         rescue => e
-          log_notification_error e, name, 'finish'
+          log_notification_error(e, name, 'finish')
         end
 
-        def start_segment name, id, payload
-          segment = Tracer.start_segment name: metric_name(name, payload)
+        def start_segment(name, id, payload)
+          segment = Tracer.start_segment(name: metric_name(name, payload))
           segment.params[:key] = payload[:key]
-          segment.params[:exist] = payload[:exist] if payload.key? :exist
-          push_segment id, segment
+          segment.params[:exist] = payload[:exist] if payload.key?(:exist)
+          push_segment(id, segment)
         end
 
-        def finish_segment id, payload
+        def finish_segment(id, payload)
           if segment = pop_segment(id)
             if exception = exception_object(payload)
               segment.notice_error(exception)
@@ -37,9 +40,9 @@ module NewRelic
           end
         end
 
-        def metric_name name, payload
+        def metric_name(name, payload)
           service = payload[:service]
-          method = method_from_name name
+          method = method_from_name(name)
           "Ruby/ActiveStorage/#{service}Service/#{method}"
         end
 
@@ -54,7 +57,7 @@ module NewRelic
           end
         end
 
-        def method_from_name name
+        def method_from_name(name)
           METHOD_NAME_MAPPING[name]
         end
       end

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

@@ -0,0 +1,23 @@
+# 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 ActiveSupportLogger
+    module Chain
+      def instrument!
+        ::ActiveSupport::Logger.module_eval do
+          include NewRelic::Agent::Instrumentation::ActiveSupportLogger
+          def broadcast_with_new_relic(logger)
+            broadcast_with_tracing(logger) {
+              broadcast_without_newrelic(logger)
+            }
+          end
+
+          alias broadcast_without_newrelic broadcast
+          alias broadcast broadcast_with_new_relic
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/active_support_logger/instrumentation.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
+  module Agent
+    module Instrumentation
+      module ActiveSupportLogger
+        # Mark @skip_instrumenting on any broadcasted loggers to instrument Rails.logger only
+        def broadcast_with_tracing(logger)
+          NewRelic::Agent::Instrumentation::Logger.mark_skip_instrumenting(logger)
+          yield
+        rescue => error
+          NewRelic::Agent.notice_error(error)
+          raise
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# 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 ActiveSupportLogger::Prepend
+    include NewRelic::Agent::Instrumentation::ActiveSupportLogger
+    def broadcast(logger)
+      broadcast_with_tracing(logger) { super }
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# 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 'active_support_logger/instrumentation'
+require_relative 'active_support_logger/chain'
+require_relative 'active_support_logger/prepend'
+
+DependencyDetection.defer do
+  named :active_support_logger
+
+  depends_on { defined?(::ActiveSupport::Logger) }
+
+  executes do
+    ::NewRelic::Agent.logger.info('Installing ActiveSupport::Logger instrumentation')
+
+    if use_prepend?
+      # the only method currently instrumented is a class method
+      prepend_instrument ::ActiveSupport::Logger.singleton_class, NewRelic::Agent::Instrumentation::ActiveSupportLogger::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::ActiveSupportLogger::Chain
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
-# 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/database'
 
@@ -8,17 +8,17 @@ module NewRelic
   module Instrumentation
     module ActsAsSolrInstrumentation
       module ParserMethodsInstrumentation
+        def parse_query_with_newrelic(*args)
+          self.class.trace_execution_scoped(["SolrClient/ActsAsSolr/query"]) do
+            begin
+              parse_query_without_newrelic(*args)
+            ensure
+              return unless txn = ::NewRelic::Agent::Tracer.current_transaction
 
-          def parse_query_with_newrelic(*args)
-            self.class.trace_execution_scoped(["SolrClient/ActsAsSolr/query"]) do
-              begin
-                parse_query_without_newrelic(*args)
-              ensure
-                return unless txn = ::NewRelic::Agent::Tracer.current_transaction
-                txn.current_segment.params[:statement] = ::NewRelic::Agent::Database.truncate_query(args.first.inspect) rescue nil
-              end
+              txn.current_segment.params[:statement] = ::NewRelic::Agent::Database.truncate_query(args.first.inspect) rescue nil
             end
           end
+        end
       end
     end
   end
@@ -44,7 +44,15 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing ActsAsSolr instrumentation'
+    ::NewRelic::Agent.logger.info('Installing ActsAsSolr instrumentation')
+    deprecation_msg = 'The instrumentation for ActsAsSolr is deprecated. ' \
+      'It will be removed in version 9.0.0.' \
+
+    ::NewRelic::Agent.logger.log_once(
+      :warn,
+      :deprecated_acts_as_solr,
+      deprecation_msg
+    )
   end
 
   executes do

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

@@ -1,6 +1,6 @@
-# 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
 
 DependencyDetection.defer do
   @name = :authlogic
@@ -12,7 +12,15 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing Authlogic instrumentation'
+    ::NewRelic::Agent.logger.info('Installing Authlogic instrumentation')
+    deprecation_msg = 'The instrumentation for Authlogic is deprecated. ' \
+      'It will be removed in version 9.0.0.' \
+
+    ::NewRelic::Agent.logger.log_once(
+      :warn,
+      :deprecated_authlogic,
+      deprecation_msg
+    )
   end
 
   executes do

data/lib/new_relic/agent/instrumentation/bunny/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 Bunny
+    def self.instrument!
+      ::Bunny::Exchange.class_eval do
+        include NewRelic::Agent::Instrumentation::Bunny::Exchange
+
+        alias_method(:publish_without_new_relic, :publish)
+
+        def publish(payload, opts = {})
+          publish_with_tracing(payload, opts) { publish_without_new_relic(payload, opts) }
+        end
+      end
+
+      ::Bunny::Queue.class_eval do
+        include NewRelic::Agent::Instrumentation::Bunny::Queue
+
+        alias_method(:pop_without_new_relic, :pop)
+
+        def pop(opts = {:manual_ack => false}, &block)
+          pop_with_tracing { pop_without_new_relic(opts, &block) }
+        end
+
+        alias_method(:purge_without_new_relic, :purge)
+
+        def purge(*args)
+          purge_with_tracing { purge_without_new_relic(*args) }
+        end
+      end
+
+      ::Bunny::Consumer.class_eval do
+        include NewRelic::Agent::Instrumentation::Bunny::Consumer
+
+        alias_method(:call_without_new_relic, :call)
+
+        def call(*args)
+          call_with_tracing(*args) { call_without_new_relic(*args) }
+        end
+      end
+    end
+  end
+end