newrelic_rpm 6.15.0 → 8.13.1

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

@@ -1,103 +1,87 @@
-# 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
 
-# NOTE there are multiple implementations of the MemCache client in Ruby,
-# each with slightly different API's and semantics.
+# NOTE: there are multiple implementations of the Memcached client in Ruby,
+# each with slightly different APIs and semantics.
 # See:
 #     http://www.deveiate.org/code/Ruby-MemCache/ (Gem: Ruby-MemCache)
 #     http://seattlerb.rubyforge.org/memcache-client/ (Gem: memcache-client)
 #     https://github.com/mperham/dalli (Gem: dalli)
 
-require 'new_relic/agent/datastores/metric_helper'
-require 'new_relic/agent/instrumentation/memcache/dalli'
+require_relative 'memcache/helper'
+require_relative 'memcache/instrumentation'
+require_relative 'memcache/dalli'
+require_relative 'memcache/chain'
+require_relative 'memcache/prepend'
 
-module NewRelic
-  module Agent
-    module Instrumentation
-      module Memcache
-        module_function
-
-        def enabled?
-          !::NewRelic::Agent.config[:disable_memcache_instrumentation]
-        end
-
-        METHODS = [:get, :get_multi, :set, :add, :incr, :decr, :delete, :replace, :append,
-                   :prepend, :cas, :single_get, :multi_get, :single_cas, :multi_cas]
-
-        def supported_methods_for(client_class, methods)
-          methods.select do |method_name|
-            client_class.method_defined?(method_name) || client_class.private_method_defined?(method_name)
-          end
-        end
-
-        def instrument_methods(client_class, requested_methods = METHODS)
-          supported_methods_for(client_class, requested_methods).each do |method_name|
+DependencyDetection.defer do
+  named :memcache_client
 
-            visibility = NewRelic::Helper.instance_method_visibility client_class, method_name
-            method_name_without = :"#{method_name}_without_newrelic_trace"
+  depends_on { defined? ::MemCache }
 
-            client_class.class_eval do
-              alias_method method_name_without, method_name
+  executes do
+    if use_prepend?
+      prepend_module = ::NewRelic::Agent::Instrumentation::Memcache::Prepend.client_prepender(::MemCache)
+      prepend_instrument ::MemCache, prepend_module, "MemcacheClient"
+    else
+      chain_instrument_target ::MemCache, ::NewRelic::Agent::Instrumentation::Memcache::Chain, "MemcacheClient"
+    end
+  end
+end
 
-              define_method method_name do |*args, &block|
-                segment = NewRelic::Agent::Tracer.start_datastore_segment(
-                  product: "Memcached",
-                  operation: method_name
-                )
-                begin
-                  NewRelic::Agent::Tracer.capture_segment_error segment do
-                    send method_name_without, *args, &block
-                  end
-                ensure
-                  if NewRelic::Agent.config[:capture_memcache_keys]
-                    segment.notice_nosql_statement "#{method_name} #{args.first.inspect}"
-                  end
-                  segment.finish if segment
-                end
-              end
+DependencyDetection.defer do
+  named :memcached
 
-              send visibility, method_name
-              send visibility, method_name_without
-            end
-          end
-        end
+  depends_on { defined? ::Memcached }
 
-      end
+  executes do
+    if use_prepend?
+      prepend_module = ::NewRelic::Agent::Instrumentation::Memcache::Prepend.client_prepender(::Memcached)
+      prepend_instrument ::Memcached, prepend_module, "Memcached"
+    else
+      chain_instrument_target ::Memcached, ::NewRelic::Agent::Instrumentation::Memcache::Chain, "Memcached"
     end
   end
 end
 
 DependencyDetection.defer do
-  named :memcache_client
+  named :dalli
+  configure_with :memcache
 
-  depends_on do
-    NewRelic::Agent::Instrumentation::Memcache.enabled?
-  end
-
-  depends_on do
-    defined?(::MemCache)
-  end
+  depends_on { defined? ::Dalli::Client }
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing Memcached instrumentation for memcache-client gem'
-    NewRelic::Agent::Instrumentation::Memcache.instrument_methods(::MemCache)
+    if use_prepend?
+      prepend_module = ::NewRelic::Agent::Instrumentation::Memcache::Prepend
+      prepend_module.dalli_prependers do |client_class, instrumenting_module|
+        prepend_instrument client_class, instrumenting_module, "MemcachedDalli"
+      end
+    else
+      chain_instrument ::NewRelic::Agent::Instrumentation::Memcache::Dalli
+    end
   end
 end
 
