newrelic_rpm 3.12.0.288 → 9.10.2

data/lib/new_relic/agent/configuration/manager.rb

@@ -1,6 +1,6 @@
-# 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
 
 require 'forwardable'
 require 'new_relic/agent/configuration/mask_defaults'
@@ -9,12 +9,13 @@ require 'new_relic/agent/configuration/default_source'
 require 'new_relic/agent/configuration/server_source'
 require 'new_relic/agent/configuration/environment_source'
 require 'new_relic/agent/configuration/high_security_source'
+require 'new_relic/agent/configuration/security_policy_source'
 
 module NewRelic
   module Agent
     module Configuration
       class Manager
-        attr_reader :stripped_exceptions_whitelist
+        DEPENDENCY_DETECTION_VALUES = %i[prepend chain unsatisfied].freeze
 
         # Defining these explicitly saves object allocations that we incur
         # if we use Forwardable and def_delegators.
@@ -23,7 +24,7 @@ module NewRelic
         end
 
         def has_key?(key)
-          @cache.has_key?[key]
+          @cache.has_key?(key)
         end
 
         def keys
@@ -32,19 +33,13 @@ module NewRelic
 
         def initialize
           reset_to_defaults
-          @callbacks = Hash.new {|hash,key| hash[key] = [] }
-
-          register_callback(:'strip_exception_messages.whitelist') do |whitelist|
-            if whitelist
-              @stripped_exceptions_whitelist = parse_constant_list(whitelist).compact
-            else
-              @stripped_exceptions_whitelist = []
-            end
-          end
+          @callbacks = Hash.new { |hash, key| hash[key] = [] }
+          @lock = Mutex.new
         end
 
-        def add_config_for_testing(source, level=0)
+        def add_config_for_testing(source, level = 0)
           raise 'Invalid config type for testing' unless [Hash, DottedHash].include?(source.class)
+
           invoke_callbacks(:add, source)
           @configs_for_testing << [source.freeze, level]
           reset_cache
@@ -53,12 +48,13 @@ module NewRelic
 
         def remove_config_type(sym)
           source = case sym
+          when :security_policy then @security_policy_source
           when :high_security then @high_security_source
-          when :environment   then @environment_source
-          when :server        then @server_source
-          when :manual        then @manual_source
-          when :yaml          then @yaml_source
-          when :default       then @default_source
+          when :environment then @environment_source
+          when :server then @server_source
+          when :manual then @manual_source
+          when :yaml then @yaml_source
+          when :default then @default_source
           end
 
           remove_config(source)
@@ -66,14 +62,15 @@ module NewRelic
 
         def remove_config(source)
           case source
+          when SecurityPolicySource then @security_policy_source = nil
           when HighSecuritySource then @high_security_source = nil
-          when EnvironmentSource  then @environment_source   = nil
-          when ServerSource       then @server_source        = nil
-          when ManualSource       then @manual_source        = nil
-          when YamlSource         then @yaml_source          = nil
-          when DefaultSource      then @default_source       = nil
+          when EnvironmentSource then @environment_source = nil
+          when ServerSource then @server_source = nil
+          when ManualSource then @manual_source = nil
+          when YamlSource then @yaml_source = nil
+          when DefaultSource then @default_source = nil
           else
-            @configs_for_testing.delete_if {|src,lvl| src == source}
+            @configs_for_testing.delete_if { |src, lvl| src == source }
           end
 
           reset_cache
@@ -86,13 +83,15 @@ module NewRelic
           was_finished = finished_configuring?
 
           invoke_callbacks(:add, source)
+
           case source
+          when SecurityPolicySource then @security_policy_source = source
           when HighSecuritySource then @high_security_source = source
-          when EnvironmentSource  then @environment_source   = source
-          when ServerSource       then @server_source        = source
-          when ManualSource       then @manual_source        = source
-          when YamlSource         then @yaml_source          = source
-          when DefaultSource      then @default_source       = source
+          when EnvironmentSource then @environment_source = source
+          when ServerSource then @server_source = source
+          when ManualSource then @manual_source = source
+          when YamlSource then @yaml_source = source
+          when DefaultSource then @default_source = source
           else
             NewRelic::Agent.logger.warn("Invalid config format; config will be ignored: #{source}")
           end
@@ -100,6 +99,7 @@ module NewRelic
           reset_cache
           log_config(:add, source)
 
