newrelic_rpm 9.9.0 → 9.21.0

data/lib/new_relic/agent.rb

@@ -64,6 +64,7 @@ module NewRelic
     require 'new_relic/agent/linking_metadata'
     require 'new_relic/agent/local_log_decorator'
     require 'new_relic/agent/llm'
+    require 'new_relic/agent/aws'
 
     require 'new_relic/agent/instrumentation/controller_instrumentation'
 
@@ -84,6 +85,10 @@ module NewRelic
     # An exception that forces an agent to stop reporting until its mongrel is restarted.
     class ForceDisconnectException < StandardError; end
 
+    # Error handling for the automated custom instrumentation tracer logic
+    class AutomaticTracerParseException < StandardError; end
+    class AutomaticTracerTraceException < StandardError; end
+
     # An exception that forces an agent to restart.
     class ForceRestartException < StandardError
       def message
@@ -108,6 +113,9 @@ module NewRelic
     # placeholder name used when we cannot determine a transaction's name
     UNKNOWN_METRIC = '(unknown)'.freeze
     LLM_FEEDBACK_MESSAGE = 'LlmFeedbackMessage'
+    # give the observed app time to load the code that automatic tracers have
+    # been configured for
+    AUTOMATIC_TRACER_MAX_ATTEMPTS = 60 # 60 = try about twice a second for 30 seconds
 
     attr_reader :error_group_callback
     attr_reader :llm_token_count_callback
@@ -124,8 +132,8 @@ module NewRelic
     def agent # :nodoc:
       return @agent if @agent
 
-      NewRelic::Agent.logger.warn("Agent unavailable as it hasn't been started.")
-      NewRelic::Agent.logger.warn(caller.join("\n"))
+      NewRelic::Agent.logger.debug("Agent unavailable as it hasn't been started.")
+      NewRelic::Agent.logger.debug(caller.join("\n"))
       nil
     end
 
@@ -162,6 +170,92 @@ module NewRelic
       end
     end
 
