newrelic_rpm 6.15.0 → 9.7.1

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
@@ -8,22 +9,23 @@ module NewRelic
     module Instrumentation
       class MongodbCommandSubscriber
         MONGODB = 'MongoDB'.freeze
-        COLLECTION = "collection".freeze
+        COLLECTION = 'collection'.freeze
 
         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
@@ -103,35 +106,33 @@ module NewRelic
           )
         end
 
-        UNKNOWN = "unknown".freeze
-        LOCALHOST = "localhost".freeze
+        UNKNOWN = 'unknown'.freeze
+        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?(NewRelic::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,16 @@
-# 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
+        INSTRUMENTATION_NAME = NewRelic::Agent.base_name(name)
+
+        def request_with_tracing(request)
+          NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
           wrapped_request = NewRelic::Agent::HTTPClients::NetHTTPRequest.new(self, request)
 
           segment = NewRelic::Agent::Tracer.start_external_request_segment(
@@ -14,24 +18,24 @@ 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
+            segment&.finish
           end
         end
       end

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

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

@@ -0,0 +1,44 @@
+# 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 'net_http/chain'
+require_relative 'net_http/prepend'
+
+DependencyDetection.defer do
+  named :net_http
+
+  depends_on do
+    defined?(Net) && defined?(Net::HTTP)
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing Net:HTTP Wrappers')
+    require 'new_relic/agent/http_clients/net_http_wrappers'
+  end
+
+  # Airbrake uses method chaining on Net::HTTP in versions < 10.0.2 (10.0.2 updated to prepend for Net:HTTP)
+  conflicts_with_prepend do
+    defined?(Airbrake) && defined?(Airbrake::AIRBRAKE_VERSION) && Gem::Version.create(Airbrake::AIRBRAKE_VERSION) < Gem::Version.create('10.0.2')
+  end
+
+  conflicts_with_prepend do
+    defined?(ScoutApm)
+  end
+
+  conflicts_with_prepend do
+    defined?(Rack::MiniProfiler) && !defined?(Rack::MINI_PROFILER_PREPEND_NET_HTTP_PATCH)
+  end
+
+  conflicts_with_prepend do
+    source_location_for(Net::HTTP, 'request') =~ /airbrake|profiler/i
+  end
+
+  executes do
+    if use_prepend?
+      prepend_instrument Net::HTTP, NewRelic::Agent::Instrumentation::NetHTTP::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::NetHTTP::Chain
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/notifications_subscriber.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
 
 module NewRelic
   module Agent
@@ -12,7 +12,7 @@ module NewRelic
         end
 
         def self.subscribed?
-          find_all_subscribers.find{|s| s.instance_variable_get(:@delegate).class == self }
+          find_all_subscribers.find { |s| s.instance_variable_get(:@delegate).class == self }
         end
 
         def self.find_all_subscribers
@@ -26,11 +26,11 @@ module NewRelic
           instance_variable_names.each do |name|
             if notifier.instance_variable_defined?(name)
               subscribers = notifier.instance_variable_get(name)
-              if subscribers.is_a? Array
+              if subscribers.is_a?(Array)
                 # Rails 5 @subscribers, and Rails 6 @other_subscribers is a
                 # plain array of subscriber objects
                 all_subscribers += subscribers
-              elsif subscribers.is_a? Hash
+              elsif subscribers.is_a?(Hash)
                 # Rails 6 @string_subscribers is a Hash mapping the pattern
                 # string of a subscriber to an array of subscriber objects
                 subscribers.values.each { |array| all_subscribers += array }
@@ -47,6 +47,51 @@ module NewRelic
           end
         end
 
+        # The agent doesn't use the traditional ActiveSupport::Notifications.subscribe
+        # pattern due to threading issues discovered on initial instrumentation.
+        # Instead we define a #start and #finish method, which Rails responds to.
+        # See: https://github.com/rails/rails/issues/12069
+        def start(name, id, payload)
+          return unless state.is_execution_traced?
+
+          start_segment(name, id, payload)
+        rescue => e
+          log_notification_error(e, name, 'start')
+        end
+
+        def finish(name, id, payload)
+          return unless state.is_execution_traced?
+
+          finish_segment(id, payload)
+        rescue => e
+          log_notification_error(e, name, 'finish')
+        end
+
+        def start_segment(name, id, payload)
+          segment = Tracer.start_segment(name: metric_name(name, payload))
+          add_segment_params(segment, payload)
+          push_segment(id, segment)
+        end
+
+        def finish_segment(id, payload)
+          if segment = pop_segment(id)
+            if exception = exception_object(payload)
+              segment.notice_error(exception)
+            end
+            segment.finish
+          end
+        end
+
+        # for subclasses
+        def add_segment_params(segment, payload)
+          # no op
+        end
+
+        # for subclasses
+        def metric_name(name, payload)
+          "Ruby/#{name}"
+        end
+
         def log_notification_error(error, name, event_type)
           # These are important enough failures that we want the backtraces
           # logged at error level, hence the explicit log_exception call.
@@ -55,7 +100,7 @@ module NewRelic
         end
 
         def push_segment(id, segment)
-          segment_stack[id].push segment
+          segment_stack[id].push(segment)
         end
 
         def pop_segment(id)
@@ -64,7 +109,7 @@ module NewRelic
         end
 
         def segment_stack
-          Thread.current[@queue_key] ||= Hash.new {|h,id| h[id] = [] }
+          Thread.current[@queue_key] ||= Hash.new { |h, id| h[id] = [] }
         end
 
         def state
@@ -76,16 +121,18 @@ module NewRelic
           # defensive.
           return if defined?(exception_object)
           return unless defined?(::ActiveSupport::VERSION)
-          if ::ActiveSupport::VERSION::STRING < "5.0.0"
+
+          if ::ActiveSupport::VERSION::STRING < '5.0.0'
             # Earlier versions of Rails did not add the exception itself to the
-            # payload asssessible via :exception_object, so we create a stand-in
+            # payload accessible via :exception_object, so we create a stand-in
             # error object from the given class name and message.
             # NOTE: no backtrace available this way, but we can notice the error
             # well enough to send the necessary info the UI requires to present it.
             def exception_object(payload)
               exception_class, message = payload[:exception]
               return nil unless exception_class
-              NewRelic::Agent::NoticibleError.new exception_class, message
+
+              NewRelic::Agent::NoticeableError.new(exception_class, message)
             end
           else
             def exception_object(payload)
@@ -94,7 +141,6 @@ module NewRelic
           end
         end
       end
-
     end
   end
 end

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

@@ -0,0 +1,38 @@
+# 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 PadrinoTracer
+        module Chain
+          def self.instrument!
+            ::Padrino::Routing::InstanceMethods.module_eval do
+              include NewRelic::Agent::Instrumentation::Sinatra
+
+              def dispatch_with_newrelic
+                dispatch_with_tracing { dispatch_without_newrelic }
+              end
+
+              alias dispatch_without_newrelic dispatch!
+              alias dispatch! dispatch_with_newrelic
+
+              # Padrino 0.13 mustermann routing
+              if private_method_defined?(:invoke_route)
+                include NewRelic::Agent::Instrumentation::Padrino
+
+                def invoke_route_with_newrelic(*args, &block)
+                  invoke_route_with_tracing(*args) { invoke_route_without_newrelic(*args, &block) }
+                end
+
+                alias invoke_route_without_newrelic invoke_route
+                alias invoke_route invoke_route_with_newrelic
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# 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 Padrino
+    INSTRUMENTATION_NAME = NewRelic::Agent.base_name(name)
+
+    def invoke_route_with_tracing(*args)
+      NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
+      begin
+        env['newrelic.last_route'] = args[0].original_path
+      rescue => e
+        ::NewRelic::Agent.logger.debug('Failed determining last route in Padrino', e)
+      end
+
+      begin
+        txn_name = ::NewRelic::Agent::Instrumentation::Sinatra::TransactionNamer.transaction_name_for_route(env, request)
+        unless txn_name.nil?
+          ::NewRelic::Agent::Transaction.set_default_transaction_name(
+            "#{self.class.name}/#{txn_name}", :sinatra
+          )
+        end
+      rescue => e
+        ::NewRelic::Agent.logger.debug('Failed during invoke_route to set transaction name', e)
+      end
+
+      yield
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/padrino/prepend.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::Agent::Instrumentation
+  module PadrinoTracer
+    module Prepend
+      include NewRelic::Agent::Instrumentation::Sinatra
+      include NewRelic::Agent::Instrumentation::Padrino
+
+      def dispatch
+        dispatch_with_tracing { super }
+      end
+
+      def invoke_route(*args, &block)
+        invoke_route_with_tracing(*args) { super }
+      end
+    end
+  end
+end

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

@@ -1,70 +1,32 @@
-# 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/sinatra'
+# Our Padrino instrumentation relies heavily on the fact that Padrino is
+# built on Sinatra. Although it wires up a lot of its own routing logic,
+# we only need to patch into Padrino's dispatch to get things started.
+#
+# Parts of the Sinatra instrumentation (such as the TransactionNamer) are
+# aware of Padrino as a potential target in areas where both Sinatra and
+# Padrino run through the same code.
+
+require_relative 'sinatra'
+require_relative 'padrino/chain'
+require_relative 'padrino/instrumentation'
+require_relative 'padrino/prepend'
 
 DependencyDetection.defer do
   @name = :padrino
+  configure_with :sinatra
 
-  depends_on do
-    !NewRelic::Agent.config[:disable_sinatra] &&
-      defined?(::Padrino) && defined?(::Padrino::Routing::InstanceMethods)
-  end
+  depends_on { defined?(Padrino) && defined?(Padrino::Routing::InstanceMethods) }
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing Padrino instrumentation'
-
-    # Our Padrino instrumentation relies heavily on the fact that Padrino is
-    # built on Sinatra. Although it wires up a lot of its own routing logic,
-    # we only need to patch into Padrino's dispatch to get things started.
-    #
-    # Parts of the Sinatra instrumentation (such as the TransactionNamer) are
-    # aware of Padrino as a potential target in areas where both Sinatra and
-    # Padrino run through the same code.
-    module ::Padrino::Routing::InstanceMethods
-      include NewRelic::Agent::Instrumentation::Sinatra
-
-      alias dispatch_without_newrelic dispatch!
-      alias dispatch! dispatch_with_newrelic
-
-      # Padrino 0.13 mustermann routing
-      if private_method_defined?(:invoke_route)
-        include NewRelic::Agent::Instrumentation::Padrino
-
-        alias invoke_route_without_newrelic invoke_route
-        alias invoke_route invoke_route_with_newrelic
-      end
-    end
-  end
-end
-
-module NewRelic
-  module Agent
-    module Instrumentation
-      module Padrino
-
-        def invoke_route_with_newrelic(*args, &block)
-          begin
-            env["newrelic.last_route"] = args[0].original_path
-          rescue => e
-            ::NewRelic::Agent.logger.debug("Failed determining last route in Padrino", e)
-          end
-
-          begin
-            txn_name = ::NewRelic::Agent::Instrumentation::Sinatra::TransactionNamer.transaction_name_for_route(env, request)
-            unless txn_name.nil?
-              ::NewRelic::Agent::Transaction.set_default_transaction_name(
-                "#{self.class.name}/#{txn_name}", :sinatra)
-            end
-          rescue => e
-            ::NewRelic::Agent.logger.debug("Failed during invoke_route to set transaction name", e)
-          end
-
-          invoke_route_without_newrelic(*args, &block)
-        end
-
-      end
+    NewRelic::Agent.logger.info('Installing Padrino instrumentation')
+    if use_prepend?
+      prepend_instrument Padrino::Application, NewRelic::Agent::Instrumentation::PadrinoTracer::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::PadrinoTracer::Chain
     end
   end
 end

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

@@ -1,23 +1,23 @@
-# 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 = :passenger
 
   depends_on do
-    defined?(::PhusionPassenger)
+    defined?(PhusionPassenger)
   end
 
   executes do
-    ::NewRelic::Agent.logger.debug "Installing Passenger event hooks."
+    NewRelic::Agent.logger.debug('Installing Passenger event hooks.')
 
-    ::PhusionPassenger.on_event(:stopping_worker_process) do
-      ::NewRelic::Agent.logger.debug "Passenger stopping this process, shutdown the agent."
+    PhusionPassenger.on_event(:stopping_worker_process) do
+      NewRelic::Agent.logger.debug('Passenger stopping this process, shutdown the agent.')
       NewRelic::Agent.instance.shutdown
     end
 
-    ::PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    PhusionPassenger.on_event(:starting_worker_process) do |forked|
       # We want to reset the stats from the stats engine in case any carried
       # over into the spawned process.  Don't clear them in case any were
       # cached.  We do this even in conservative spawning.