newrelic_rpm 8.15.0 → 9.6.0

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

@@ -94,14 +94,14 @@ module NewRelic
           elsif type == Array
             self[config_key] = value.split(/\s*,\s*/)
           elsif type == NewRelic::Agent::Configuration::Boolean
-            if value =~ /false|off|no/i
+            if /false|off|no/i.match?(value)
               self[config_key] = false
             elsif !value.nil?
               self[config_key] = true
             end
           else
             ::NewRelic::Agent.logger.info("#{environment_key} does not have a corresponding configuration setting (#{config_key} does not exist).")
-            ::NewRelic::Agent.logger.info("Run `rake newrelic:config:docs` or visit https://newrelic.com/docs/ruby/ruby-agent-configuration to see a list of available configuration settings.")
+            ::NewRelic::Agent.logger.info('Run `rake newrelic:config:docs` or visit https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration to see a list of available configuration settings.')
             self[config_key] = value
           end
         end

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

@@ -11,8 +11,6 @@ module NewRelic
         def initialize(local_settings)
           super({
             :capture_params => false,
-            :'resque.capture_params' => false,
-            :'sidekiq.capture_params' => false,
             :'attributes.include' => [],
 
             :'transaction_tracer.record_sql' => record_sql_setting(local_settings, :'transaction_tracer.record_sql'),
@@ -26,9 +24,9 @@ module NewRelic
           })
         end
 
-        OFF = "off".freeze
-        RAW = "raw".freeze
-        OBFUSCATED = "obfuscated".freeze
+        OFF = 'off'.freeze
+        RAW = 'raw'.freeze
+        OBFUSCATED = 'obfuscated'.freeze
 
         SET_TO_OBFUSCATED = [RAW, OBFUSCATED]
 

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

@@ -15,6 +15,8 @@ module NewRelic
   module Agent
     module Configuration
       class Manager
+        DEPENDENCY_DETECTION_VALUES = %i[prepend chain unsatisfied].freeze
+
         # Defining these explicitly saves object allocations that we incur
         # if we use Forwardable and def_delegators.
         def [](key)
@@ -241,8 +243,8 @@ module NewRelic
           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_LENGTH = 255
@@ -357,7 +359,19 @@ module NewRelic
           reset_cache
         end
 
+        # reset the configuration hash, but do not replace previously auto
+        # determined dependency detection values with nil or 'auto'
         def reset_cache
+          return new_cache unless defined?(@cache) && @cache
+
+          preserved = @cache.select { |_k, v| DEPENDENCY_DETECTION_VALUES.include?(v) }
+          new_cache
+          preserved.each { |k, v| @cache[k] = v }
+
+          @cache
+        end
+
+        def new_cache
           @cache = Hash.new { |hash, key| hash[key] = self.fetch(key) }
         end
 

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