+# These CAS client methods are only optionally defined if users require
+# dalli/cas/client. Use a separate dependency block so it can potentially
+# re-evaluate after they've done that require.
 DependencyDetection.defer do
-  named :memcached
-
-  depends_on do
-    NewRelic::Agent::Instrumentation::Memcache.enabled?
-  end
+  named :dalli_cas_client
+  configure_with :memcache
 
-  depends_on do
-    defined?(::Memcached)
-  end
+  depends_on { defined? ::Dalli::Client }
+  depends_on { ::NewRelic::Agent::Instrumentation::Memcache::DalliCAS.should_instrument? }
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing Memcached instrumentation for memcached gem'
-    ::NewRelic::Agent::Instrumentation::Memcache.instrument_methods(::Memcached)
+    ::NewRelic::Agent.logger.info('Installing Dalli CAS Client Memcache instrumentation')
+    if use_prepend?
+      prepend_module = ::NewRelic::Agent::Instrumentation::Memcache::Prepend
+      prepend_module.dalli_cas_prependers do |client_class, instrumenting_module|
+        prepend_instrument client_class, instrumenting_module, "MemcachedDalliCAS"
+      end
+    else
+      chain_instrument ::NewRelic::Agent::Instrumentation::Memcache::DalliCAS
+    end
   end
 end

data/lib/new_relic/agent/instrumentation/middleware_proxy.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/method_tracer'
 require 'new_relic/agent/transaction'
@@ -15,7 +15,7 @@ module NewRelic
       class MiddlewareProxy
         include MiddlewareTracing
 
-        ANONYMOUS_CLASS   = "AnonymousClass".freeze
+        ANONYMOUS_CLASS = "AnonymousClass".freeze
         OBJECT_CLASS_NAME = "Object".freeze
 
         # This class is used to wrap classes that are passed to
@@ -31,6 +31,8 @@ module NewRelic
             middleware_instance = @middleware_class.new(*args, &blk)
             MiddlewareProxy.wrap(middleware_instance)
           end
+
+          ruby2_keywords(:new) if respond_to?(:ruby2_keywords, true)
         end
 
         def self.is_sinatra_app?(target)
@@ -48,7 +50,7 @@ module NewRelic
           )
         end
 
-        def self.wrap(target, is_app=false)
+        def self.wrap(target, is_app = false)
           if needs_wrapping?(target)
             self.new(target, is_app)
           else
@@ -58,13 +60,13 @@ module NewRelic
 
         attr_reader :target, :category, :transaction_options
 
-        def initialize(target, is_app=false)
-          @target            = target
-          @is_app            = is_app
-          @category          = determine_category
+        def initialize(target, is_app = false)
+          @target = target
+          @is_app = is_app
+          @category = determine_category
           @target_class_name = determine_class_name
