newrelic_rpm 6.8.0.360 → 8.13.1

data/lib/new_relic/agent/instrumentation/active_record.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/active_record_prepend'
 
@@ -11,7 +11,7 @@ module NewRelic
         EXPLAINER = lambda do |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?(:execute)
             return connection.execute("EXPLAIN #{statement.sql}")
@@ -21,8 +21,8 @@ module NewRelic
         def self.insert_instrumentation
           if defined?(::ActiveRecord::VERSION::MAJOR) && ::ActiveRecord::VERSION::MAJOR.to_i >= 3
             if ::NewRelic::Agent.config[:prepend_active_record_instrumentation]
-              ::ActiveRecord::Base.prepend ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::BaseExtensions
-              ::ActiveRecord::Relation.prepend ::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::RelationExtensions
+              ::ActiveRecord::Base.prepend(::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::BaseExtensions)
+              ::ActiveRecord::Relation.prepend(::NewRelic::Agent::Instrumentation::ActiveRecordPrepend::RelationExtensions)
             else
               ::NewRelic::Agent::Instrumentation::ActiveRecordHelper.instrument_additional_methods
             end
@@ -36,51 +36,100 @@ module NewRelic
         def self.included(instrumented_class)
           instrumented_class.class_eval do
             unless instrumented_class.method_defined?(:log_without_newrelic_instrumentation)
-              alias_method :log_without_newrelic_instrumentation, :log
-              alias_method :log, :log_with_newrelic_instrumentation
-              protected :log
+              alias_method(:log_without_newrelic_instrumentation, :log)
+              alias_method(:log, :log_with_newrelic_instrumentation)
+              protected(:log)
             end
           end
         end
 
-        def log_with_newrelic_instrumentation(*args, &block) #THREAD_LOCAL_ACCESS
-          state = NewRelic::Agent::Tracer.state
+        if RUBY_VERSION < "2.7.0"
+          def log_with_newrelic_instrumentation(*args, &block)
+            state = NewRelic::Agent::Tracer.state
 
-          if !state.is_execution_traced?
-            return log_without_newrelic_instrumentation(*args, &block)
-          end
+            if !state.is_execution_traced?
+              return log_without_newrelic_instrumentation(*args, &block)
+            end
 
-          sql, name, _ = args
+            sql, name, _ = args
 
-          product, operation, collection = ActiveRecordHelper.product_operation_collection_for(
-            NewRelic::Helper.correctly_encoded(name),
-            NewRelic::Helper.correctly_encoded(sql),
-            @config && @config[:adapter])
+            product, operation, collection = ActiveRecordHelper.product_operation_collection_for(
+              NewRelic::Helper.correctly_encoded(name),
+              NewRelic::Helper.correctly_encoded(sql),
+              @config && @config[:adapter]
+            )
 
-          host = nil
-          port_path_or_id = nil
-          database = nil
+            host = nil
+            port_path_or_id = nil
+            database = nil
+
+            if ActiveRecordHelper::InstanceIdentification.supported_adapter?(@config)
+              host = ActiveRecordHelper::InstanceIdentification.host(@config)
+              port_path_or_id = ActiveRecordHelper::InstanceIdentification.port_path_or_id(@config)
+              database = @config && @config[:database]
+            end
 
-          if ActiveRecordHelper::InstanceIdentification.supported_adapter?(@config)
-            host = ActiveRecordHelper::InstanceIdentification.host(@config)
-            port_path_or_id = ActiveRecordHelper::InstanceIdentification.port_path_or_id(@config)
-            database = @config && @config[:database]
+            segment = NewRelic::Agent::Tracer.start_datastore_segment(
+              product: product,
+              operation: operation,
+              collection: collection,
+              host: host,
+              port_path_or_id: port_path_or_id,
+              database_name: database
+            )
+            segment._notice_sql(sql, @config, EXPLAINER)
+
+            begin
+              NewRelic::Agent::Tracer.capture_segment_error(segment) do
+                log_without_newrelic_instrumentation(*args, &block)
+              end
+            ensure
+              segment.finish if segment
+            end
           end
+        else
+          def log_with_newrelic_instrumentation(*args, **kwargs, &block)
+            state = NewRelic::Agent::Tracer.state
+
+            if !state.is_execution_traced?
+              return log_without_newrelic_instrumentation(*args, **kwargs, &block)
+            end
 