+          notify_server_source_added if ServerSource === source
           notify_finished_configuring if !was_finished && finished_configuring?
         end
 
@@ -114,13 +114,12 @@ module NewRelic
         def fetch(key)
           config_stack.each do |config|
             next unless config
+
             accessor = key.to_sym
 
             if config.has_key?(accessor)
-              evaluated = evaluate_procs(config[accessor])
-
               begin
-                return apply_transformations(accessor, evaluated)
+                return evaluate_and_apply_transformations(accessor, config[accessor])
               rescue
                 next
               end
@@ -138,12 +137,20 @@ module NewRelic
           end
         end
 
+        def evaluate_and_apply_transformations(key, value)
+          evaluated = evaluate_procs(value)
+          default = enforce_allowlist(key, evaluated)
+          return default if default
+
+          apply_transformations(key, evaluated)
+        end
+
         def apply_transformations(key, value)
           if transform = transform_from_default(key)
             begin
               transform.call(value)
             rescue => e
-              ::NewRelic::Agent.logger.error("Error applying transformation for #{key}, falling back to #{value}.", e)
+              NewRelic::Agent.logger.error("Error applying transformation for #{key}, pre-transform value was: #{value}.", e)
               raise e
             end
           else
@@ -151,33 +158,66 @@ module NewRelic
           end
         end
 
+        def enforce_allowlist(key, value)
+          return unless allowlist = default_source.allowlist_for(key)
+          return if allowlist.include?(value)
+
+          default = default_source.default_for(key)
+          NewRelic::Agent.logger.warn "Invalid value '#{value}' for #{key}, applying default value of '#{default}'"
+          default
+        end
+
         def transform_from_default(key)
-          ::NewRelic::Agent::Configuration::DefaultSource.transform_for(key)
+          default_source.transform_for(key)
+        end
+
+        def default_source
+          NewRelic::Agent::Configuration::DefaultSource
         end
 
         def register_callback(key, &proc)
           @callbacks[key] << proc
-          proc.call(@cache[key])
+          yield(@cache[key])
         end
 
         def invoke_callbacks(direction, source)
           return unless source
+
           source.keys.each do |key|
+            begin
+              # we need to evaluate and apply transformations for the value to deal with procs as values
+              # this is usually done by the fetch method when accessing config, however the callbacks bypass that
+              evaluated_cache = evaluate_and_apply_transformations(key, @cache[key])
+              evaluated_source = evaluate_and_apply_transformations(key, source[key])
+            rescue
+              next
+            end
 
-            if @cache[key] != source[key]
+            if evaluated_cache != evaluated_source
               @callbacks[key].each do |proc|
                 if direction == :add
-                  proc.call(source[key])
+                  proc.call(evaluated_source)
                 else
-                  proc.call(@cache[key])
+                  proc.call(evaluated_cache)
                 end
               end
             end
           end
         end
 
+        # This event is intended to be fired every time the server source is
+        # applied.  This happens after the agent's initial connect, and again
+        # on every forced reconnect.
+        def notify_server_source_added
+          NewRelic::Agent.instance.events.notify(:server_source_configuration_added)
+        end
+
+        # This event is intended to be fired once during the entire lifespan of
+        # an agent run, after the server source has been applied for the first
+        # time.  This should indicate that all configuration has been applied,
+        # and the main functions of the agent are safe to start.
         def notify_finished_configuring
-          NewRelic::Agent.instance.events.notify(:finished_configuring)
+          NewRelic::Agent.instance.events.notify(:initial_configuration_complete)
         end
 
         def finished_configuring?
@@ -185,13 +225,13 @@ module NewRelic
         end
 
         def flattened
-          config_stack.reverse.inject({}) do |flat,layer|
+          config_stack.reverse.inject({}) do |flat, layer|
             thawed_layer = layer.to_hash.dup
-            thawed_layer.each do |k,v|
+            thawed_layer.each do |k, v|
               begin
                 thawed_layer[k] = instance_eval(&v) if v.respond_to?(:call)
               rescue => e
-                ::NewRelic::Agent.logger.debug("#{e.class.name} : #{e.message} - when accessing config key #{k}")
+                NewRelic::Agent.logger.debug("#{e.class.name} : #{e.message} - when accessing config key #{k}")
                 thawed_layer[k] = nil
               end
               thawed_layer.delete(:config)
