newrelic_rpm 6.15.0 → 9.7.1

data/lib/new_relic/agent/attribute_pre_filtering.rb

@@ -0,0 +1,109 @@
+# 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 AttributePreFiltering
+      module_function
+
+      PRE_FILTER_KEYS = %i[include exclude].freeze
+      DISCARDED = :nr_discarded
+
+      def formulate_regexp_union(option)
+        return if NewRelic::Agent.config[option].empty?
+
+        Regexp.union(NewRelic::Agent.config[option].map { |p| string_to_regexp(p) }.uniq.compact).freeze
+      rescue StandardError => e
+        NewRelic::Agent.logger.warn("Failed to formulate a Regexp union from the '#{option}' configuration option " +
+                                    "- #{e.class}: #{e.message}")
+      end
+
+      def string_to_regexp(str)
+        Regexp.new(str)
+      rescue StandardError => e
+        NewRelic::Agent.logger.warn("Failed to initialize Regexp from string '#{str}' - #{e.class}: #{e.message}")
+      end
+
+      # attribute filtering suppresses data that has already been flattened
+      # and coerced (serialized as text) via #flatten_and_coerce, and is
+      # restricted to basic text matching with a single optional wildcard.
+      # pre filtering operates on raw Ruby objects beforehand and uses full
+      # Ruby regex syntax
+      def pre_filter(values = [], options = {})
+        return values unless !options.empty? && PRE_FILTER_KEYS.any? { |k| options.key?(k) }
+
+        # if there's a prefix in play for (non-pre) attribute filtration and
+        # attribute filtration won't allow that prefix, then don't even bother
+        # with pre filtration that could only result in values that would be
+        # blocked
+        if options.key?(:attribute_namespace) &&
+            !NewRelic::Agent.instance.attribute_filter.might_allow_prefix?(options[:attribute_namespace])
+          return values
+        end
+
+        values.each_with_object([]) do |element, filtered|
+          object = pre_filter_object(element, options)
+          filtered << object unless discarded?(object)
+        end
+      end
+
+      def pre_filter_object(object, options)
+        if object.is_a?(Hash)
+          pre_filter_hash(object, options)
+        elsif object.is_a?(Array)
+          pre_filter_array(object, options)
+        else
+          pre_filter_scalar(object, options)
+        end
+      end
+
+      def pre_filter_hash(hash, options)
+        filtered_hash = hash.each_with_object({}) do |(key, value), filtered|
+          filtered_key = pre_filter_object(key, options)
+          next if discarded?(filtered_key)
+
+          # If the key is permitted, skip include filtration for the value
+          # but still apply exclude filtration
+          if options.key?(:exclude)
+            exclude_only = options.dup
+            exclude_only.delete(:include)
+            filtered_value = pre_filter_object(value, exclude_only)
+            next if discarded?(filtered_value)
+          else
+            filtered_value = value
+          end
+
+          filtered[filtered_key] = filtered_value
+        end
+
+        filtered_hash.empty? && !hash.empty? ? DISCARDED : filtered_hash
+      end
+
+      def pre_filter_array(array, options)
+        filtered_array = array.each_with_object([]) do |element, filtered|
+          filtered_element = pre_filter_object(element, options)
+          next if discarded?(filtered_element)
+
+          filtered.push(filtered_element)
+        end
+
+        filtered_array.empty? && !array.empty? ? DISCARDED : filtered_array
+      end
+
+      def pre_filter_scalar(scalar, options)
+        return DISCARDED if options.key?(:include) && !scalar.to_s.match?(options[:include])
+        return DISCARDED if options.key?(:exclude) && scalar.to_s.match?(options[:exclude])
+
+        scalar
+      end
+
+      # `nil`, empty enumerable objects, and `false` are all valid in their
+      # own right as application data, so pre-filtering uses a special value
+      # to indicate that filtered out data has been discarded
+      def discarded?(object)
+        object == DISCARDED
+      end
+    end
+  end
+end

data/lib/new_relic/agent/attribute_processing.rb

@@ -1,29 +1,29 @@
-# 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 AttributeProcessing
       module_function
 