+    # @api private
+    def self.add_automatic_method_tracers(arr)
+      return unless arr
+      return arr if arr.respond_to?(:empty?) && arr.empty?
+
+      arr = arr.split(/\s*,\s*/) if arr.is_a?(String)
+
+      add_tracers_once_methods_are_defined(arr.dup)
+
+      arr
+    end
+
+    # spawn a thread that will attempt to establish a tracer for each of the
+    # configured methods. the thread will continue to keep trying with each
+    # tracer until one of the following happens:
+    #   - the tracer is successfully established
+    #   - the configured method string couldn't be parsed
+    #   - establishing a tracer for a successfully parsed string failed
+    #   - the maximum number of attempts has been reached
+    # the thread will only be spawned once per agent initialization, to account
+    # for configuration reloading scenarios.
+    #
+    # @api private
+    def self.add_tracers_once_methods_are_defined(notations)
+      # this class method can be invoked multiple times at agent startup, so
+      # we return asap here instead of using a traditional memoization of
+      # waiting for the method's body to finish being executed
+      if defined?(@add_tracers_once_methods_are_defined)
+        return
+      else
+        @add_tracers_once_methods_are_defined = true
+      end
+
+      Thread.new do
+        AUTOMATIC_TRACER_MAX_ATTEMPTS.times do
+          notations.delete_if { |notation| prep_tracer_for(notation) }
+
+          break if notations.empty?
+
+          sleep 0.5
+        end
+      end
+    end
+
+    # returns `true` if the notation string has either been successfully
+    # processed or raised an error during processing. returns `false` if the
+    # string seems good but the (customer) code to be traced has not yet been
+    # loaded into the Ruby VM
+    #
+    # @api private
+    def self.prep_tracer_for(fully_qualified_method_notation)
+      delimiters = fully_qualified_method_notation.scan(/\.|#/)
+      raise AutomaticTracerParseException.new("Expected exactly one '.' or '#' delimiter.") unless delimiters.size == 1
+
+      delimiter = delimiters.first
+      namespace, method_name = fully_qualified_method_notation.split(delimiter)
+      unless namespace && !namespace.empty?
+        raise AutomaticTracerParseException.new("Nothing found to the left of the #{delimiter} delimiter.")
+      end
+      unless method_name && !method_name.empty?
+        raise AutomaticTracerParseException.new("Nothing found to the right of the #{delimiter} delimiter.")
+      end
+
+      begin
+        klass = ::NewRelic::LanguageSupport.constantize(namespace)
+        return false unless klass
+
+        klass_to_trace = delimiter.eql?('.') ? klass.singleton_class : klass
+        add_or_defer_method_tracer(klass_to_trace, method_name, nil, {})
+      rescue StandardError => e
+        raise AutomaticTracerTraceException.new("#{e.class} - #{e.message}")
+      end
+
+      true
+    rescue AutomaticTracerParseException => e
+      NewRelic::Agent.logger.error('Unable to parse out a usable method name to trace. Expected a valid, fully ' \
+                                   "qualified method notation. Got: '#{fully_qualified_method_notation}'. " \
+                                   "Error: #{e.message}")
+      true
+    rescue AutomaticTracerTraceException => e
+      NewRelic::Agent.logger.error('Unable to automatically apply a tracer to method ' \
+                                   "'#{fully_qualified_method_notation}'. Error: #{e.message}")
+      true
+    end
+
+    # @api private
     def add_deferred_method_tracers_now
       @tracer_lock.synchronize do
         @tracer_queue.each do |receiver, method_name, metric_name, options|
@@ -199,6 +293,7 @@ module NewRelic
     #
     # This method is safe to use from any thread.
     #
+    # @!scope class
     # @api public
     def record_metric(metric_name, value) # THREAD_LOCAL_ACCESS
       record_api_supportability_metric(:record_metric)
@@ -239,6 +334,7 @@ module NewRelic
     #
     # This method is safe to use from any thread.
     #
+    # @!scope class
     # @api public
     #
     def increment_metric(metric_name, amount = 1) # THREAD_LOCAL_ACCESS
@@ -266,6 +362,7 @@ module NewRelic
     #
     # Return the new block or the existing filter Proc if no block is passed.
     #
+    # @!scope class
     # @api public
     #
     def ignore_error_filter(&block)
@@ -304,6 +401,7 @@ module NewRelic
     # them if you are calling <code>notice_error</code> outside a
     # transaction.
     #
+    # @!scope class
     # @api public
     #
     def notice_error(exception, options = {})
@@ -341,6 +439,7 @@ module NewRelic
     # :'error.expected' => Whether (true) or not (false) the error was expected
     # :options => The options hash passed to `NewRelic::Agent.notice_error`
     #
+    # @!scope class
     # @api public
     #
     def set_error_group_callback(callback_proc)
@@ -380,6 +479,7 @@ module NewRelic
     #                           may be strings, symbols, numeric values or
     #                           booleans.
     #
+    # @!scope class
     # @api public
     #
     def record_custom_event(event_type, event_attrs)
@@ -412,6 +512,7 @@ module NewRelic
     # @param [optional, Hash] Set of key-value pairs to store any other
     #   desired data to submit with the feedback event.
     #
+    # @!scope class
     # @api public
     #
     def record_llm_feedback_event(trace_id:,
@@ -465,6 +566,7 @@ module NewRelic
     # :model => [String] The name of the LLM model
     # :content => [String] The message content or prompt
     #
+    # @!scope class
     # @api public
     #
     def set_llm_token_count_callback(callback_proc)
@@ -497,6 +599,7 @@ module NewRelic
     # file logger.  The setting for the newrelic.yml section to use
     # (ie, RAILS_ENV) can be overridden with an :env argument.
     #
+    # @!scope class
     # @api public
     #
     def manual_start(options = {})
@@ -529,6 +632,7 @@ module NewRelic
     #   connection, this tells me to only try it once so this method returns
     #   quickly if there is some kind of latency with the server.
     #
+    # @!scope class
     # @api public
     #
     def after_fork(options = {})
@@ -542,6 +646,7 @@ module NewRelic
     #
     # @param options [Hash] Unused options Hash, for back compatibility only
     #
+    # @!scope class
     # @api public
     #
     def shutdown(options = {})
@@ -552,6 +657,7 @@ module NewRelic
     # Clear out any data the agent has buffered but has not yet transmitted
     # to the collector.
     #
+    # @!scope class
     # @api public
     def drop_buffered_data
       # the following line needs else branch coverage
@@ -566,6 +672,7 @@ module NewRelic
     # register instrumentation than just loading the files directly,
     # although that probably also works.
     #
+    # @!scope class
     # @api public
     #
     def add_instrumentation(file_pattern)
@@ -575,6 +682,7 @@ module NewRelic
 
     # Require agent testing helper methods
     #
+    # @!scope class
     # @api public
     def require_test_helper
       record_api_supportability_metric(:require_test_helper)
@@ -595,6 +703,7 @@ module NewRelic
     #       my_obfuscator(sql)
     #    end
     #
+    # @!scope class
     # @api public
     #
     def set_sql_obfuscator(type = :replace, &block)
@@ -610,6 +719,7 @@ module NewRelic
     # traced errors, transaction traces, Insights events, slow SQL traces,
     # or RUM injection will happen for this transaction.
     #
+    # @!scope class
     # @api public
     #
     def ignore_transaction
@@ -620,6 +730,7 @@ module NewRelic
     # This method disables the recording of Apdex metrics in the current
     # transaction.
     #
+    # @!scope class
     # @api public
     #
     def ignore_apdex
@@ -630,6 +741,7 @@ module NewRelic
     # This method disables browser monitoring javascript injection in the
     # current transaction.
     #
+    # @!scope class
     # @api public
     #
     def ignore_enduser
@@ -642,6 +754,7 @@ module NewRelic
     # track of the first entry point and turn on tracing again after
     # leaving that block.  This uses the thread local Tracer::State.
     #
+    # @!scope class
     # @api public
     #
     def disable_all_tracing
@@ -666,6 +779,7 @@ module NewRelic
     #     ...
     #   end
     #
+    # @!scope class
     # @api public
     #
     def disable_sql_recording
@@ -704,6 +818,7 @@ module NewRelic
     #                           may be strings, symbols, numeric values or
     #                           booleans.
     #
+    # @!scope class
     # @api public
     #
     def add_custom_attributes(params) # THREAD_LOCAL_ACCESS
@@ -744,6 +859,7 @@ module NewRelic
     #                           booleans.
     #
     # @see https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/glossary#span
+    # @!scope class
     # @api public
     def add_custom_span_attributes(params)
       record_api_supportability_metric(:add_custom_span_attributes)
@@ -785,6 +901,7 @@ module NewRelic
     #
     #                         Attribute pairs with empty or nil contents
     #                         will be dropped.
+    # @!scope class
     # @api public
     def add_custom_log_attributes(params)
       record_api_supportability_metric(:add_custom_log_attributes)
@@ -800,6 +917,7 @@ module NewRelic
     #
     # @param [String] user_id    The user id to add to the current transaction attributes
     #
+    # @!scope class
     # @api public
     def set_user_id(user_id)
       record_api_supportability_metric(:set_user_id)
@@ -843,6 +961,7 @@ module NewRelic
     #
     # The default category is the same as the running transaction.
     #
+    # @!scope class
     # @api public
     #
     def set_transaction_name(name, options = {})
@@ -853,6 +972,7 @@ module NewRelic
     # Get the name of the current running transaction.  This is useful if you
     # want to modify the default name.
     #
+    # @!scope class
     # @api public
     #
     def get_transaction_name # THREAD_LOCAL_ACCESS
@@ -924,6 +1044,7 @@ module NewRelic
     # * entity.guid - The guid of the current entity.
     # * hostname    - The fully qualified hostname.
     #
+    # @!scope class
     # @api public
     def linking_metadata
       metadata = Hash.new
@@ -950,6 +1071,7 @@ module NewRelic
     #
     # @param [String] nonce The nonce to use in the javascript tag for browser instrumentation
     #
+    # @!scope class
     # @api public
     #
     def browser_timing_header(nonce = nil)

data/lib/new_relic/constants.rb

@@ -16,6 +16,7 @@ module NewRelic
   HTTP = 'HTTP'
   HTTPS = 'HTTPS'
   UNKNOWN = 'Unknown'
+  UNKNOWN_LOWER = 'unknown'
 
   FORMAT_NON_RACK = 0
   FORMAT_RACK = 1

data/lib/new_relic/control/frameworks/grape.rb

@@ -0,0 +1,14 @@
+# 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/control/frameworks/ruby'
+module NewRelic
+  class Control
+    module Frameworks
+      # Contains basic control logic for Grape
+      class Grape < NewRelic::Control::Frameworks::Ruby
+      end
+    end
+  end
+end

data/lib/new_relic/control/frameworks/padrino.rb

@@ -0,0 +1,14 @@
+# 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/control/frameworks/sinatra'
+module NewRelic
+  class Control
+    module Frameworks
+      # Contains basic control logic for Padrino
+      class Padrino < NewRelic::Control::Frameworks::Sinatra
+      end
+    end
+  end
+end

data/lib/new_relic/control/frameworks/rails4.rb

@@ -9,9 +9,7 @@ module NewRelic
     module Frameworks
       class Rails4 < NewRelic::Control::Frameworks::Rails3
         def rails_gem_list
-          Bundler.rubygems.all_specs.map do |gem|
-            "#{gem.name} (#{gem.version})"
-          end
+          NewRelic::Helper.rubygems_specs.map { |gem| "#{gem.name} (#{gem.version})" }
         end
 
         def append_plugin_list

data/lib/new_relic/control/instance_methods.rb

@@ -73,6 +73,8 @@ module NewRelic
         init_config(options)
         NewRelic::Agent.agent = NewRelic::Agent::Agent.instance
         init_instrumentation
+        init_security_agent
+        report_agent_version_metric
       end
 
       def determine_env(options)
@@ -170,6 +172,10 @@ module NewRelic
       def stdout
         STDOUT
       end
+
+      def report_agent_version_metric
+        NewRelic::Agent.record_metric_once("Supportability/AgentVersion/newrelic_rpm/#{NewRelic::VERSION::STRING}")
+      end
     end
     include InstanceMethods
   end

data/lib/new_relic/control/instrumentation.rb

@@ -68,7 +68,7 @@ module NewRelic
     end
 
     def rails_32_deprecation
-      return unless defined?(Rails::VERSION) && Gem::Version.new(Rails::VERSION::STRING) <= Gem::Version.new('3.2')
+      return unless defined?(Rails::VERSION) && NewRelic::Helper.version_satisfied?(Rails::VERSION::STRING, '<=', '3.2')
 
       deprecation_msg = 'The Ruby agent is dropping support for Rails 3.2 ' \
         'in a future major release. Please upgrade your Rails version to continue receiving support. ' \

data/lib/new_relic/control/private_instance_methods.rb

@@ -43,6 +43,10 @@ module NewRelic
           DependencyDetection.detect!
         end
       end
+
+      def init_security_agent
+        SecurityInterface.instance.init_agent
+      end
     end
   end
 end

data/lib/new_relic/control/security_interface.rb

@@ -0,0 +1,57 @@
+# 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 'singleton'
+
+module NewRelic
+  class Control
+    class SecurityInterface
+      include Singleton
+
+      attr_accessor :wait
+
+      SUPPORTABILITY_PREFIX_SECURITY = 'Supportability/Ruby/SecurityAgent/Enabled/'
+      SUPPORTABILITY_PREFIX_SECURITY_AGENT = 'Supportability/Ruby/SecurityAgent/Agent/Enabled/'
+      ENABLED = 'enabled'
+      DISABLED = 'disabled'
+
+      def agent_started?
+        (@agent_started ||= false) == true
+      end
+
+      def waiting?
+        (@wait ||= false) == true
+      end
+
+      def init_agent
+        return if agent_started? || waiting?
+
+        record_supportability_metrics
+
+        if Agent.config[:'security.agent.enabled'] && !Agent.config[:high_security]
+          Agent.logger.info('Invoking New Relic security module')
+          require 'newrelic_security'
+
+          @agent_started = true
+        else
+          Agent.logger.info('New Relic Security is completely disabled by one of the user-provided configurations: `security.agent.enabled` or `high_security`. Not loading security capabilities.')
+          Agent.logger.info("high_security = #{Agent.config[:high_security]}")
+          Agent.logger.info("security.agent.enabled = #{Agent.config[:'security.agent.enabled']}")
+        end
+      rescue LoadError
+        Agent.logger.info('New Relic security agent not found - skipping')
+      rescue StandardError => exception
+        Agent.logger.error("Exception in New Relic security module loading: #{exception} #{exception.backtrace}")
+      end
+
+      def record_supportability_metrics
+        Agent.config[:'security.agent.enabled'] ? security_agent_metric(ENABLED) : security_agent_metric(DISABLED)
+      end
+
+      def security_agent_metric(setting)
+        NewRelic::Agent.record_metric_once(SUPPORTABILITY_PREFIX_SECURITY_AGENT + setting)
+      end
+    end
+  end
+end

data/lib/new_relic/control.rb

@@ -8,7 +8,6 @@ require 'new_relic/local_environment'
 require 'new_relic/language_support'
 require 'new_relic/helper'
 
-require 'singleton'
 require 'erb'
 require 'socket'
 require 'net/https'
@@ -18,6 +17,7 @@ require 'new_relic/control/server_methods'
 require 'new_relic/control/instrumentation'
 require 'new_relic/control/class_methods'
 require 'new_relic/control/instance_methods'
+require 'new_relic/control/security_interface'
 
 require 'new_relic/agent'
 require 'new_relic/delayed_job_injection'

data/lib/new_relic/dependency_detection.rb

@@ -25,11 +25,9 @@ module DependencyDetection
 
   def detect!
     @items.each do |item|
-      if item.dependencies_satisfied?
-        item.execute
-      else
-        item.configure_as_unsatisfied unless item.disabled_configured?
-      end
+      next if item.executed || item.disabled_configured?
+
+      item.dependencies_satisfied? ? item.execute : item.configure_as_unsatisfied
     end
   end
 
@@ -65,6 +63,13 @@ module DependencyDetection
     end
 
     def configure_as_unsatisfied
+      # TODO: currently using :unsatisfied for Padrino will clobber the value
+      #       already set for Sinatra, so skip Padrino and circle back with a
+      #       new Padrino specific solution in the future.
+      #
+      #       https://github.com/newrelic/newrelic-ruby-agent/issues/2912
+      return if name == :padrino
+
       NewRelic::Agent.config.instance_variable_get(:@cache)[config_key] = :unsatisfied
     end
 
@@ -139,8 +144,6 @@ module DependencyDetection
       !(disabled_configured? || deprecated_disabled_configured?)
     end
 
-    # TODO: MAJOR VERSION
-    # will only return true if a disabled key is found and is truthy
     def deprecated_disabled_configured?
       return false if self.name.nil?
 
@@ -148,12 +151,7 @@ module DependencyDetection
       return false unless ::NewRelic::Agent.config[key] == true
 
       ::NewRelic::Agent.logger.debug("Not installing #{self.name} instrumentation because of configuration #{key}")
-      ::NewRelic::Agent.logger.debug( \
-        "[DEPRECATED] configuration #{key} for #{self.name} will be removed in the next major release. " \
-        "Use `#{config_key}` with one of `#{VALID_CONFIG_VALUES.map(&:to_s).inspect}`"
-      )
-
-      return true
+      true
     end
 
     def config_key
@@ -181,7 +179,6 @@ module DependencyDetection
     # logs the resolved value during debug mode.
     def fetch_config_value(key)
       valid_value = valid_config_value(::NewRelic::Agent.config[key].to_s.to_sym)
-      ::NewRelic::Agent.logger.debug("Using #{valid_value} configuration value for #{self.name} to configure instrumentation")
       return valid_value
     end
 

data/lib/new_relic/environment_report.rb

@@ -44,7 +44,7 @@ module NewRelic
     ####################################
     report_on('Gems') do
       begin
-        Bundler.rubygems.all_specs.map { |gem| "#{gem.name}(#{gem.version})" }
+        NewRelic::Helper.rubygems_specs.map { |gem| "#{gem.name}(#{gem.version})" }
       rescue
         # There are certain rubygem, bundler, rails combinations (e.g. gem
         # 1.6.2, rails 2.3, bundler 1.2.3) where the code above throws an error
@@ -67,7 +67,7 @@ module NewRelic
     report_on('Physical Cores') { ::NewRelic::Agent::SystemInfo.num_physical_cores }
     report_on('Arch') { ::NewRelic::Agent::SystemInfo.processor_arch }
     report_on('OS version') { ::NewRelic::Agent::SystemInfo.os_version }
-    report_on('OS') { ::NewRelic::Agent::SystemInfo.ruby_os_identifier }
+    report_on('OS') { ::NewRelic::Agent::SystemInfo.os_distribution }
     report_on('Database adapter') { ::NewRelic::Agent::DatabaseAdapter.value }
     report_on('Framework') { Agent.config[:framework].to_s }
     report_on('Dispatcher') { Agent.config[:dispatcher].to_s }

data/lib/new_relic/helper.rb

@@ -82,5 +82,27 @@ module NewRelic
         File.exist?(executable_path) && File.file?(executable_path) && File.executable?(executable_path)
       end
     end
+
+    def version_satisfied?(left, operator, right)
+      left = Gem::Version.new(left) unless left.is_a?(Gem::Version)
+      right = Gem::Version.new(right) unless right.is_a?(Gem::Version)
+
+      left.public_send(operator, right)
+    end
+
+    # Bundler version 2.5.12 deprecated all_specs and added installed_specs.
+    # To support newer Bundler versions, try to use installed_specs first,
+    # then fall back to all_specs.
+    # All callers expect this to be an array, so return an array if Bundler isn't defined
+    # @api private
+    def rubygems_specs
+      return [] unless defined?(Bundler)
+
+      if Bundler.rubygems.respond_to?(:installed_specs)
+        Bundler.rubygems.installed_specs
+      else
+        Bundler.rubygems.all_specs
+      end
+    end
   end
 end

data/lib/new_relic/language_support.rb

@@ -88,7 +88,9 @@ module NewRelic
     end
 
     def bundled_gem?(gem_name)
-      defined?(Bundler) && Bundler.rubygems.all_specs.map(&:name).include?(gem_name)
+      return false unless defined?(Bundler)
+
+      NewRelic::Helper.rubygems_specs.map(&:name).include?(gem_name)
     rescue => e
       ::NewRelic::Agent.logger.info("Could not determine if third party #{gem_name} gem is installed", e)
       false

data/lib/new_relic/local_environment.rb

@@ -142,10 +142,7 @@ module NewRelic
     end
 
     def check_for_falcon
-      return unless defined?(::Falcon::Server) &&
-        NewRelic::LanguageSupport.object_space_usable?
-
-      @discovered_dispatcher = :falcon if find_class_in_object_space(::Falcon::Server)
+      @discovered_dispatcher = :falcon if defined?(::Falcon::Server) && File.basename($PROGRAM_NAME) == 'falcon'
     end
 
     def check_for_delayed_job