-          @transaction_name  = "#{determine_prefix}#{@target_class_name}/call"
-          @transaction_options  = {
+          @transaction_name = "#{determine_prefix}#{@target_class_name}/call"
+          @transaction_options = {
             :transaction_name => @transaction_name
           }
         end
@@ -84,14 +86,14 @@ module NewRelic
         # In 'normal' usage, the target will be an application instance that
         # responds to #call. With Rails, however, the target may be a subclass
         # of Rails::Application that defines a method_missing that proxies #call
-        # to a singleton instance of the the subclass. We need to ensure that we
+        # to a singleton instance of the subclass. We need to ensure that we
         # capture the correct name in both cases.
         def determine_class_name
           clazz = class_for_target
 
           name = clazz.name
           name = clazz.superclass.name if name.nil? || name == ""
-          name = ANONYMOUS_CLASS       if name.nil? || name == OBJECT_CLASS_NAME
+          name = ANONYMOUS_CLASS if name.nil? || name == OBJECT_CLASS_NAME
           name
         end
 
@@ -102,7 +104,6 @@ module NewRelic
             @target.class
           end
         end
-
       end
     end
   end

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

@@ -1,4 +1,3 @@
-# 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
@@ -27,10 +26,9 @@ module NewRelic
   module Agent
     module Instrumentation
       module MiddlewareTracing
-
         TXN_STARTED_KEY = 'newrelic.transaction_started'
-        CONTENT_TYPE    = 'Content-Type'
-        CONTENT_LENGTH  = 'Content-Length'
+        CONTENT_TYPE = 'Content-Type'
+        CONTENT_LENGTH = 'Content-Length'
 
         def _nr_has_middleware_tracing
           true
@@ -46,7 +44,7 @@ module NewRelic
           opts[:apdex_start_time] = QueueTime.parse_frontend_timestamp(env)
           # this case is for the rare occasion that an app is using Puma::Rack
           # without having ::Rack as a dependency
-          opts[:request] = ::Rack::Request.new(env) if defined? ::Rack
+          opts[:request] = ::Rack::Request.new(env.dup) if defined? ::Rack
           opts
         end
 
@@ -71,7 +69,7 @@ module NewRelic
           if result.is_a?(Array) && state.current_transaction
             _, headers, _ = result
             length = headers[CONTENT_LENGTH]
-            length = length.reduce(0){|sum, h| sum + h.to_i} if length.is_a?(Array)
+            length = length.reduce(0) { |sum, h| sum + h.to_i } if length.is_a?(Array)
             state.current_transaction.response_content_length = length
           end
         end
@@ -98,7 +96,7 @@ module NewRelic
 
             events.notify(:before_call, env) if first_middleware
 
-            result = (target == self) ? traced_call(env) : target.call(env)
+            result = target == self ? traced_call(env) : target.call(env)
 
             if first_middleware
               capture_response_attributes(state, result)

data/lib/new_relic/agent/instrumentation/mongo.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
   named :mongo
@@ -11,19 +11,15 @@ DependencyDetection.defer do
 
   depends_on do
     require 'new_relic/agent/datastores/mongo'
-    if NewRelic::Agent::Datastores::Mongo.is_unsupported_2x?
-      NewRelic::Agent.logger.log_once(:info, :mongo2, 'Detected unsupported Mongo 2, upgrade your Mongo Driver to 2.1 or newer for instrumentation')
+    unless NewRelic::Agent::Datastores::Mongo.is_supported_version?
+      NewRelic::Agent.logger.log_once(:warn, :mongo2, 'Detected unsupported Mongo 2, upgrade your Mongo Driver to 2.1 or newer for instrumentation')
     end
     NewRelic::Agent::Datastores::Mongo.is_supported_version?
   end
 
   executes do
-    NewRelic::Agent.logger.info 'Installing Mongo instrumentation'
-    if NewRelic::Agent::Datastores::Mongo.is_monitoring_enabled?
-      install_mongo_command_subscriber
-    else
-      install_mongo_instrumentation
-    end
+    NewRelic::Agent.logger.info('Installing Mongo instrumentation')
+    install_mongo_command_subscriber
   end
 
   def install_mongo_command_subscriber
@@ -33,131 +29,4 @@ DependencyDetection.defer do
       NewRelic::Agent::Instrumentation::MongodbCommandSubscriber.new
     )
   end
