newrelic_rpm 3.12.0.288 → 9.10.2

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

@@ -1,128 +1,32 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 DependencyDetection.defer do
   named :mongo
 
   depends_on do
-    defined?(::Mongo)
+    defined?(Mongo)
   end
 
   depends_on do
     require 'new_relic/agent/datastores/mongo'
+    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'
-    install_mongo_instrumentation
-  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
+    NewRelic::Agent.logger.info('Installing Mongo instrumentation')
+    install_mongo_command_subscriber
   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(t0, payload, name)
-        statement = NewRelic::Agent::Datastores::Mongo::StatementFormatter.format(payload, name)
-        if statement
-          NewRelic::Agent.instance.transaction_sampler.notice_nosql_statement(statement, (Time.now - t0).to_f)
-        end
-      rescue => e
-        NewRelic::Agent.logger.debug("Exception during Mongo statement gathering", e)
-      end
-
-      def new_relic_generate_metrics(operation, payload = nil)
-        payload ||= { :collection => self.name, :database => self.db.name }
-        NewRelic::Agent::Datastores::Mongo::MetricTranslator.metrics_for(operation, payload)
-      end
-
-      def instrument_with_new_relic_trace(name, payload = {}, &block)
-        metrics = new_relic_generate_metrics(name, payload)
-
-        trace_execution_scoped(metrics) do
-          t0 = Time.now
-
-          result = NewRelic::Agent.disable_all_tracing do
-            instrument_without_new_relic_trace(name, payload, &block)
-          end
-
-          new_relic_notice_statement(t0, payload, name)
-          result
-        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)
-        metrics = new_relic_generate_metrics(:save)
-        trace_execution_scoped(metrics) do
-          t0 = Time.now
-
-          result = NewRelic::Agent.disable_all_tracing do
-            save_without_new_relic_trace(doc, opts, &block)
-          end
-
-          new_relic_notice_statement(t0, doc, :save)
-          result
-        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)
-        metrics = new_relic_generate_metrics(:ensureIndex)
-        trace_execution_scoped(metrics) do
-          t0 = Time.now
-
-          result = NewRelic::Agent.disable_all_tracing do
-            ensure_index_without_new_relic_trace(spec, opts, &block)
-          end
-
-          spec = case spec
-                 when Array
-                   Hash[spec]
-                 when String, Symbol
-                   { spec => 1 }
-                 else
-                   spec.dup
-                 end
-
-          new_relic_notice_statement(t0, spec, :ensureIndex)
-          result
-        end
-      end
-
-      alias_method :ensure_index_without_new_relic_trace, :ensure_index
-      alias_method :ensure_index, :ensure_index_with_new_relic_trace
-    end
+  def install_mongo_command_subscriber
+    require 'new_relic/agent/instrumentation/mongodb_command_subscriber'
+    Mongo::Monitoring::Global.subscribe(
+      Mongo::Monitoring::COMMAND,
+      NewRelic::Agent::Instrumentation::MongodbCommandSubscriber.new
+    )
   end
 end

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