@@ -51,7 +51,7 @@ module NewRelic
         #   permitted by the security policy and is also enabled by the config
 
         SECURITY_SETTINGS_MAP = {
-          "record_sql" => [
+          'record_sql' => [
             {
               option: :'transaction_tracer.record_sql',
               supported: true,
@@ -96,7 +96,7 @@ module NewRelic
               permitted_fn: nil
             }
           ],
-          "attributes_include" => [
+          'attributes_include' => [
             {
               option: :'attributes.include',
               supported: true,
@@ -147,7 +147,7 @@ module NewRelic
               permitted_fn: nil
             }
           ],
-          "allow_raw_exception_messages" => [
+          'allow_raw_exception_messages' => [
             {
               option: :'strip_exception_messages.enabled',
               supported: true,
@@ -156,7 +156,7 @@ module NewRelic
               permitted_fn: nil
             }
           ],
-          "custom_events" => [
+          'custom_events' => [
             {
               option: :'custom_insights_events.enabled',
               supported: true,
@@ -165,7 +165,7 @@ module NewRelic
               permitted_fn: nil
             }
           ],
-          "custom_parameters" => [
+          'custom_parameters' => [
             {
               option: :'custom_attributes.enabled',
               supported: true,
@@ -174,7 +174,7 @@ module NewRelic
               permitted_fn: nil
             }
           ],
-          "custom_instrumentation_editor" => [
+          'custom_instrumentation_editor' => [
             {
               option: nil,
               supported: false,
@@ -183,7 +183,7 @@ module NewRelic
               permitted_fn: nil
             }
           ],
-          "message_parameters" => [
+          'message_parameters' => [
             {
               option: :'message_tracer.segment_parameters.enabled',
               supported: true,
@@ -191,22 +191,6 @@ module NewRelic
               disabled_value: false,
               permitted_fn: nil
             }
-          ],
-          "job_arguments" => [
-            {
-              option: :'resque.capture_params',
-              supported: true,
-              enabled_fn: method(:enabled?),
-              disabled_value: false,
-              permitted_fn: nil
-            },
-            {
-              option: :'sidekiq.capture_params',
-              supported: true,
-              enabled_fn: method(:enabled?),
-              disabled_value: false,
-              permitted_fn: nil
-            }
           ]
         }
 
@@ -214,8 +198,8 @@ module NewRelic
           super(build_overrides(security_policies))
         end
 
-        ENABLED = "enabled".freeze
-        COLON_COLON = "::".freeze
+        ENABLED = 'enabled'.freeze
+        COLON_COLON = '::'.freeze
 
         def build_overrides(security_policies)
           security_policies.inject({}) do |settings, (policy_name, policy_settings)|
@@ -238,7 +222,7 @@ module NewRelic
                 settings[policy[:option]] = policy[:disabled_value]
                 NewRelic::Agent.logger.info( \
                   "Setting applied: {#{policy[:option]}: #{policy[:disabled_value]}}. " \
-                  "Source: SecurityPolicySource"
+                  'Source: SecurityPolicySource'
                 )
               end
             end

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

@@ -10,27 +10,27 @@ module NewRelic
         # response, but should still be merged in as config settings to the
         # main agent configuration.
         TOP_LEVEL_KEYS = [
-          "account_id",
-          "apdex_t",
-          "application_id",
-          "beacon",
-          "browser_key",
-          "browser_monitoring.debug",
-          "browser_monitoring.loader",
-          "browser_monitoring.loader_version",
-          "cross_process_id",
-          "data_report_period",
-          "encoding_key",
-          "entity_guid",
-          "error_beacon",
-          "js_agent_file",
-          "js_agent_loader",
-          "max_payload_size_in_bytes",
-          "primary_application_id",
-          "sampling_target",
-          "sampling_target_period_in_seconds",
-          "trusted_account_ids",
-          "trusted_account_key"
+          'account_id',
+          'apdex_t',
+          'application_id',
+          'beacon',
+          'browser_key',
+          'browser_monitoring.debug',
+          'browser_monitoring.loader',
+          'browser_monitoring.loader_version',
+          'cross_process_id',
+          'data_report_period',
+          'encoding_key',
+          'entity_guid',
+          'error_beacon',
+          'js_agent_file',
+          'js_agent_loader',
+          'max_payload_size_in_bytes',
+          'primary_application_id',
+          'sampling_target',
+          'sampling_target_period_in_seconds',
+          'trusted_account_ids',
+          'trusted_account_key'
         ]
 
         def initialize(connect_reply, existing_config = {})
@@ -70,7 +70,7 @@ module NewRelic
 
         def fix_transaction_threshold(merged_settings)
           # when value is "apdex_f" remove the config and defer to default
-          if merged_settings['transaction_tracer.transaction_threshold'].to_s =~ /apdex_f/i
+          if /apdex_f/i.match?(merged_settings['transaction_tracer.transaction_threshold'].to_s)
             merged_settings.delete('transaction_tracer.transaction_threshold')
           end
         end
@@ -102,8 +102,8 @@ module NewRelic
           if event_harvest_config.nil? \
               || event_harvest_config['harvest_limits'].values.min < 0 \
               || (event_harvest_config['report_period_ms'] / 1000) <= 0
-            NewRelic::Agent.logger.warn("Invalid event harvest config found " \
-                "in connect response; using default event report period.")
+            NewRelic::Agent.logger.warn('Invalid event harvest config found ' \
+                'in connect response; using default event report period.')
             false
           else
             true

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

@@ -41,6 +41,7 @@ module NewRelic
 
           substitute_transaction_threshold(config)
           booleanify_values(config, 'agent_enabled', 'enabled')
+          apply_aliases(config)
 
           super(config, true)
         end
@@ -84,7 +85,7 @@ module NewRelic
           # so warn about it since it's very likely to be unintended.
           NewRelic::Agent.logger.warn(
             "No configuration file found. Working directory = #{Dir.pwd}",
-            "Looked in these locations (based on #{based_on}): #{candidate_paths.join(", ")}"
+            "Looked in these locations (based on #{based_on}): #{candidate_paths.join(', ')}"
           )
         end
 
@@ -96,7 +97,7 @@ module NewRelic
             file.gsub!(/^\s*#.*$/, '#')
             ERB.new(file).result(binding)
           rescue ScriptError, StandardError => e
-            log_failure("Failed ERB processing configuration file. This is typically caused by a Ruby error in <% %> templating blocks in your newrelic.yml file.", e)
+            log_failure('Failed ERB processing configuration file. This is typically caused by a Ruby error in <% %> templating blocks in your newrelic.yml file.', e)
             nil
           end
         end
@@ -124,7 +125,7 @@ module NewRelic
               config['transaction_tracer']['transaction_threshold'].to_s =~ /apdex_f/i
             # when value is "apdex_f" remove the config and defer to default
             config['transaction_tracer'].delete('transaction_threshold')
-          elsif config['transaction_tracer.transaction_threshold'].to_s =~ /apdex_f/i
+          elsif /apdex_f/i.match?(config['transaction_tracer.transaction_threshold'].to_s)
             config.delete('transaction_tracer.transaction_threshold')
           end
         end
@@ -135,7 +136,7 @@ module NewRelic
             if 'auto' == config[option]
               config.delete(option)
             elsif !config[option].nil? && !is_boolean?(config[option])
-              coerced_value = !!(config[option].to_s =~ /yes|on|true/i)
+              coerced_value = config[option].to_s.match?(/yes|on|true/i)
               if !coerced_value
                 log_failure("Unexpected value (#{config[option]}) for '#{option}' in #{@path}")
               end
@@ -165,6 +166,18 @@ module NewRelic
           end
           result
         end
+
+        def apply_aliases(config)
+          DEFAULTS.each do |config_setting, value|
+            next unless value[:aliases]
+
+            value[:aliases].each do |config_alias|
+              next unless config[config_setting].nil? && !config[config_alias.to_s].nil?
+
+              config[config_setting] = config[config_alias.to_s]
+            end
+          end
+        end
       end
     end
   end

data/lib/new_relic/agent/connect/request_builder.rb

@@ -48,7 +48,7 @@ module NewRelic
 
         def environment_metadata
           env_copy = {}
-          ENV.keys.each { |k| env_copy[k] = ENV[k] if k =~ /^NEW_RELIC_METADATA_/ }
+          ENV.keys.each { |k| env_copy[k] = ENV[k] if /^NEW_RELIC_METADATA_/.match?(k) }
           env_copy
         end
 

data/lib/new_relic/agent/connect/response_handler.rb

@@ -37,7 +37,7 @@ module NewRelic
 
         def add_server_side_config(config_data)
           if config_data['agent_config']
-            ::NewRelic::Agent.logger.debug("Using config from server")
+            ::NewRelic::Agent.logger.debug('Using config from server')
           end
 
           ::NewRelic::Agent.logger.debug("Server provided config: #{config_data.inspect}")

data/lib/new_relic/agent/custom_event_aggregator.rb

@@ -27,7 +27,7 @@ module NewRelic
         return unless enabled?
 
         type = @type_strings[type]
-        unless type =~ EVENT_TYPE_REGEX
+        unless EVENT_TYPE_REGEX.match?(type)
           note_dropped_event(type)
           return false
         end
@@ -71,9 +71,9 @@ module NewRelic
 
       def record_supportability_metrics(total_count, captured_count, dropped_count)
         engine = NewRelic::Agent.instance.stats_engine
-        engine.tl_record_supportability_metric_count("Events/Customer/Seen", total_count)
-        engine.tl_record_supportability_metric_count("Events/Customer/Sent", captured_count)
-        engine.tl_record_supportability_metric_count("Events/Customer/Dropped", dropped_count)
+        engine.tl_record_supportability_metric_count('Events/Customer/Seen', total_count)
+        engine.tl_record_supportability_metric_count('Events/Customer/Sent', captured_count)
+        engine.tl_record_supportability_metric_count('Events/Customer/Dropped', dropped_count)
       end
 
       def note_dropped_event(type)

data/lib/new_relic/agent/database/explain_plan_helpers.rb

@@ -36,7 +36,7 @@ module NewRelic
         rescue => e
           begin
             # guarantees no throw from explain_sql
-            ::NewRelic::Agent.logger.error("Error getting query plan:", e)
+            ::NewRelic::Agent.logger.error('Error getting query plan:', e)
             nil
           rescue
             # double exception. throw up your hands

data/lib/new_relic/agent/database/obfuscation_helpers.rb

@@ -49,10 +49,10 @@ module NewRelic
         }
 
         PLACEHOLDER = '?'.freeze
-        FAILED_TO_OBFUSCATE_MESSAGE = "Failed to obfuscate SQL query - quote characters remained after obfuscation".freeze
+        FAILED_TO_OBFUSCATE_MESSAGE = 'Failed to obfuscate SQL query - quote characters remained after obfuscation'.freeze
 
         def obfuscate_single_quote_literals(sql)
-          return sql unless sql =~ COMPONENTS_REGEX_MAP[:single_quotes]
+          return sql unless sql&.match?(COMPONENTS_REGEX_MAP[:single_quotes])
 
           sql.gsub(COMPONENTS_REGEX_MAP[:single_quotes], PLACEHOLDER)
         end

data/lib/new_relic/agent/database/obfuscator.rb

@@ -13,8 +13,8 @@ module NewRelic
 
         attr_reader :obfuscator
 
-        QUERY_TOO_LARGE_MESSAGE = "Query too large (over 16k characters) to safely obfuscate".freeze
-        ELLIPSIS = "...".freeze
+        QUERY_TOO_LARGE_MESSAGE = 'Query too large (over 16k characters) to safely obfuscate'.freeze
+        ELLIPSIS = '...'.freeze
 
         def initialize
           reset

data/lib/new_relic/agent/database.rb

@@ -7,24 +7,10 @@ require 'new_relic/agent/database/explain_plan_helpers'
 require 'new_relic/agent/database/obfuscator'
 
 module NewRelic
-  # columns for a mysql explain plan
-  MYSQL_EXPLAIN_COLUMNS = [
-    "Id",
-    "Select Type",
-    "Table",
-    "Type",
-    "Possible Keys",
-    "Key",
-    "Key Length",
-    "Ref",
-    "Rows",
-    "Extra"
-  ].freeze
-
   module Agent
     module Database
       MAX_QUERY_LENGTH = 16384
-      ELLIPSIS = "...".freeze
+      ELLIPSIS = '...'.freeze
 
       extend self
 
@@ -164,7 +150,7 @@ module NewRelic
           begin
             @connections[config] = yield(config)
           rescue => e
-            ::NewRelic::Agent.logger.error("Caught exception trying to get connection to DB for explain.", e)
+            ::NewRelic::Agent.logger.error('Caught exception trying to get connection to DB for explain.', e)
             nil
           end
         end
@@ -188,7 +174,7 @@ module NewRelic
 
         attr_accessor :sql, :config, :explainer, :binds, :name, :host, :port_path_or_id, :database_name
 
-        DEFAULT_QUERY_NAME = "SQL".freeze
+        DEFAULT_QUERY_NAME = 'SQL'.freeze
 
         def initialize(sql, config = {}, explainer = nil, binds = nil, name = DEFAULT_QUERY_NAME, host = nil, port_path_or_id = nil, database_name = nil)
           @sql = Database.capture_query(sql)
@@ -233,7 +219,7 @@ module NewRelic
             start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             plan = @explainer.call(self)
             ::NewRelic::Agent.record_metric(
-              "Supportability/Database/execute_explain_plan",
+              'Supportability/Database/execute_explain_plan',
               Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
             )
             return process_resultset(plan, adapter) if plan

data/lib/new_relic/agent/datastores/metric_helper.rb

@@ -6,12 +6,12 @@ module NewRelic
   module Agent
     module Datastores
       module MetricHelper
-        ROLLUP_METRIC = "Datastore/all".freeze
-        OTHER = "Other".freeze
+        ROLLUP_METRIC = 'Datastore/all'.freeze
+        OTHER = 'Other'.freeze
 
-        ALL = "all".freeze
-        ALL_WEB = "allWeb".freeze
-        ALL_OTHER = "allOther".freeze
+        ALL = 'all'.freeze
+        ALL_WEB = 'allWeb'.freeze
+        ALL_OTHER = 'allOther'.freeze
 
         def self.statement_metric_for(product, collection, operation)
           "Datastore/statement/#{product}/#{collection}/#{operation}"

data/lib/new_relic/agent/datastores/mongo/metric_translator.rb

@@ -53,7 +53,7 @@ module NewRelic
 
             [name.to_s, collection]
           rescue => e
-            NewRelic::Agent.logger.debug("Failure during Mongo metric generation", e)
+            NewRelic::Agent.logger.debug('Failure during Mongo metric generation', e)
             nil
           end
 
@@ -64,10 +64,10 @@ module NewRelic
           NAMES_IN_SELECTOR = [
             :findandmodify,
 
-            "aggregate",
-            "count",
-            "group",
-            "mapreduce",
+            'aggregate',
+            'count',
+            'group',
+            'mapreduce',
 
             :distinct,
 
@@ -91,18 +91,18 @@ module NewRelic
             if command_key
               command_key.to_sym
             else
-              NewRelic::Agent.increment_metric("Supportability/Mongo/UnknownCollection")
+              NewRelic::Agent.increment_metric('Supportability/Mongo/UnknownCollection')
               payload[:selector].first.first unless command_key
             end
           end
 
-          CMD_COLLECTION = "$cmd".freeze
+          CMD_COLLECTION = '$cmd'.freeze
 
           def self.get_collection_from_selector(command_key, payload)
             if command_key
               payload[:selector][command_key]
             else
-              NewRelic::Agent.increment_metric("Supportability/Mongo/UnknownCollection")
+              NewRelic::Agent.increment_metric('Supportability/Mongo/UnknownCollection')
               CMD_COLLECTION
             end
           end
@@ -124,11 +124,11 @@ module NewRelic
           end
 
           def self.create_index?(name, payload)
-            name == :insert && payload[:collection] == "system.indexes"
+            name == :insert && payload[:collection] == 'system.indexes'
           end
 
           def self.drop_indexes?(name, payload)
-            name == :deleteIndexes && payload[:selector] && payload[:selector][:index] == "*"
+            name == :deleteIndexes && payload[:selector] && payload[:selector][:index] == '*'
           end
 
           def self.drop_index?(name, payload)
@@ -166,7 +166,7 @@ module NewRelic
           end
 
           def self.collection_name_from_group_selector(payload)
-            payload[:selector]["group"]["ns"]
+            payload[:selector]['group']['ns']
           end
 
           def self.collection_name_from_rename_selector(payload)

data/lib/new_relic/agent/datastores/redis.rb

@@ -6,7 +6,7 @@ module NewRelic
   module Agent
     module Datastores
       module Redis
-        BINARY_DATA_PLACEHOLDER = "<binary data>"
+        BINARY_DATA_PLACEHOLDER = '<binary data>'
 
         MAXIMUM_COMMAND_LENGTH = 1000
         MAXIMUM_ARGUMENT_LENGTH = 64
@@ -25,7 +25,7 @@ module NewRelic
 
         def self.format_command(command_with_args)
           if Agent.config[:'transaction_tracer.record_redis_arguments']
-            result = String.new('')
+            result = +''
 
             append_command_with_args(result, command_with_args)
 
@@ -36,7 +36,7 @@ module NewRelic
         end
 
         def self.format_pipeline_commands(commands_with_args)
-          result = String.new('')
+          result = +''
 
           commands_with_args.each do |command|
             if result.length >= MAXIMUM_COMMAND_LENGTH
@@ -83,7 +83,7 @@ module NewRelic
         end
 
         def self.is_supported_version?
-          Gem::Version.new(::Redis::VERSION) >= Gem::Version.new("3.0.0")
+          Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('3.0.0')
         end
 
         def self.ellipsize(result, string)
@@ -106,8 +106,8 @@ module NewRelic
         end
 
         def self.safe_from_third_party_gem?
-          if NewRelic::LanguageSupport.bundled_gem?("newrelic-redis")
-            ::NewRelic::Agent.logger.info("Not installing New Relic supported Redis instrumentation because the third party newrelic-redis gem is present")
+          if NewRelic::LanguageSupport.bundled_gem?('newrelic-redis')
+            ::NewRelic::Agent.logger.info('Not installing New Relic supported Redis instrumentation because the third party newrelic-redis gem is present')
             false
           else
             true

data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb

@@ -1,4 +1,3 @@
-# -*- ruby -*-
 # 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
@@ -28,7 +27,7 @@ module NewRelic
       end
 
       def is_cross_app_callee?
-        cross_app_payload != nil
+        !cross_app_payload.nil?
       end
 
       def is_cross_app?
@@ -36,7 +35,7 @@ module NewRelic
       end
 
       def cat_trip_id
-        cross_app_payload && cross_app_payload.referring_trip_id || transaction.guid
+        cross_app_payload&.referring_trip_id || transaction.guid
       end
 
       def cross_app_monitor
@@ -74,7 +73,7 @@ module NewRelic
       end
 
       def record_cross_app_metrics
-        if (id = cross_app_payload && cross_app_payload.id)
+        if (id = cross_app_payload&.id)
           app_time_in_seconds = [
             Process.clock_gettime(Process::CLOCK_REALTIME) - transaction.start_time,
             0.0
@@ -104,11 +103,11 @@ module NewRelic
       end
 
       def cat_referring_path_hash
-        cross_app_payload && cross_app_payload.referring_path_hash
+        cross_app_payload&.referring_path_hash
       end
 
       def append_cat_info(payload)
-        if (referring_guid = cross_app_payload && cross_app_payload.referring_guid)
+        if (referring_guid = cross_app_payload&.referring_guid)
           payload[:referring_transaction_guid] = referring_guid
         end
 
@@ -150,7 +149,7 @@ module NewRelic
         if Agent.config[:cross_process_id] && Agent.config[:cross_process_id].length > 0
           true
         else
-          NewRelic::Agent.logger.debug("No cross_process_id configured")
+          NewRelic::Agent.logger.debug('No cross_process_id configured')
           false
         end
       end
@@ -159,15 +158,14 @@ module NewRelic
         if Agent.config[:encoding_key] && Agent.config[:encoding_key].length > 0
           true
         else
-          NewRelic::Agent.logger.debug("No encoding_key set")
+          NewRelic::Agent.logger.debug('No encoding_key set')
           false
         end
       end
 
       def cross_application_tracer_enabled?
         !NewRelic::Agent.config[:"distributed_tracing.enabled"] &&
-          (NewRelic::Agent.config[:"cross_application_tracer.enabled"] ||
-           NewRelic::Agent.config[:cross_application_tracing])
+          NewRelic::Agent.config[:"cross_application_tracer.enabled"]
       end
 
       def obfuscator