-
-  def install_mongo_instrumentation
-    require 'new_relic/agent/datastores/mongo/metric_translator'
-    require 'new_relic/agent/datastores/mongo/statement_formatter'
-
-    hook_instrument_methods
-    instrument_save
-    instrument_ensure_index
-  end
-
-  def hook_instrument_methods
-    hook_instrument_method(::Mongo::Collection)
-    hook_instrument_method(::Mongo::Connection)
-    hook_instrument_method(::Mongo::Cursor)
-    hook_instrument_method(::Mongo::CollectionWriter) if defined?(::Mongo::CollectionWriter)
-  end
-
-  def hook_instrument_method(target_class)
-    target_class.class_eval do
-      include NewRelic::Agent::MethodTracer
-
-      # It's key that this method eats all exceptions, as it rests between the
-      # Mongo operation the user called and us returning them the data. Be safe!
-      def new_relic_notice_statement(segment, payload, name)
-        statement = NewRelic::Agent::Datastores::Mongo::StatementFormatter.format(payload, name)
-        if statement
-          segment.notice_nosql_statement statement
-        end
-      rescue => e
-        NewRelic::Agent.logger.debug("Exception during Mongo statement gathering", e)
-      end
-
-      def new_relic_default_payload
-        { :collection => self.name, :database => self.db.name }
-      end
-
-      def new_relic_start_segment name, payload
-        product = NewRelic::Agent::Datastores::Mongo::MetricTranslator::MONGO_PRODUCT_NAME
-        op_and_col = NewRelic::Agent::Datastores::Mongo::MetricTranslator.operation_and_collection_for name, payload
-        if op_and_col
-          operation, collection = op_and_col
-          NewRelic::Agent::Tracer.start_datastore_segment(
-            product: product,
-            operation: operation,
-            collection: collection
-          )
-        end
-      end
-
-      def instrument_with_new_relic_trace(name, payload = {}, &block)
-        segment = new_relic_start_segment name, payload
-
-        begin
-          result = NewRelic::Agent.disable_all_tracing do
-            NewRelic::Agent::Tracer.capture_segment_error segment do
-              instrument_without_new_relic_trace(name, payload, &block)
-            end
-          end
-
-          new_relic_notice_statement(segment, payload, name) if segment
-          result
-        ensure
-          segment.finish if segment
-        end
-      end
-
-      alias_method :instrument_without_new_relic_trace, :instrument
-      alias_method :instrument, :instrument_with_new_relic_trace
-    end
-  end
-
-  def instrument_save
-    ::Mongo::Collection.class_eval do
-      def save_with_new_relic_trace(doc, opts = {}, &block)
-        segment = new_relic_start_segment :save, new_relic_default_payload
-
-        begin
-          result = NewRelic::Agent.disable_all_tracing do
-            NewRelic::Agent::Tracer.capture_segment_error segment do
-              save_without_new_relic_trace(doc, opts, &block)
-            end
-          end
-
-          new_relic_notice_statement(segment, doc, :save) if segment
-          result
-        ensure
-          segment.finish if segment
-        end
-      end
-
-      alias_method :save_without_new_relic_trace, :save
-      alias_method :save, :save_with_new_relic_trace
-    end
-  end
-
-  def instrument_ensure_index
-    ::Mongo::Collection.class_eval do
-      def ensure_index_with_new_relic_trace(spec, opts = {}, &block)
-        segment = new_relic_start_segment :ensureIndex, new_relic_default_payload
-
-        begin
-          result = NewRelic::Agent.disable_all_tracing do
-            NewRelic::Agent::Tracer.capture_segment_error segment do
-              ensure_index_without_new_relic_trace(spec, opts, &block)
-            end
-          end
-
-          spec = case spec
-                 when Array
-                   Hash[spec]
-                 when String, Symbol
-                   { spec => 1 }
-                 else
-                   spec.dup
-                 end
-
-          new_relic_notice_statement(segment, spec, :ensureIndex) if segment
-          result
-        ensure
-          segment.finish if segment
-        end
-      end
-
-      alias_method :ensure_index_without_new_relic_trace, :ensure_index
-      alias_method :ensure_index, :ensure_index_with_new_relic_trace
-    end
-  end
 end

data/lib/new_relic/agent/instrumentation/mongodb_command_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/datastores/mongo/event_formatter'
 
 module NewRelic
@@ -13,17 +14,18 @@ module NewRelic
         def started(event)
           begin
             return unless NewRelic::Agent::Tracer.tracing_enabled?
-            segments[event.operation_id] = start_segment event
+
+            segments[event.operation_id] = start_segment(event)
           rescue Exception => e
             log_notification_error('started', e)
           end
         end
 
-        ERROR_KEYS = %w{ writeErrors writeConcernError writeConcernErrors }.freeze
+        ERROR_KEYS = %w[ writeErrors writeConcernError writeConcernErrors ].freeze
 
         def error_key_present?(event)
           if reply = event.reply
-            ERROR_KEYS.detect{ |key| reply[key] }
+            ERROR_KEYS.detect { |key| reply[key] }
           end
         rescue
           false
@@ -32,20 +34,21 @@ module NewRelic
         def completed(event)
           begin
             return unless NewRelic::Agent::Tracer.tracing_enabled?
+
             segment = segments.delete(event.operation_id)
             return unless segment
 
-            # operations that succeed but have errors return CommandSucceeded 
-            # with an error_key that is populated with error specfics
+            # operations that succeed but have errors return CommandSucceeded
+            # with an error_key that is populated with error specifics
             if error_key = error_key_present?(event)
               # taking the last error as there can potentially be many
               attributes = event.reply[error_key][-1]
-              segment.notice_error Mongo::Error.new("%s (%s)" % [attributes["errmsg"], attributes["code"]])
+              segment.notice_error(Mongo::Error.new("%s (%s)" % [attributes["errmsg"], attributes["code"]]))
 
             # failing commands return a CommandFailed event with an error message
             # in the form of "% (%s)" for the message and code