-      EMPTY_HASH_STRING_LITERAL = "{}".freeze
-      EMPTY_ARRAY_STRING_LITERAL = "[]".freeze
+      EMPTY_HASH_STRING_LITERAL = '{}'.freeze
+      EMPTY_ARRAY_STRING_LITERAL = '[]'.freeze
 
       def flatten_and_coerce(object, prefix = nil, result = {}, &blk)
-        if object.is_a? Hash
+        if object.is_a?(Hash)
           flatten_and_coerce_hash(object, prefix, result, &blk)
-        elsif object.is_a? Array
+        elsif object.is_a?(Array)
           flatten_and_coerce_array(object, prefix, result, &blk)
         elsif prefix
           val = Coerce.scalar(object)
           if blk
-            blk.call(prefix, val)
+            yield(prefix, val)
           elsif !val.nil?
             result[prefix] = val
           end
         else
-          NewRelic::Agent.logger.warn "Unexpected object: #{object.inspect} with nil prefix passed to NewRelic::Agent::AttributeProcessing.flatten_and_coerce"
+          NewRelic::Agent.logger.warn("Unexpected object: #{object.inspect} with nil prefix passed to NewRelic::Agent::AttributeProcessing.flatten_and_coerce")
         end
         result
       end
@@ -31,7 +31,7 @@ module NewRelic
       def flatten_and_coerce_hash(hash, prefix, result, &blk)
         if hash.empty?
           if blk
-            blk.call(prefix, EMPTY_HASH_STRING_LITERAL)
+            yield(prefix, EMPTY_HASH_STRING_LITERAL)
           else
             result[prefix] = EMPTY_HASH_STRING_LITERAL
           end
@@ -46,7 +46,7 @@ module NewRelic
       def flatten_and_coerce_array(array, prefix, result, &blk)
         if array.empty?
           if blk
-            blk.call(prefix, EMPTY_ARRAY_STRING_LITERAL)
+            yield(prefix, EMPTY_ARRAY_STRING_LITERAL)
           else
             result[prefix] = EMPTY_ARRAY_STRING_LITERAL
           end

data/lib/new_relic/agent/attributes.rb

@@ -1,13 +1,13 @@
-# 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/attribute_processing'
 
 module NewRelic
   module Agent
     class Attributes
-      KEY_LIMIT   = 255
+      KEY_LIMIT = 255
       VALUE_LIMIT = 255
       COUNT_LIMIT = 64
 
@@ -34,7 +34,7 @@ module NewRelic
       end
 
       def add_agent_attribute_with_key_check(key, value, default_destinations)
-        if exceeds_bytesize_limit? key, KEY_LIMIT
+        if exceeds_bytesize_limit?(key, KEY_LIMIT)
           NewRelic::Agent.logger.debug("Agent attribute #{key} was dropped for exceeding key length limit #{KEY_LIMIT}")
           return
         end
@@ -58,6 +58,7 @@ module NewRelic
       def merge_custom_attributes(other)
         return unless Agent.config[:'custom_attributes.enabled']
         return if other.empty?
+
         AttributeProcessing.flatten_and_coerce(other) do |k, v|
           add_custom_attribute(k, v)
         end
@@ -73,7 +74,7 @@ module NewRelic
 
       def intrinsic_attributes_for(destination)
         if destination == NewRelic::Agent::AttributeFilter::DST_TRANSACTION_TRACER ||
-           destination == NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
+            destination == NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
           @intrinsic_attributes
         else
           NewRelic::EMPTY_HASH

data/lib/new_relic/agent/audit_logger.rb

@@ -1,10 +1,11 @@
-# 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 'logger'
 require 'fileutils'
 require 'new_relic/agent/hostname'
+require 'new_relic/agent/instrumentation/logger/instrumentation'
 
 module NewRelic
   module Agent
@@ -28,11 +29,12 @@ module NewRelic
 
       def log_request_headers(uri, headers)
         return unless enabled? && allowed_endpoint?(uri)
+
         @log.info("REQUEST HEADERS: #{headers}")
       rescue StandardError, SystemStackError, SystemCallError => e
-        ::NewRelic::Agent.logger.warn("Failed writing request headers to audit log", e)
+        ::NewRelic::Agent.logger.warn('Failed writing request headers to audit log', e)
       rescue Exception => e
