newrelic_rpm 7.0.0 → 9.0.0

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

@@ -1,12 +1,12 @@
-# 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 Configuration
       class DottedHash < ::Hash
-        def initialize(hash, keep_nesting=false)
+        def initialize(hash, keep_nesting = false)
           # Add the hash keys to our collection explicitly so they survive the
           # dot flattening.  This is typical for full config source instances,
           # but not for uses of DottedHash serializing for transmission.
@@ -31,10 +31,12 @@ module NewRelic
         end
 
         protected
+
         # turns {'a' => {'b' => 'c'}} into {'a.b' => 'c'}
-        def dot_flattened(nested_hash, names=[], result={})
+        def dot_flattened(nested_hash, names = [], result = {})
           nested_hash.each do |key, val|
-            next if val == nil
+            next if val.nil?
+
             if val.respond_to?(:has_key?)
               dot_flattened(val, names + [key], result)
             else
@@ -44,7 +46,6 @@ module NewRelic
           result
         end
       end
-
     end
   end
 end

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

@@ -1,15 +1,15 @@
-# 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 Configuration
       class EnvironmentSource < DottedHash
         SUPPORTED_PREFIXES = /^new_relic_|^newrelic_/i
-        SPECIAL_CASE_KEYS  = [
+        SPECIAL_CASE_KEYS = [
           'NEW_RELIC_ENV', # read by NewRelic::Control::Frameworks::Ruby
-          'NEW_RELIC_LOG',  # read by set_log_file
+          'NEW_RELIC_LOG', # read by set_log_file
           /^NEW_RELIC_METADATA_/ # read by NewRelic::Agent::Connect::RequestBuilder
         ]
 
@@ -34,6 +34,7 @@ module NewRelic
           set_dotted_alias(config_setting)
 
           return unless value[:aliases]
+
           value[:aliases].each do |config_alias|
             self.alias_map[config_alias] = config_setting
           end
@@ -42,16 +43,16 @@ module NewRelic
         def set_dotted_alias(original_config_setting)
           config_setting = original_config_setting.to_s
 
-          if config_setting.include? '.'
-            config_alias = config_setting.gsub(/\./,'_').to_sym
+          if config_setting.include?('.')
+            config_alias = config_setting.tr('.', '_').to_sym
             self.alias_map[config_alias] = original_config_setting
           end
         end
 
         def set_log_file
           if ENV['NEW_RELIC_LOG']
-            if ENV['NEW_RELIC_LOG'].upcase == 'STDOUT'
-              self[:log_file_path] = self[:log_file_name] = 'STDOUT'
+            if ENV['NEW_RELIC_LOG'].casecmp(NewRelic::STANDARD_OUT) == 0
+              self[:log_file_path] = self[:log_file_name] = NewRelic::STANDARD_OUT
             else
               self[:log_file_path] = File.dirname(ENV['NEW_RELIC_LOG'])
               self[:log_file_name] = File.basename(ENV['NEW_RELIC_LOG'])
@@ -90,10 +91,12 @@ module NewRelic
             self[config_key] = value.to_f
           elsif type == Symbol
             self[config_key] = value.to_sym
+          elsif type == Array
+            self[config_key] = value.split(/\s*,\s*/)
           elsif type == NewRelic::Agent::Configuration::Boolean
             if value =~ /false|off|no/i
               self[config_key] = false
-            elsif value != nil
+            elsif !value.nil?
               self[config_key] = true
             end
           else
@@ -111,7 +114,6 @@ module NewRelic
         def collect_new_relic_environment_variable_keys
           ENV.keys.select { |key| key.match(SUPPORTED_PREFIXES) }
         end
-
       end
     end
   end

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

@@ -1,42 +1,65 @@
-# 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 Configuration
       module EventHarvestConfig
-
         extend self
 
         EVENT_HARVEST_CONFIG_KEY_MAPPING = {
-          :analytic_event_data => :'analytics_events.max_samples_stored',
+          :analytic_event_data => :'transaction_events.max_samples_stored',
           :custom_event_data => :'custom_insights_events.max_samples_stored',
           :error_event_data => :'error_collector.max_event_samples_stored',
-          :span_event_data => :'span_events.max_samples_stored'
+          :log_event_data => :'application_logging.forwarding.max_samples_stored'
+        }
+
+        # not including span_event_data here because spans are handled separately in transform_span_event_harvest_config
+        EVENT_HARVEST_EVENT_REPORT_PERIOD_KEY_MAPPING = {
+          :analytic_event_data => :'transaction_event_data',
+          :custom_event_data => :'custom_event_data',
+          :error_event_data => :'error_event_data',
+          :log_event_data => :'log_event_data'
         }
 
         def from_config(config)
-          {:harvest_limits => EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do
-            |connect_payload, (connect_payload_key, config_key)|
+          {:harvest_limits =>
+            EVENT_HARVEST_CONFIG_KEY_MAPPING.merge(
+              :span_event_data => :'span_events.max_samples_stored'
+            ).inject({}) do |connect_payload, (connect_payload_key, config_key)|
               connect_payload[connect_payload_key] = config[config_key]
               connect_payload
-            end
-          }
+            end}
         end
 
         def to_config_hash(connect_reply)
           event_harvest_interval = connect_reply['event_harvest_config']['report_period_ms'] / 1000
-          config_hash = EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do
-            |event_harvest_config, (connect_payload_key, config_key)|
-              if harvest_limit = connect_reply['event_harvest_config']['harvest_limits'][connect_payload_key.to_s]
-                event_harvest_config[config_key] = harvest_limit
-                report_period_key = :"event_report_period.#{connect_payload_key}"
-                event_harvest_config[report_period_key] = event_harvest_interval
-              end
-              event_harvest_config
-            end
+          config_hash = transform_event_harvest_config_keys(connect_reply, event_harvest_interval)
           config_hash[:event_report_period] = event_harvest_interval
+          config_hash = transform_span_event_harvest_config(config_hash, connect_reply)
+          config_hash
+        end
+
+        private
+
+        def transform_event_harvest_config_keys(connect_reply, event_harvest_interval)
+          EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do |event_harvest_config, (connect_payload_key, config_key)|
+            if harvest_limit = connect_reply['event_harvest_config']['harvest_limits'][connect_payload_key.to_s]
+              event_harvest_config[config_key] = harvest_limit
+              report_period_key = :"event_report_period.#{EVENT_HARVEST_EVENT_REPORT_PERIOD_KEY_MAPPING[connect_payload_key]}"
+              event_harvest_config[report_period_key] = event_harvest_interval
+            end
+            event_harvest_config
+          end
+        end
+
+        def transform_span_event_harvest_config(config_hash, connect_reply)
+          if span_harvest = connect_reply['span_event_harvest_config']
+            config_hash[:'span_events.max_samples_stored'] = span_harvest['harvest_limit'] if span_harvest['harvest_limit']
+            config_hash[:'event_report_period.span_event_data'] = span_harvest['report_period_ms'] if span_harvest['report_period_ms']
+          end
+
           config_hash
         end
       end

data/lib/new_relic/agent/configuration/high_security_source.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/configuration/dotted_hash'
 
@@ -10,17 +10,16 @@ module NewRelic
       class HighSecuritySource < DottedHash
         def initialize(local_settings)
           super({
-            :capture_params           => false,
-            :'resque.capture_params'  => false,
-            :'sidekiq.capture_params' => false,
-            :'attributes.include'     => [],
+            :capture_params => false,
+            :'attributes.include' => [],
 
             :'transaction_tracer.record_sql' => record_sql_setting(local_settings, :'transaction_tracer.record_sql'),
-            :'slow_sql.record_sql'           => record_sql_setting(local_settings, :'slow_sql.record_sql'),
-            :'mongo.obfuscate_queries'       => true,
+            :'slow_sql.record_sql' => record_sql_setting(local_settings, :'slow_sql.record_sql'),
+            :'mongo.obfuscate_queries' => true,
+            :'elasticsearch.obfuscate_queries' => true,
             :'transaction_tracer.record_redis_arguments' => false,
 
-            :'custom_insights_events.enabled'   => false,
+            :'custom_insights_events.enabled' => false,
             :'strip_exception_messages.enabled' => true
           })
         end
@@ -32,7 +31,7 @@ module NewRelic
         SET_TO_OBFUSCATED = [RAW, OBFUSCATED]
 
         def record_sql_setting(local_settings, key)
-          original_value  = local_settings[key]
+          original_value = local_settings[key]
           result = if SET_TO_OBFUSCATED.include?(original_value)
             OBFUSCATED
           else

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'forwardable'
 require 'new_relic/agent/configuration/mask_defaults'
@@ -15,7 +15,6 @@ module NewRelic
   module Agent
     module Configuration
       class Manager
-
         # Defining these explicitly saves object allocations that we incur
         # if we use Forwardable and def_delegators.
         def [](key)
@@ -23,7 +22,7 @@ module NewRelic
         end
 
         def has_key?(key)
-          @cache.has_key? key
+          @cache.has_key?(key)
         end
 
         def keys
@@ -32,11 +31,12 @@ module NewRelic
 
         def initialize
           reset_to_defaults
-          @callbacks = Hash.new {|hash,key| hash[key] = [] }
+          @callbacks = Hash.new { |hash, key| hash[key] = [] }
         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
@@ -46,12 +46,12 @@ 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 :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
           end
 
           remove_config(source)
@@ -60,14 +60,14 @@ 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 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
           else
-            @configs_for_testing.delete_if {|src,lvl| src == source}
+            @configs_for_testing.delete_if { |src, lvl| src == source }
           end
 
           reset_cache
@@ -80,14 +80,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 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
           else
             NewRelic::Agent.logger.warn("Invalid config format; config will be ignored: #{source}")
           end
@@ -110,13 +111,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
@@ -134,6 +134,10 @@ module NewRelic
           end
         end
 
+        def evaluate_and_apply_transformations(key, value)
+          apply_transformations(key, evaluate_procs(value))
+        end
+
         def apply_transformations(key, value)
           if transform = transform_from_default(key)
             begin
@@ -153,19 +157,28 @@ module NewRelic
 
         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
@@ -192,9 +205,9 @@ 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
@@ -208,9 +221,9 @@ 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
 
@@ -229,9 +242,9 @@ module NewRelic
         end
 
         MALFORMED_LABELS_WARNING = "Skipping malformed labels configuration"
-        PARSING_LABELS_FAILURE   = "Failure during parsing labels. Ignoring and carrying on with connect."
+        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
@@ -243,7 +256,7 @@ module NewRelic
           end
         rescue => e
           NewRelic::Agent.logger.error(PARSING_LABELS_FAILURE, e)
-          []
+          NewRelic::EMPTY_ARRAY
         end
 
         def parse_labels_from_string
@@ -253,7 +266,7 @@ module NewRelic
         end
 
         def break_label_string_into_pairs(labels)
-          stripped_labels = labels.strip.sub(/^;*/,'').sub(/;*$/,'')
+          stripped_labels = labels.strip.sub(/^;*/, '').sub(/;*$/, '')
           stripped_labels.split(';').map do |pair|
             pair.split(':').map(&:strip)
           end
@@ -269,10 +282,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
@@ -282,21 +295,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}'"
@@ -304,7 +317,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,20 +345,20 @@ 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
+          @high_security_source = nil
+          @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
 
         def reset_cache
-          @cache = Hash.new { |hash,key| hash[key] = self.fetch(key) }
+          @cache = Hash.new { |hash, key| hash[key] = self.fetch(key) }
         end
 
         def log_config(direction, source)
@@ -360,13 +373,13 @@ module NewRelic
 
         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    = []
+          @high_security_source = nil
+          @environment_source = nil
+          @server_source = nil
+          @manual_source = nil
+          @yaml_source = nil
+          @default_source = nil
+          @configs_for_testing = []
         end
 
         def num_configs_for_testing
@@ -381,12 +394,12 @@ module NewRelic
 
         def config_stack
           stack = [@security_policy_source,
-                   @high_security_source,
-                   @environment_source,
-                   @server_source,
-                   @manual_source,
-                   @yaml_source,
-                   @default_source]
+            @high_security_source,
+            @environment_source,
+            @server_source,
+            @manual_source,
+            @yaml_source,
+            @default_source]
 
           stack.compact!
 

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/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/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