@@ -201,14 +241,14 @@ module NewRelic
         end
 
         def apply_mask(hash)
-          MASK_DEFAULTS. \
-            select {|_, proc| proc.call}. \
-            each {|key, _| hash.delete(key) }
+          MASK_DEFAULTS \
+            .select { |_, proc| proc.call } \
+            .each { |key, _| hash.delete(key) }
           hash
         end
 
         def to_collector_hash
-          DottedHash.new(apply_mask(flattened)).to_hash.delete_if do |k, v|
+          DottedHash.new(apply_mask(flattened)).to_hash.delete_if do |k, _v|
             default = DEFAULTS[k]
             if default
               default[:exclude_from_reported_settings]
@@ -221,18 +261,10 @@ module NewRelic
           end
         end
 
-        def app_names
-          case NewRelic::Agent.config[:app_name]
-          when Array then NewRelic::Agent.config[:app_name]
-          when String then NewRelic::Agent.config[:app_name].split(';')
-          else []
-          end
-        end
+        MALFORMED_LABELS_WARNING = 'Skipping malformed labels configuration'
+        PARSING_LABELS_FAILURE = 'Failure during parsing labels. Ignoring and carrying on with connect.'
 
-        MALFORMED_LABELS_WARNING = "Skipping malformed labels configuration"
-        PARSING_LABELS_FAILURE   = "Failure during parsing labels. Ignoring and carrying on with connect."
-
-        MAX_LABEL_COUNT  = 64
+        MAX_LABEL_COUNT = 64
         MAX_LABEL_LENGTH = 255
 
         def parsed_labels
@@ -244,7 +276,7 @@ module NewRelic
           end
         rescue => e
           NewRelic::Agent.logger.error(PARSING_LABELS_FAILURE, e)
-          []
+          NewRelic::EMPTY_ARRAY
         end
 
         def parse_labels_from_string
@@ -254,7 +286,7 @@ module NewRelic
         end
 
         def break_label_string_into_pairs(labels)
-          stripped_labels = labels.strip
+          stripped_labels = labels.strip.sub(/^;*/, '').sub(/;*$/, '')
           stripped_labels.split(';').map do |pair|
             pair.split(':').map(&:strip)
           end
@@ -270,10 +302,10 @@ module NewRelic
 
         def valid_label_item?(item)
           case item
-          when String  then !item.empty?
+          when String then !item.empty?
           when Numeric then true
-          when true    then true
-          when false   then true
+          when true then true
+          when false then true
           else false
           end
         end
@@ -283,21 +315,21 @@ module NewRelic
           pairs = Array(pairs)
 
           unless valid_label_pairs?(pairs)
-            NewRelic::Agent.logger.warn("#{MALFORMED_LABELS_WARNING}: #{labels||pairs}")
-            return []
+            NewRelic::Agent.logger.warn("#{MALFORMED_LABELS_WARNING}: #{labels || pairs}")
+            return NewRelic::EMPTY_ARRAY
           end
 
           pairs = limit_number_of_labels(pairs)
           pairs = remove_duplicates(pairs)
           pairs.map do |key, value|
             {
-              'label_type'  => truncate(key),
+              'label_type' => truncate(key),
               'label_value' => truncate(value.to_s, key)
             }
           end
         end
 
-        def truncate(text, key=nil)
+        def truncate(text, key = nil)
           if text.length > MAX_LABEL_LENGTH
             if key
               msg = "The value for the label '#{key}' is longer than the allowed #{MAX_LABEL_LENGTH} and will be truncated. Value = '#{text}'"
@@ -305,7 +337,7 @@ module NewRelic
               msg = "Label name longer than the allowed #{MAX_LABEL_LENGTH} will be truncated. Name = '#{text}'"
             end
             NewRelic::Agent.logger.warn(msg)
-            text[0..MAX_LABEL_LENGTH-1]
+            text[0..MAX_LABEL_LENGTH - 1]
           else
             text
           end
@@ -332,40 +364,57 @@ module NewRelic
 
         # Generally only useful during initial construction and tests
         def reset_to_defaults
+          @security_policy_source = nil
           @high_security_source = nil