-        ::NewRelic::Agent.logger.warn("Failed writing request headers to audit log with exception. Re-raising in case of interrupt.", e)
+        ::NewRelic::Agent.logger.warn('Failed writing request headers to audit log with exception. Re-raising in case of interrupt.', e)
         raise
       end
 
@@ -48,9 +50,9 @@ module NewRelic
         @log.info("REQUEST: #{uri}")
         @log.info("REQUEST BODY: #{request_body}")
       rescue StandardError, SystemStackError, SystemCallError => e
-        ::NewRelic::Agent.logger.warn("Failed writing to audit log", e)
+        ::NewRelic::Agent.logger.warn('Failed writing to audit log', e)
       rescue Exception => e
-        ::NewRelic::Agent.logger.warn("Failed writing to audit log with exception. Re-raising in case of interrupt.", e)
+        ::NewRelic::Agent.logger.warn('Failed writing to audit log with exception. Re-raising in case of interrupt.', e)
         raise
       end
 
@@ -62,7 +64,7 @@ module NewRelic
         if wants_stdout?
           # Using $stdout global for easier reassignment in testing
           @log = ::Logger.new($stdout)
-          ::NewRelic::Agent.logger.info("Audit log enabled to STDOUT")
+          ::NewRelic::Agent.logger.info('Audit log enabled to STDOUT')
         elsif path = ensure_log_path
           @log = ::Logger.new(path)
           ::NewRelic::Agent.logger.info("Audit log enabled at '#{path}'")
@@ -70,6 +72,9 @@ module NewRelic
           @log = NewRelic::Agent::NullLogger.new
         end
 
+        # Never have agent log forwarding capture audits
+        NewRelic::Agent::Instrumentation::Logger.mark_skip_instrumenting(@log)
+
         @log.formatter = create_log_formatter
       end
 
@@ -90,13 +95,13 @@ module NewRelic
       end
 
       def wants_stdout?
-        ::NewRelic::Agent.config[:'audit_log.path'].upcase == "STDOUT"
+        ::NewRelic::Agent.config[:'audit_log.path'].casecmp(NewRelic::STANDARD_OUT) == 0
       end
 
       def create_log_formatter
         @hostname = NewRelic::Agent::Hostname.get
         @prefix = wants_stdout? ? '** [NewRelic]' : ''
-        Proc.new do |severity, time, progname, msg|
+        proc do |severity, time, progname, msg|
           "#{@prefix}[#{time} #{@hostname} (#{$$})] : #{msg}\n"
         end
       end

data/lib/new_relic/agent/autostart.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
@@ -18,25 +18,32 @@ module NewRelic
     module Autostart
       extend self
 
-
       # The constants, executables (i.e. $0) and rake tasks used can be
       # configured with the config keys 'autostart.denylisted_constants',
       # 'autostart.denylisted_executables' and
       # 'autostart.denylisted_rake_tasks'
       def agent_should_start?
-          !denylisted_constants? &&
+        !denylisted_constants? &&
           !denylisted_executables? &&
           !in_denylisted_rake_task?
       end
 
-      COMMA = ",".freeze
+      COMMA = ','.freeze
 
       def denylisted_constants?
-        # For backwards compatibility until :'autostart_blacklisted_constants' config option is removed
-        constants = NewRelic::Agent.config[:'autostart.denylisted_constants'] << COMMA << NewRelic::Agent.config[:'autostart.blacklisted_constants']
-
-        denylisted?(constants) do |name|
-          constant_is_defined?(name)
+        denylisted?(NewRelic::Agent.config[:'autostart.denylisted_constants']) do |name|
+          if RUBY_PLATFORM.eql?('java')
+            # As of JRuby 9.3.4.0, Object.const_defined? will still cross
+            # namespaces to find constants, which is not what we want. This
+            # behavior is similar to CRuby's Object.const_get prior to v2.6.
+            #
+            # Example:
+            #  irb> class MyClass; end; module MyModule; end
+            #  irb> Object.const_defined?('MyModule::MyClass') # => true
+            !!::NewRelic::LanguageSupport.constantize(name)
+          else
+            Object.const_defined?(name)
+          end
         end
       end
 
@@ -46,23 +53,17 @@ module NewRelic
         end
       end
 