-          segment = NewRelic::Agent::Tracer.start_datastore_segment(
-            product: product,
-            operation: operation,
-            collection: collection,
-            host: host,
-            port_path_or_id: port_path_or_id,
-            database_name: database
-          )
-          segment._notice_sql(sql, @config, EXPLAINER)
-
-          begin
-            log_without_newrelic_instrumentation(*args, &block)
-          ensure
-            segment.finish if segment
+            sql, name, _ = args
+
+            product, operation, collection = ActiveRecordHelper.product_operation_collection_for(
+              NewRelic::Helper.correctly_encoded(name),
+              NewRelic::Helper.correctly_encoded(sql),
+              @config && @config[:adapter]
+            )
+
+            host = nil
+            port_path_or_id = nil
+            database = nil
+
+            if ActiveRecordHelper::InstanceIdentification.supported_adapter?(@config)
+              host = ActiveRecordHelper::InstanceIdentification.host(@config)
+              port_path_or_id = ActiveRecordHelper::InstanceIdentification.port_path_or_id(@config)
+              database = @config && @config[:database]
+            end
+
+            segment = NewRelic::Agent::Tracer.start_datastore_segment(
+              product: product,
+              operation: operation,
+              collection: collection,
+              host: host,
+              port_path_or_id: port_path_or_id,
+              database_name: database
+            )
+            segment._notice_sql(sql, @config, EXPLAINER)
+
+            begin
+              NewRelic::Agent::Tracer.capture_segment_error(segment) do
+                log_without_newrelic_instrumentation(*args, **kwargs, &block)
+              end
+            ensure
+              segment.finish if segment
+            end
           end
         end
       end
@@ -102,7 +151,7 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing ActiveRecord instrumentation'
+    ::NewRelic::Agent.logger.info('Installing ActiveRecord instrumentation')
   end
 
   executes do

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

@@ -1,8 +1,9 @@
-# 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/datastores/metric_helper'
+require 'new_relic/constants'
 
 module NewRelic
   module Agent
@@ -18,7 +19,7 @@ module NewRelic
 
         def instrument_save_methods
           ::ActiveRecord::Base.class_eval do