@@ -0,0 +1,140 @@
+# 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
+  module Agent
+    module Instrumentation
+      class MongodbCommandSubscriber
+        MONGODB = 'MongoDB'.freeze
+        COLLECTION = 'collection'.freeze
+
+        def started(event)
+          begin
+            return unless NewRelic::Agent::Tracer.tracing_enabled?
+
+            segments[event.operation_id] = start_segment(event)
+          rescue Exception => e
+            log_notification_error('started', e)
+          end
+        end
+
+        ERROR_KEYS = %w[writeErrors writeConcernError writeConcernErrors].freeze
+
+        def error_key_present?(event)
+          if reply = event.reply
+            ERROR_KEYS.detect { |key| reply[key] }
+          end
+        rescue
+          false
+        end
+
+        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 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']]))
+
+            # 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))
+            end
+            segment.finish
+          rescue Exception => e
+            log_notification_error('completed', e)
+          end
+        end
+
+        alias :succeeded :completed
+        alias :failed :completed
+
+        private
+
+        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),
+            collection: collection(event),
+            host: host,
+            port_path_or_id: port_path_or_id,
+            database_name: event.database_name
+          )
+          segment.notice_nosql_statement(generate_statement(event))
+          segment
+        end
+
+        def operation(command_name)
+          # from 2.0 to 2.5, :findandmodify was the command_name
+          if command_name == :findandmodify
+            :findAndModify
+          else
+            command_name
+          end
+        end
+
+        def collection(event)
+          event.command[COLLECTION] || event.command[:collection] || event.command.values.first
+        end
+
+        def log_notification_error(event_type, error)
+          NewRelic::Agent.logger.error("Error during MongoDB #{event_type} event:")
+          NewRelic::Agent.logger.log_exception(:error, error)
+        end
+
+        def segments
+          @segments ||= {}
+        end
+
+        def generate_statement(event)
+          NewRelic::Agent::Datastores::Mongo::EventFormatter.format(
+            event.command_name,
+            event.database_name,
+            event.command
+          )
+        end
+
+        UNKNOWN = 'unknown'.freeze
+        LOCALHOST = 'localhost'.freeze
+
+        def host_from_address(address)
+          if unix_domain_socket?(address.host)
+            LOCALHOST
+          else
+            address.host
+          end
+        rescue => 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)
+            address.host
+          else
+            address.port
+          end
+        rescue => e
+          NewRelic::Agent.logger.debug("Failed to retrieve Mongo port_path_or_id: #{e}")
+          UNKNOWN
+        end
+
+        def unix_domain_socket?(host)
+          host.start_with?(NewRelic::SLASH)
+        end
+      end
+    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_http/instrumentation.rb

@@ -0,0 +1,50 @@
+# 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 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(
+            library: wrapped_request.type,
+            uri: wrapped_request.uri,
+            procedure: wrapped_request.method
+          )
+
+          begin
+            response = nil
+            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
+                yield
+              end
+            end
+
+            wrapped_response = NewRelic::Agent::HTTPClients::NetHTTPResponse.new(response)
+
+            if NewRelic::Agent::LLM.openai_parent?(segment)
+              NewRelic::Agent::LLM.populate_openai_response_headers(wrapped_response, segment.parent)
+            end
+
+            segment.process_response_headers(wrapped_response)
+
+            response
+          ensure
+            segment&.finish
+          end
+        end
+      end
+    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

@@ -0,0 +1,146 @@
+# 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
+      class NotificationsSubscriber
+        def initialize
+          @queue_key = ['NewRelic', self.class.name, object_id].join('-')
+          define_exception_method
+        end
+
+        def self.subscribed?
+          find_all_subscribers.find { |s| s.instance_variable_get(:@delegate).class == self }
+        end
+
+        def self.find_all_subscribers
+          # TODO: need to talk to Rails core about an API for this,
+          # rather than digging through Listener ivars
+          instance_variable_names = [:@subscribers, :@string_subscribers, :@other_subscribers]
+          all_subscribers = []
+
+          notifier = ActiveSupport::Notifications.notifier
+
+          instance_variable_names.each do |name|
+            if notifier.instance_variable_defined?(name)
+              subscribers = notifier.instance_variable_get(name)
+              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)
+                # 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 }
+              end
+            end
+          end
+
+          all_subscribers
+        end
+
+        def self.subscribe(pattern)
+          if !subscribed?
+            ActiveSupport::Notifications.subscribe(pattern, new)
+          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.
+          NewRelic::Agent.logger.error("Error during #{event_type} callback for event '#{name}':")
+          NewRelic::Agent.logger.log_exception(:error, error)
+        end
+
+        def push_segment(id, segment)
+          segment_stack[id].push(segment)
+        end
+
+        def pop_segment(id)
+          segment = segment_stack[id].pop
+          segment
+        end
+
+        def segment_stack
+          Thread.current[@queue_key] ||= Hash.new { |h, id| h[id] = [] }
+        end
+
+        def state
+          NewRelic::Agent::Tracer.state
+        end
+
+        def define_exception_method
+          # we don't expect this to be called more than once, but we're being
+          # defensive.
+          return if defined?(exception_object)
+          return unless defined?(::ActiveSupport::VERSION)
+
+          if ::ActiveSupport::VERSION::STRING < '5.0.0'
+            # Earlier versions of Rails did not add the exception itself to the
+            # 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::NoticeableError.new(exception_class, message)
+            end
+          else
+            def exception_object(payload)
+              payload[:exception_object]
+            end
+          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