-      # Lookup whether namespaced constants (e.g. ::Foo::Bar::Baz) are in the
-      # environment.
-      def constant_is_defined?(const_name)
-        !!::NewRelic::LanguageSupport.constantize(const_name)
-      end
-
       def denylisted?(value, &block)
         value.split(/\s*,\s*/).any?(&block)
       end
 
       def in_denylisted_rake_task?
         tasks = begin
-                  ::Rake.application.top_level_tasks
-                rescue => e
-            ::NewRelic::Agent.logger.debug("Not in Rake environment so skipping denylisted_rake_tasks check: #{e}")
-            []
-          end
+          ::Rake.application.top_level_tasks
+        rescue => e
+          ::NewRelic::Agent.logger.debug("Not in Rake environment so skipping denylisted_rake_tasks check: #{e}")
+          NewRelic::EMPTY_ARRAY
+        end
         !(tasks & ::NewRelic::Agent.config[:'autostart.denylisted_rake_tasks'].split(/\s*,\s*/)).empty?
       end
     end

data/lib/new_relic/agent/chained_call.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
 
 # This class is used by NewRelic::Agent.set_sql_obfuscator to chain multiple
 # obfuscation blocks when not using the default :replace action

data/lib/new_relic/agent/commands/agent_command.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
@@ -9,9 +9,9 @@ module NewRelic
         attr_reader :id, :name, :arguments
 
         def initialize(raw_collector_command)
-          @id        = raw_collector_command[0]
-          @name      = raw_collector_command[1]["name"]
-          @arguments = raw_collector_command[1]["arguments"]
+          @id = raw_collector_command[0]
+          @name = raw_collector_command[1]['name']
+          @arguments = raw_collector_command[1]['arguments']
         end
       end
     end

data/lib/new_relic/agent/commands/agent_command_router.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
 
 # This class is the central point for dispatching get_agent_commands messages
 # to the various components that actually process them.
@@ -19,17 +19,18 @@ module NewRelic
 
         attr_accessor :thread_profiler_session, :backtrace_service
 
-        def initialize(event_listener=nil)
-          @handlers    = Hash.new { |*| Proc.new { |cmd| self.unrecognized_agent_command(cmd) } }
+        def initialize(event_listener = nil)
+          @handlers = Hash.new { |*| proc { |cmd| self.unrecognized_agent_command(cmd) } }
 
           @backtrace_service = Threading::BacktraceService.new(event_listener)
 
           @thread_profiler_session = ThreadProfilerSession.new(@backtrace_service)
 
-          @handlers['start_profiler'] = Proc.new { |cmd| thread_profiler_session.handle_start_command(cmd) }
-          @handlers['stop_profiler']  = Proc.new { |cmd| thread_profiler_session.handle_stop_command(cmd) }
+          @handlers['start_profiler'] = proc { |cmd| thread_profiler_session.handle_start_command(cmd) }
+          @handlers['stop_profiler'] = proc { |cmd| thread_profiler_session.handle_stop_command(cmd) }
 
-          if event_listener
+          # the following statement needs else branch coverage
+          if event_listener # rubocop:disable Style/SafeNavigation
             event_listener.subscribe(:before_shutdown, &method(:on_before_shutdown))
           end
         end
@@ -63,6 +64,7 @@ module NewRelic
         # Same with reset! - we don't support asynchronous cancellation of a
         # running thread profile currently.
         def merge!(*args); end
+
         def reset!; end
 
         def harvest_from_thread_profiler_session
@@ -76,17 +78,17 @@ module NewRelic
 
         def log_profiles(profiles)
           if profiles.empty?
-            ::NewRelic::Agent.logger.debug "No thread profiles with data found to send."
+            ::NewRelic::Agent.logger.debug('No thread profiles with data found to send.')
           else
             profile_descriptions = profiles.map { |p| p.to_log_description }
-            ::NewRelic::Agent.logger.debug "Sending thread profiles [#{profile_descriptions.join(", ")}]"
+            ::NewRelic::Agent.logger.debug("Sending thread profiles [#{profile_descriptions.join(', ')}]")
           end
         end
 
         def get_agent_commands
           commands = new_relic_service.get_agent_commands