-            alias_method :save_without_newrelic, :save
+            alias_method(:save_without_newrelic, :save)
 
             def save(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
@@ -26,7 +27,7 @@ module NewRelic
               end
             end
 
-            alias_method :save_without_newrelic!, :save!
+            alias_method(:save_without_newrelic!, :save!)
 
             def save!(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
@@ -38,7 +39,7 @@ module NewRelic
 
         def instrument_relation_methods
           ::ActiveRecord::Relation.class_eval do
-            alias_method :update_all_without_newrelic, :update_all
+            alias_method(:update_all_without_newrelic, :update_all)
 
             def update_all(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
@@ -46,15 +47,23 @@ module NewRelic
               end
             end
 
-            alias_method :delete_all_without_newrelic, :delete_all
+            alias_method(:delete_all_without_newrelic, :delete_all)
 
-            def delete_all(*args, &blk)
-              ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
-                delete_all_without_newrelic(*args, &blk)
+            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)
+                end
+              end
+            else
+              def delete_all(*args, **kwargs, &blk)
+                ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
+                  delete_all_without_newrelic(*args, **kwargs, &blk)
+                end
               end
             end
 
-            alias_method :destroy_all_without_newrelic, :destroy_all
+            alias_method(:destroy_all_without_newrelic, :destroy_all)
 
             def destroy_all(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
@@ -62,7 +71,7 @@ module NewRelic
               end
             end
 
-            alias_method :calculate_without_newrelic, :calculate
+            alias_method(:calculate_without_newrelic, :calculate)
 
             def calculate(*args, &blk)
               ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
@@ -71,44 +80,54 @@ module NewRelic
             end
 
             if method_defined?(:pluck)
-              alias_method :pluck_without_newrelic, :pluck
+              alias_method(:pluck_without_newrelic, :pluck)
 
               def pluck(*args, &blk)
                 ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
                   pluck_without_newrelic(*args, &blk)
                 end
               end
+
             end
           end
         end
 
         ACTIVE_RECORD = "ActiveRecord".freeze
-        OTHER         = "other".freeze
+        OTHER = "other".freeze
+        MAKARA_SUFFIX = "_makara".freeze
+
+        # convert vendor (makara, etc.) wrapper names to their bare names
+        # ex: postgresql_makara -> postgresql
+        def bare_adapter_name(adapter_name)
+          # 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)
+
+          adapter_name
+        end
 
-        def product_operation_collection_for name, sql, adapter_name
-          product   = map_product(adapter_name)
-          splits    = split_name(name)
-          model     = model_from_splits(splits)
+        def product_operation_collection_for(name, sql, adapter_name)
+          product = map_product(bare_adapter_name(adapter_name))
+          splits = split_name(name)
+          model = model_from_splits(splits)
           operation = operation_from_splits(splits, sql)
-          NewRelic::Agent::Datastores::MetricHelper.product_operation_collection_for product, operation, model, ACTIVE_RECORD
+          NewRelic::Agent::Datastores::MetricHelper.product_operation_collection_for(product, operation, model, ACTIVE_RECORD)
         end
 
         SPACE = ' '.freeze
-        EMPTY = [].freeze
 
         def split_name(name)
           if name && name.respond_to?(:split)
             name.split(SPACE)
           else
-            EMPTY
+            NewRelic::EMPTY_ARRAY
           end
         end
 
         def model_from_splits(splits)
           if splits.length == 2
             splits.first
-          else
-            nil
           end
         end
 
@@ -124,16 +143,16 @@ module NewRelic
         # known operations coming in. Anything not matching the list is fine,
         # it just needs to get downcased directly for use.
         OPERATION_NAMES = {
-          'Find'    => 'find',
-          'Load'    => 'find',
-          'Count'   => 'find',
-          'Exists'  => 'find',
-          'Create'  => 'create',
+          'Find' => 'find',
+          'Load' => 'find',
+          'Count' => 'find',
+          'Exists' => 'find',
+          'Create' => 'create',
           'Columns' => 'columns',
           'Indexes' => 'indexes',
           'Destroy' => 'destroy',
-          'Update'  => 'update',
-          'Save'    => 'save'
+          'Update' => 'update',
+          'Save' => 'save'
         }.freeze
 
         def map_operation(raw_operation)
@@ -144,41 +163,41 @@ module NewRelic
         end
 
         PRODUCT_NAMES = {
-          "mysql"      => "MySQL",
-          "mysql2"     => "MySQL",
+          "mysql" => "MySQL",
+          "mysql2" => "MySQL",
 
           "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",
-          
+
           # 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"
@@ -187,25 +206,24 @@ module NewRelic
         ACTIVE_RECORD_DEFAULT_PRODUCT_NAME = "ActiveRecord".freeze
 
         def map_product(adapter_name)
-          PRODUCT_NAMES.fetch(adapter_name,
-                              ACTIVE_RECORD_DEFAULT_PRODUCT_NAME)
+          PRODUCT_NAMES.fetch(adapter_name, ACTIVE_RECORD_DEFAULT_PRODUCT_NAME)
         end
 
         module InstanceIdentification
           extend self
 
           PRODUCT_SYMBOLS = {
-            "mysql"      => :mysql,
-            "mysql2"     => :mysql,
-            "jdbcmysql"  => :mysql,
+            "mysql" => :mysql,
+            "mysql2" => :mysql,
+            "jdbcmysql" => :mysql,
 
-            "postgresql"     => :postgres,
+            "postgresql" => :postgres,
             "jdbcpostgresql" => :postgres,
-            "postgis"        => :postgres
+            "postgis" => :postgres
           }.freeze
 
           DATASTORE_DEFAULT_PORTS = {
-            :mysql    => "3306",
+            :mysql => "3306",
             :postgres => "5432"
           }.freeze
 
@@ -214,13 +232,18 @@ module NewRelic
           SLASH = "/".freeze
           LOCALHOST = "localhost".freeze
 
+          def adapter_from_config(config)
+            bare_name = NewRelic::Agent::Instrumentation::ActiveRecordHelper.bare_adapter_name(config[:adapter])
+            PRODUCT_SYMBOLS[bare_name]
+          end
+
           def host(config)
             return UNKNOWN unless config
 
-            configured_value  = config[:host]
-            adapter = PRODUCT_SYMBOLS[config[:adapter]]
+            configured_value = config[:host]
+            adapter = adapter_from_config(config)
             if configured_value.nil? ||
-              postgres_unix_domain_socket_case?(configured_value, adapter)
+                postgres_unix_domain_socket_case?(configured_value, adapter)
 
               LOCALHOST
             elsif configured_value.empty?
@@ -228,16 +251,15 @@ module NewRelic
             else
               configured_value
             end
-
           rescue => e
-            NewRelic::Agent.logger.debug "Failed to retrieve ActiveRecord host: #{e}"
+            NewRelic::Agent.logger.debug("Failed to retrieve ActiveRecord host: #{e}")
             UNKNOWN
           end
 
           def port_path_or_id(config)
             return UNKNOWN unless config
 
-            adapter = PRODUCT_SYMBOLS[config[:adapter]]
+            adapter = adapter_from_config(config)
             if config[:socket]
               config[:socket].empty? ? UNKNOWN : config[:socket]
             elsif postgres_unix_domain_socket_case?(config[:host], adapter) || mysql_default_case?(config, adapter)
@@ -249,16 +271,15 @@ module NewRelic
             else
               UNKNOWN
             end
-
           rescue => e
-            NewRelic::Agent.logger.debug "Failed to retrieve ActiveRecord port_path_or_id: #{e}"
+            NewRelic::Agent.logger.debug("Failed to retrieve ActiveRecord port_path_or_id: #{e}")
             UNKNOWN
           end
 
           SUPPORTED_ADAPTERS = [:mysql, :postgres].freeze
 
-          def supported_adapter? config
-            config && SUPPORTED_ADAPTERS.include?(PRODUCT_SYMBOLS[config[:adapter]])
+          def supported_adapter?(config)
+            config && SUPPORTED_ADAPTERS.include?(adapter_from_config(config))
           end
 
           private

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/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/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