-          @environment_source   = EnvironmentSource.new
-          @server_source        = nil
-          @manual_source        = nil
-          @yaml_source          = nil
-          @default_source       = DefaultSource.new
+          @environment_source = EnvironmentSource.new
+          @server_source = nil
+          @manual_source = nil
+          @yaml_source = nil
+          @default_source = DefaultSource.new
 
-          @configs_for_testing  = []
+          @configs_for_testing = []
 
           reset_cache
         end
 
+        # reset the configuration hash, but do not replace previously auto
+        # determined dependency detection values with nil or 'auto'
         def reset_cache
-          @cache = Hash.new {|hash,key| hash[key] = self.fetch(key) }
+          return new_cache unless defined?(@cache) && @cache
+
+          @lock.synchronize do
+            preserved = @cache.dup.select { |_k, v| DEPENDENCY_DETECTION_VALUES.include?(v) }
+            new_cache
+            preserved.each { |k, v| @cache[k] = v }
+          end
+
+          @cache
+        end
+
+        def new_cache
+          @cache = Hash.new { |hash, key| hash[key] = self.fetch(key) }
         end
 
         def log_config(direction, source)
-          # Just generating this log message (specifically calling
-          # flattened.inspect) is expensive enough that we don't want to do it
-          # unless we're actually going to be logging the message based on our
-          # current log level.
-          ::NewRelic::Agent.logger.debug do
-            "Updating config (#{direction}) from #{source.class}. Results: #{flattened.inspect}"
+          # Just generating this log message (specifically calling `flattened`)
+          # is expensive enough that we don't want to do it unless we're
+          # actually going to be logging the message based on our current log
+          # level, so use a `do` block.
+          NewRelic::Agent.logger.debug do
+            hash = flattened.delete_if { |k, _h| DEFAULTS.fetch(k, {}).fetch(:exclude_from_reported_settings, false) }
+            "Updating config (#{direction}) from #{source.class}. Results: #{hash.inspect}"
           end
         end
 
         def delete_all_configs_for_testing
+          @security_policy_source = nil
           @high_security_source = nil
-          @environment_source   = nil
-          @server_source        = nil
-          @manual_source        = nil
-          @yaml_source          = nil
-          @default_source       = nil
-          @configs_for_testing  = []
+          @environment_source = nil
+          @server_source = nil
+          @manual_source = nil
+          @yaml_source = nil
+          @default_source = nil
+          @configs_for_testing = []
         end
 
         def num_configs_for_testing
@@ -379,12 +428,13 @@ module NewRelic
         private
 
         def config_stack
-          stack = [@high_security_source,
-                   @environment_source,
-                   @server_source,
-                   @manual_source,
-                   @yaml_source,
-                   @default_source]
+          stack = [@security_policy_source,
+            @high_security_source,
+            @environment_source,
+            @server_source,
+            @manual_source,
+            @yaml_source,
+            @default_source]
 
           stack.compact!
 
@@ -398,27 +448,6 @@ module NewRelic
 
           stack
         end
-
-        def parse_constant_list(list)
-          list.split(/\s*,\s*/).map do |class_name|
-            const = constantize(class_name)
-
-            unless const
-              NewRelic::Agent.logger.warn "Configuration referenced undefined constant: #{class_name}"
-            end
-
-            const
-          end
-        end
-
-        def constantize(class_name)
-          namespaces = class_name.split('::')
-
-          namespaces.inject(Object) do |namespace, name|
-            return unless namespace
-            namespace.const_get(name) if namespace.const_defined?(name)
-          end
-        end
       end
     end
   end

data/lib/new_relic/agent/configuration/manual_source.rb

@@ -1,6 +1,6 @@
-# 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
 
 require 'new_relic/agent/configuration/dotted_hash'
 

data/lib/new_relic/agent/configuration/mask_defaults.rb

@@ -1,13 +1,13 @@
-# 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
 
 module NewRelic
   module Agent
     module Configuration
       MASK_DEFAULTS = {
-        :'thread_profiler' =>         Proc.new { !NewRelic::Agent::Threading::BacktraceService.is_supported? },
-        :'thread_profiler.enabled' => Proc.new { !NewRelic::Agent::Threading::BacktraceService.is_supported? }
+        :'thread_profiler' => proc { !NewRelic::Agent::Threading::BacktraceService.is_supported? },
+        :'thread_profiler.enabled' => proc { !NewRelic::Agent::Threading::BacktraceService.is_supported? }
       }
     end
   end