-          NewRelic::Agent.logger.debug "Received get_agent_commands = #{commands.inspect}"
-          commands.map {|collector_command| AgentCommand.new(collector_command)}
+          NewRelic::Agent.logger.debug("Received get_agent_commands = #{commands.inspect}")
+          commands.map { |collector_command| AgentCommand.new(collector_command) }
         end
 
         def invoke_commands(agent_commands)
@@ -112,15 +114,15 @@ module NewRelic
           end
         end
 
-        SUCCESS_RESULT = {}.freeze
-        ERROR_KEY = "error"
+        SUCCESS_RESULT = NewRelic::EMPTY_HASH
+        ERROR_KEY = 'error'
 
         def success
           SUCCESS_RESULT
         end
 
         def error(err)
-          { ERROR_KEY => err.message }
+          {ERROR_KEY => err.message}
         end
 
         def call_handler_for(agent_command)

data/lib/new_relic/agent/commands/thread_profiler_session.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/threading/agent_thread'
 require 'new_relic/agent/threading/backtrace_service'
@@ -9,9 +9,7 @@ require 'new_relic/agent/threading/thread_profile'
 module NewRelic
   module Agent
     module Commands
-
       class ThreadProfilerSession
-
         def initialize(backtrace_service)
           @backtrace_service = backtrace_service
           @started_at = nil
@@ -27,31 +25,34 @@ module NewRelic
         end
 
         def handle_stop_command(agent_command)
-          report_data = agent_command.arguments.fetch("report_data", true)
+          report_data = agent_command.arguments.fetch('report_data', true)
           stop(report_data)
         end
 
         def start(agent_command)
-          NewRelic::Agent.logger.debug("Starting Thread Profiler.")
+          NewRelic::Agent.logger.debug('Starting Thread Profiler.')
           profile = @backtrace_service.subscribe(
             NewRelic::Agent::Threading::BacktraceService::ALL_TRANSACTIONS,
             agent_command.arguments
           )
 
-          @started_at = Time.now
+          @started_at = Process.clock_gettime(Process::CLOCK_REALTIME)
           @duration = profile.duration if profile
         end
 
         def stop(report_data)
           return unless running?
-          NewRelic::Agent.logger.debug("Stopping Thread Profiler.")
+
+          NewRelic::Agent.logger.debug('Stopping Thread Profiler.')
           @finished_profile = @backtrace_service.harvest(NewRelic::Agent::Threading::BacktraceService::ALL_TRANSACTIONS)
           @backtrace_service.unsubscribe(NewRelic::Agent::Threading::BacktraceService::ALL_TRANSACTIONS)
           @finished_profile = nil if !report_data
         end
 
         def harvest
-          NewRelic::Agent.logger.debug("Harvesting from Thread Profiler #{@finished_profile.to_log_description unless @finished_profile.nil?}")
+          NewRelic::Agent.logger.debug(
+            "Harvesting from Thread Profiler #{@finished_profile&.to_log_description}"
+          )
           profile = @finished_profile
           @backtrace_service.profile_agent_code = false
           @finished_profile = nil
@@ -72,7 +73,9 @@ module NewRelic
         end
 
         def past_time?
-          @started_at && (Time.now > @started_at + @duration)
+          @started_at && (
+            Process.clock_gettime(Process::CLOCK_REALTIME) > @started_at + @duration
+          )
         end
 
         def stopped?
@@ -86,9 +89,9 @@ module NewRelic
         end
 
         def raise_unsupported_error
-          msg = <<-EOF
-Thread profiling is not supported for Resque processes. If you did not intend to
-profile a Resque process, profiling again might select an appropriate agent.
+          msg = <<~EOF
+            Thread profiling is not supported for Resque processes. If you did not intend to
+            profile a Resque process, profiling again might select an appropriate agent.
           EOF
           raise_command_error(msg)
         end
@@ -99,10 +102,9 @@ profile a Resque process, profiling again might select an appropriate agent.
         end
 
         def raise_already_started_error
-          msg = "Profile already in progress. Ignoring agent command to start another."
+          msg = 'Profile already in progress. Ignoring agent command to start another.'
           raise_command_error(msg)
         end
-
       end
     end
   end