-            elsif event.is_a? Mongo::Monitoring::Event::CommandFailed
-              segment.notice_error Mongo::Error.new(event.message)
+            elsif event.is_a?(Mongo::Monitoring::Event::CommandFailed)
+              segment.notice_error(Mongo::Error.new(event.message))
             end
             segment.finish
           rescue Exception => e
@@ -58,9 +61,9 @@ module NewRelic
 
         private
 
-        def start_segment event
-          host = host_from_address event.address
-          port_path_or_id = port_path_or_id_from_address event.address
+        def start_segment(event)
+          host = host_from_address(event.address)
+          port_path_or_id = port_path_or_id_from_address(event.address)
           segment = NewRelic::Agent::Tracer.start_datastore_segment(
             product: MONGODB,
             operation: operation(event.command_name),
@@ -76,7 +79,7 @@ module NewRelic
         def operation(command_name)
           # from 2.0 to 2.5, :findandmodify was the command_name
           if command_name == :findandmodify
-            :findAndModify 
+            :findAndModify
           else
             command_name
           end
@@ -107,31 +110,31 @@ module NewRelic
         LOCALHOST = "localhost".freeze
 
         def host_from_address(address)
-          if unix_domain_socket? address.host
+          if unix_domain_socket?(address.host)
             LOCALHOST
           else
             address.host
           end
         rescue => e
-          NewRelic::Agent.logger.debug "Failed to retrieve Mongo host: #{e}"
+          NewRelic::Agent.logger.debug("Failed to retrieve Mongo host: #{e}")
           UNKNOWN
         end
 
         def port_path_or_id_from_address(address)
-          if unix_domain_socket? address.host
+          if unix_domain_socket?(address.host)
             address.host
           else
             address.port
           end
         rescue => e
-          NewRelic::Agent.logger.debug "Failed to retrieve Mongo port_path_or_id: #{e}"
+          NewRelic::Agent.logger.debug("Failed to retrieve Mongo port_path_or_id: #{e}")
           UNKNOWN
         end
 
         SLASH = "/".freeze
 
         def unix_domain_socket?(host)
-          host.start_with? SLASH
+          host.start_with?(SLASH)
         end
       end
     end

data/lib/new_relic/agent/instrumentation/net_http/chain.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 'instrumentation'
+
+module NewRelic::Agent::Instrumentation
+  module NetHTTP
+    module Chain
+      def self.instrument!
+        Net::HTTP.class_eval do
+          include NewRelic::Agent::Instrumentation::NetHTTP
+
+          def request_with_newrelic_trace(request, *args, &block)
+            request_with_tracing(request) { request_without_newrelic_trace(request, *args, &block) }
+          end
+
+          alias request_without_newrelic_trace request
+          alias request request_with_newrelic_trace
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/{net_prepend.rb → net_http/instrumentation.rb}

@@ -1,12 +1,12 @@
-# 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
 
-module NewRelic 
-  module Agent 
+module NewRelic
+  module Agent
     module Instrumentation
-      module NetPrepend
-        def request(request, *args, &block)
+      module NetHTTP
+        def request_with_tracing(request)
           wrapped_request = NewRelic::Agent::HTTPClients::NetHTTPRequest.new(self, request)
 
           segment = NewRelic::Agent::Tracer.start_external_request_segment(
@@ -14,21 +14,21 @@ module NewRelic
             uri: wrapped_request.uri,
             procedure: wrapped_request.method
           )
-  
+
           begin
             response = nil
-            segment.add_request_headers wrapped_request
-  
+            segment.add_request_headers(wrapped_request)
+
             # RUBY-1244 Disable further tracing in request to avoid double
             # counting if connection wasn't started (which calls request again).
             NewRelic::Agent.disable_all_tracing do
-              response = NewRelic::Agent::Tracer.capture_segment_error segment do
-                super
+              response = NewRelic::Agent::Tracer.capture_segment_error(segment) do
+                yield
               end
             end
-  
-            wrapped_response = NewRelic::Agent::HTTPClients::NetHTTPResponse.new response
-            segment.process_response_headers wrapped_response
+
+            wrapped_response = NewRelic::Agent::HTTPClients::NetHTTPResponse.new(response)
+            segment.process_response_headers(wrapped_response)
             response
           ensure
             segment.finish

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

@@ -0,0 +1,21 @@
+# 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 'instrumentation'
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module NetHTTP
+        module Prepend
+          include NewRelic::Agent::Instrumentation::NetHTTP
+
+          def request(request, *args, &block)
+            request_with_tracing(request) { super }
+          end
+        end
+      end
+    end
+  end
+end