newrelic_rpm 5.7.0.350 → 7.0.0

data/lib/new_relic/agent/configuration/default_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.
 
 require 'forwardable'
 
@@ -15,6 +15,35 @@ module NewRelic
         end
       end
 
+      # Combines potentially two properties into one.
+      # Given the example:
+      #    :disable_net_http and :prepend_net_instrumentation
+      #    if :disable_net_http is true, then returned value is "disabled"
+      #    if :prepend_net_instrumentation is false, then returned value is "chain"
+      #    otherwise, "auto" is returned.
+      #
+      # Intent is:
+      #     - if user sets disable_xxx property, then don't instrument
+      #     - if user set prepend to `false` then we use method_alias chaining
+      #     - auto, when returned means, try to use prepend unless conflicting gems discovered
+      #
+      def self.instrumentation_value_of(disable_key, prepend_key=nil)
+        Proc.new do
+          if NewRelic::Agent.config[disable_key]
+            "disabled"
+          elsif prepend_key && !NewRelic::Agent.config[prepend_key]
+            "chain"
+          else
+            "auto"
+          end
+        end
+      end
+
+      def self.deprecated_description new_setting, description
+        link_ref = new_setting.to_s.gsub(".", "-")
+        %{<a href="##{link_ref}"><code>#{new_setting}</code>}
+      end
+
       class Boolean
         def self.===(o)
           TrueClass === o or FalseClass === o
@@ -48,23 +77,30 @@ module NewRelic
           Proc.new {
             paths = [
               File.join("config","newrelic.yml"),
-              File.join("newrelic.yml")
+              File.join("newrelic.yml"),
+              File.join("config","newrelic.yml.erb"),
+              File.join("newrelic.yml.erb")
             ]
 
             if NewRelic::Control.instance.root
               paths << File.join(NewRelic::Control.instance.root, "config", "newrelic.yml")
               paths << File.join(NewRelic::Control.instance.root, "newrelic.yml")
+              paths << File.join(NewRelic::Control.instance.root, "config", "newrelic.yml.erb")
+              paths << File.join(NewRelic::Control.instance.root, "newrelic.yml.erb")
             end
 
             if ENV["HOME"]
               paths << File.join(ENV["HOME"], ".newrelic", "newrelic.yml")
               paths << File.join(ENV["HOME"], "newrelic.yml")
+              paths << File.join(ENV["HOME"], ".newrelic", "newrelic.yml.erb")
+              paths << File.join(ENV["HOME"], "newrelic.yml.erb")
             end
 
             # If we're packaged for warbler, we can tell from GEM_HOME
             if ENV["GEM_HOME"] && ENV["GEM_HOME"].end_with?(".jar!")
               app_name = File.basename(ENV["GEM_HOME"], ".jar!")
               paths << File.join(ENV["GEM_HOME"], app_name, "config", "newrelic.yml")
+              paths << File.join(ENV["GEM_HOME"], app_name, "config", "newrelic.yml.erb")
             end
 
             paths
@@ -91,12 +127,11 @@ module NewRelic
                 :rails
               when 3
                 :rails3
-              when 4
-                :rails4
-              when 5
-                :rails5
+              when 4..6
+                :rails_notifications
               else
-                ::NewRelic::Agent.logger.error "Detected unsupported Rails version #{Rails::VERSION::STRING}"
+                ::NewRelic::Agent.logger.warn "Detected untested Rails version #{Rails::VERSION::STRING}"
+                :rails_notifications
               end
             when defined?(::Sinatra) && defined?(::Sinatra::Base) then :sinatra
             when defined?(::NewRelic::IA) then :external
@@ -170,6 +205,16 @@ module NewRelic
           end
         end
 
+        def self.api_host
+          Proc.new do
+            if String(NewRelic::Agent.config[:license_key]).start_with? 'eu'
+              'rpm.eu.newrelic.com'
+            else
+              'rpm.newrelic.com'
+            end
+          end
+        end
+
         def self.convert_to_regexp_list(raw_value)
           value_list = convert_to_list(raw_value)
           value_list.map do |value|
@@ -188,6 +233,15 @@ module NewRelic
           end
         end
 
+        SEMICOLON = ';'.freeze
+        def self.convert_to_list_on_semicolon value
+          case value
+          when Array then value
+          when String then value.split(SEMICOLON)
+          else []
+          end
+        end
+
         def self.convert_to_constant_list(raw_value)
           const_names = convert_to_list(raw_value)
           const_names.map! do |class_name|
@@ -201,9 +255,19 @@ module NewRelic
           end
           const_names.compact
         end
+
+        def self.enforce_fallback(allowed_values: nil, fallback: nil)
+          Proc.new do |configured_value|
+            if allowed_values.any? { |v| v =~ /#{configured_value}/i }
+              configured_value
+            else
+              fallback
+            end
+          end
+        end
       end
 
-      AUTOSTART_BLACKLISTED_RAKE_TASKS = [
+      AUTOSTART_DENYLISTED_RAKE_TASKS = [
         'about',
         'assets:clean',
         'assets:clobber',
@@ -283,8 +347,17 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
+          :transform => DefaultSource.method(:convert_to_list_on_semicolon),
           :description => 'Specify the <a href="https://docs.newrelic.com/docs/apm/new-relic-apm/installation-configuration/name-your-application">application name</a> used to aggregate data in the New Relic UI. To report data to <a href="https://docs.newrelic.com/docs/apm/new-relic-apm/installation-configuration/using-multiple-names-app">multiple apps at the same time</a>, specify a list of names separated by a semicolon <code>;</code>. For example, <code>MyApp</code> or <code>MyStagingApp;Instance1</code>.'
         },
+        :entity_guid => {
+          :default => nil,
+          :allow_nil => true,
+          :public => true,
+          :type => String,
+          :allowed_from_server => true,
+          :description => 'The <a href="https://docs.newrelic.com/attribute-dictionary/span/entityguid">Entity GUID</a> for the entity running this agent.'
+        },
         :monitor_mode => {
           :default => value_of(:enabled),
           :public => true,
@@ -359,7 +432,21 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'When <code>true</code>, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and <a href="https://docs.newrelic.com/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights">TransactionError events</a>.'
+          :description => 'When <code>true</code>, the agent captures HTTP request parameters ' \
+            'and attaches them to transaction traces, traced errors, and ' \
+            '<a href="https://docs.newrelic.com/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241">'\
+            '<code>TransactionError</code> events.' \
+            "\n" \
+            '<div class="callout-warning">' \
+            "\n" \
+            '<p>When using the <code>capture_params</code> setting, the Ruby agent will not attempt ' \
+            'to filter secret information. <b>Recommendation:</b> To filter secret information from ' \
+            'request parameters, use the <a href="/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby">' \
+            '<code>attributes.include</code> setting</a> instead. For more information, see the ' \
+            '<a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">' \
+            'Ruby attribute examples</a>.' \
+            "</p>\n" \
+            '</div>'
         },
         :config_path => {
           :default => DefaultSource.config_path,
@@ -389,40 +476,43 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'Autodetected application framework used to enable framework-specific functionality.'
         },
-        :'autostart.blacklisted_constants' => {
+        :'autostart.denylisted_constants' => {
           :default => 'Rails::Console',
           :public => true,
           :type => String,
           :allowed_from_server => false,
           :description => 'Specify a list of constants that should prevent the agent from starting automatically. Separate individual constants with a comma <code>,</code>. For example, <code>Rails::Console,UninstrumentedBackgroundJob</code>.'
         },
-        :'autostart.blacklisted_executables' => {
+        :'autostart.denylisted_executables' => {
           :default => 'irb,rspec',
           :public => true,
           :type => String,
           :allowed_from_server => false,
           :description => 'Defines a comma-delimited list of executables that the agent should not instrument. For example, <code>rake,my_ruby_script.rb</code>.'
         },
-        :'autostart.blacklisted_rake_tasks' => {
-          :default => AUTOSTART_BLACKLISTED_RAKE_TASKS,
+        :'autostart.denylisted_rake_tasks' => {
+          :default => AUTOSTART_DENYLISTED_RAKE_TASKS,
           :public => true,
           :type => String,
           :allowed_from_server => false,
           :description => 'Defines a comma-delimited list of Rake tasks that the agent should not instrument. For example, <code>assets:precompile,db:migrate</code>.'
         },
+
         :disable_rake => {
           :default => false,
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables Rake instrumentation.'
+          :deprecated => true,
+          :description => deprecated_description(:'instrumentation.rake', 'If <code>true</code>, disables Rake instrumentation.')
         },
         :disable_rake_instrumentation => {
           :default => false,
           :public => false,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'Enable or disable Rake instrumentation. Preferred key is `disable_rake`'
+          :deprecated => true,
+          :description => deprecated_description(:'instrumentation.rake', 'Enable or disable Rake instrumentation. Preferred key is `disable_rake`')
         },
         :'rake.tasks' => {
           :default => [],
@@ -452,15 +542,15 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If true, the agent strips messages from all exceptions except those in the <a href="#strip_exception_messages-whitelist">whitelist</a>. Enabled automatically in <a href="https://docs.newrelic.com/docs/accounts-partnerships/accounts/security/high-security">high security mode</a>.'
+          :description => 'If true, the agent strips messages from all exceptions except those in the <a href="#strip_exception_messages-allowlist">allowlist</a>. Enabled automatically in <a href="https://docs.newrelic.com/docs/accounts-partnerships/accounts/security/high-security">high security mode</a>.'
         },
-        :'strip_exception_messages.whitelist' => {
+        :'strip_exception_messages.allowed_classes' => {
           :default => '',
           :public => true,
           :type => String,
           :allowed_from_server => false,
           :transform => DefaultSource.method(:convert_to_constant_list),
-          :description => 'Specify a whitelist of exceptions you do not want the agent to strip when <a href="#strip_exception_messages-enabled">strip_exception_messages</a> is <code>true</code>. Separate exceptions with a comma. For example, <code>"ImportantException,PreserveMessageException"</code>.'
+          :description => 'Specify a list of exceptions you do not want the agent to strip when <a href="#strip_exception_messages-enabled">strip_exception_messages</a> is <code>true</code>. Separate exceptions with a comma. For example, <code>"ImportantException,PreserveMessageException"</code>.'
         },
         :host => {
           :default => DefaultSource.host,
@@ -470,7 +560,7 @@ module NewRelic
           :description => "URI for the New Relic data collection service."
         },
         :api_host => {
-          :default => 'rpm.newrelic.com',
+          :default => DefaultSource.api_host,
           :public => false,
           :type => String,
           :allowed_from_server => false,
@@ -519,7 +609,7 @@ module NewRelic
           :description => 'Use HTTP PUT requests instead of POST.'
         },
         :compressed_content_encoding => {
-          :default => 'deflate',
+          :default => 'gzip',
           :public => false,
           :type => String,
           :allowed_from_server => false,
@@ -551,15 +641,46 @@ module NewRelic
           :public => false,
           :type => Integer,
           :allowed_from_server => true,
-          :description => 'Number of seconds betwixt connections to the New Relic data collection service. Note that transaction events have a separate report period, specified by data_report_periods.analytic_event_data.'
+          :description => 'Number of seconds betwixt connections to the New Relic data collection service.'
+        },
+        :event_report_period => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :allowed_from_server => true,
+          :description => 'Number of seconds betwixt connections to the New Relic event collection services.'
         },
-        :'data_report_periods.analytic_event_data' => {
+        :'event_report_period.analytic_event_data' => {
           :default => 60,
           :public => false,
           :type => Integer,
           :dynamic_name => true,
           :allowed_from_server => true,
-          :description => 'Number of seconds between connections to the New Relic data collection service for sending transaction event data.'
+          :description => 'Number of seconds betwixt connections to the New Relic analytic event collection services.'
+        },
+        :'event_report_period.custom_event_data' => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :dynamic_name => true,
+          :allowed_from_server => true,
+          :description => 'Number of seconds betwixt connections to the New Relic custom event collection services.'
+        },
+        :'event_report_period.error_event_data' => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :dynamic_name => true,
+          :allowed_from_server => true,
+          :description => 'Number of seconds betwixt connections to the New Relic error event collection services.'
+        },
+        :'event_report_period.span_event_data' => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :dynamic_name => true,
+          :allowed_from_server => true,
+          :description => 'Number of seconds betwixt connections to the New Relic span event collection services.'
         },
         :keep_retrying => {
           :default => true,
@@ -569,6 +690,18 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'Enable or disable retrying failed connections to the New Relic data collection service.'
         },
+        :force_install_exit_handler => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'Forces the exit handler that sends all cached data to collector ' \
+            'before shuttng down to be installed regardless of detecting scenarios where it generally should not be. ' \
+            'Known use-case for this option is where Sinatra is running as an embedded service within another framework ' \
+            'and the agent is detecting the Sinatra app and skipping the at_exit handler as a result. Sinatra classically ' \
+            'runs the entire application in an at_exit block and would otherwise misbehave if the Agent\'s at_exit handler ' \
+            'is also installed in those circumstances.  Note: `send_data_on_exit` should also be set to `true` in  tandem with this setting.'
+        },
         :force_reconnect => {
           :default => false,
           :public => false,
@@ -630,8 +763,9 @@ module NewRelic
           :default => false,
           :public => true,
           :type => Boolean,
+          :deprecated => true,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables <a href="https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs/resque-instrumentation">Resque instrumentation</a>.'
+          :description => deprecated_description(:'instrumentation.resque', 'If <code>true</code>, disables <a href="https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs/resque-instrumentation">Resque instrumentation</a>.')
         },
         :disable_sidekiq => {
           :default => false,
@@ -643,16 +777,18 @@ module NewRelic
         :disable_dj => {
           :default => false,
           :public => true,
+          :deprecated => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables <a href="https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs/delayedjob">Delayed::Job instrumentation</a>.'
+          :description => deprecated_description(:'instrumentation.delayed_job', 'If <code>true</code>, disables <a href="https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs/delayedjob">Delayed::Job instrumentation</a>.'
+          )
         },
         :disable_sinatra => {
           :default => false,
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If <code>true</code> , disables <a href="https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/sinatra-support">Sinatra instrumentation</a>.'
+          :description => deprecated_description(:'instrumentation.sinatra', 'If <code>true</code> , disables <a href="https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/sinatra-support">Sinatra instrumentation</a>.' )
         },
         :disable_sinatra_auto_middleware => {
           :default => false,
@@ -696,6 +832,172 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'If <code>true</code>, uses Module.prepend rather than alias_method for ActiveRecord instrumentation.'
         },
+        :prepend_net_instrumentation => {
+          :default => true,
+          :public => false,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :deprecated => true,
+          :description => deprecated_description(:'instrumentation.net_http',
+            'If <code>true</code>, uses Module.prepend rather than alias_method for Net::HTTP instrumentation.'
+          )
+        },
+        :'instrumentation.net_http' => {
+          :default => instrumentation_value_of(:disable_net_http, :prepend_net_instrumentation),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Net::HTTP at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.typhoeus' => {
+          :default => instrumentation_value_of(:disable_typhoeus),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Typhoeus at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.bunny' => {
+          :default => instrumentation_value_of(:disable_bunny),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => 'Controls auto-instrumentation of bunny at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.httprb' => {
+          :default => instrumentation_value_of(:disable_httprb),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => 'Controls auto-instrumentation of http.rb gem at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.resque' => {
+          :default => instrumentation_value_of(:disable_resque),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of resque at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.redis' => {
+          :default => instrumentation_value_of(:disable_redis),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Redis at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.rake' => {
+          :default => instrumentation_value_of(:disable_rake),
+          :public => :true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of rake at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.mongo' => {
+          :default => instrumentation_value_of(:disable_mongo),
+          :public => :true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Mongo at start up.  May be one of [enabled|disabled]."
+        },
+        :'instrumentation.delayed_job' => {
+          :default => instrumentation_value_of(:disable_dj),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => 'Controls auto-instrumentation of Delayed Job at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.httpclient' => {
+          :default => instrumentation_value_of(:disable_httpclient),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of HTTPClient at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.curb' => {
+          :default => instrumentation_value_of(:disable_curb),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => 'Controls auto-instrumentation of Curb at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.sinatra' => {
+          :default => instrumentation_value_of(:disable_sinatra),
+          :public => :true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Sinatra at start up.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.rack' => {
+          :default      => instrumentation_value_of(:disable_rack),
+          :public       => true,
+          :type         => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => "Controls auto-instrumentation of Rack. When enabled, the agent hooks into the " \
+                           "<code>to_app</code> method in Rack::Builder to find gems to instrument during " \
+                           "application startup.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.rack_urlmap' => {
+          :default      => instrumentation_value_of(:disable_rack_urlmap),
+          :public       => true,
+          :type         => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'Controls auto-instrumentation of Rack::URLMap at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.puma_rack' => {
+          :default      => instrumentation_value_of(:disable_puma_rack),  # TODO: change to value_of(:'instrumentation.rack') when we remove :disable_puma_rack in 8.0)
+          :public       => true,
+          :type         => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => "Controls auto-instrumentation of Puma::Rack. When enabled, the agent hooks into the " \
+                           "<code>to_app</code> method in Puma::Rack::Builder to find gems to instrument during " \
+                           "application startup.  May be one of [auto|prepend|chain|disabled]."
+        },
+        :'instrumentation.puma_rack_urlmap' => {
+          :default      => instrumentation_value_of(:disable_puma_rack_urlmap),  # TODO: change to value_of(:'instrumentation.rack_urlmap') when we remove :disable_puma_rack_urlmap in 8.0)
+          :public       => true,
+          :type         => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'Controls auto-instrumentation of Puma::Rack::URLMap at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.memcached' => {
+          :default => instrumentation_value_of(:disable_memcached),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'Controls auto-instrumentation of memcached gem for Memcache at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.memcache_client' => {
+          :default => instrumentation_value_of(:disable_memcache_client),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'Controls auto-instrumentation of memcache-client gem for Memcache at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
+        :'instrumentation.memcache' => {
+          :default => instrumentation_value_of(:disable_dalli),
+          :public => true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'Controls auto-instrumentation of dalli gem for Memcache at start up.  May be one of [auto|prepend|chain|disabled].'
+        },
         :disable_data_mapper => {
           :default => false,
           :public => true,
@@ -731,36 +1033,41 @@ module NewRelic
           :default => value_of(:disable_memcache_instrumentation),
           :public => true,
           :type => Boolean,
+          :deprecated => true,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables instrumentation for the memcached gem.'
+          :description => deprecated_description(:'instrumentation.memcached', 'If <code>true</code>, disables instrumentation for the memcached gem.')
         },
         :disable_memcache_client => {
           :default => value_of(:disable_memcache_instrumentation),
           :public => true,
           :type => Boolean,
+          :deprecated => true,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables instrumentation for the memcache-client gem.'
+          :description => deprecated_description(:'instrumentation.memcache-client', 'If <code>true</code>, disables instrumentation for the memcache-client gem.')
         },
         :disable_dalli => {
           :default => value_of(:disable_memcache_instrumentation),
           :public => true,
           :type => Boolean,
+          :deprecated => true,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables instrumentation for the dalli gem.'
+          :description => deprecated_description(:'instrumentation.memcache', 'If <code>true</code>, disables instrumentation for the dalli gem.')
         },
         :disable_dalli_cas_client => {
           :default => value_of(:disable_memcache_instrumentation),
           :public => true,
           :type => Boolean,
+          :deprecated => true,
           :allowed_from_server => false,
-          :description => "If <code>true</code>, disables instrumentation for the dalli gem\'s additional CAS client support."
+          :description => deprecated_description(:'instrumentation.memcache', "If <code>true</code>, disables instrumentation for the dalli gem\'s additional CAS client support.")
         },
         :disable_memcache_instrumentation => {
           :default => false,
           :public => true,
           :type => Boolean,
+          :deprecated => true,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, disables memcache instrumentation.'
+          :description => deprecated_description(:'instrumentation.memcache', 'If <code>true</code>, disables memcache instrumentation.')
         },
         :disable_gc_profiler => {
           :default => false,
@@ -895,21 +1202,24 @@ module NewRelic
           :type         => Boolean,
           :allowed_from_server => false,
           :dynamic_name => true,
-          :description  => 'If <code>true</code>, the agent won\'t install <a href="https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/mongo-instrumentation">instrumentation for the Mongo gem</a>.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.mongo', 'If <code>true</code>, the agent won\'t install <a href="https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/mongo-instrumentation">instrumentation for the Mongo gem</a>.')
         },
         :disable_redis => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
+          :deprecated   => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, the agent won\'t install <a href="https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/redis-instrumentation">instrumentation for Redis</a>.'
+          :description  => deprecated_description(:'instrumentation.redis', 'If <code>true</code>, the agent won\'t install <a href="https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/redis-instrumentation">instrumentation for Redis</a>.')
         },
         :disable_redis_instrumentation => {
           :default      => false,
           :public       => false,
           :type         => Boolean,
+          :deprecated   => true,
           :allowed_from_server => false,
-          :description  => 'Disables installation of Redis instrumentation. Standard key to use is disable_redis.'
+          :description  => deprecated_description(:'instrumentation.redis', 'Disables installation of Redis instrumentation. Standard key to use is disable_redis.')
         },
         :'message_tracer.segment_parameters.enabled' => {
           :default      => true,
@@ -1001,6 +1311,7 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => true,
+          :dynamic_name => true,
           :description => 'If <code>true</code>, the agent collects <a href="https://docs.newrelic.com/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights">TransactionError events</a>.'
         },
         :'error_collector.max_event_samples_stored' => {
@@ -1155,35 +1466,7 @@ module NewRelic
           :allowed_from_server => true,
           :description => 'If <code>true</code>, enables use of the <a href="https://docs.newrelic.com/docs/apm/applications-menu/events/thread-profiler-tool">thread profiler</a>.'
         },
-        :'xray_session.enabled' => {
-          :default => true,
-          :public => true,
-          :type => Boolean,
-          :allowed_from_server => true,
-          :description => 'If <code>true</code>, enables <a href="https://docs.newrelic.com/docs/apm/transactions-menu/x-ray-sessions/x-ray-sessions">X-Ray sessions</a>.'
-        },
-        :'xray_session.allow_traces' => {
-          :default => true,
-          :public => false,
-          :type => Boolean,
-          :allowed_from_server => true,
-          :description => 'Enable or disable X-Ray sessions recording transaction traces.'
-        },
-        :'xray_session.allow_profiles' => {
-          :default => true,
-          :public => false,
-          :type => Boolean,
-          :allowed_from_server => true,
-          :description => 'Enable or disable X-Ray sessions taking thread profiles.'
-        },
-        :'xray_session.max_samples' => {
-          :default => 10,
-          :public => false,
-          :type => Integer,
-          :allowed_from_server => true,
-          :description => 'Maximum number of transaction traces to buffer for active X-Ray sessions'
-        },
-        :'xray_session.max_profile_overhead' => {
+        :'thread_profiler.max_profile_overhead' => {
           :default => 0.05,
           :public => false,
           :type => Float,
@@ -1233,6 +1516,13 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'Controls whether to normalize string encodings prior to serializing data for the collector to JSON.'
         },
+        :backport_fast_active_record_connection_lookup => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'Backports the faster ActiveRecord connection lookup introduced in Rails 6, which improves agent performance when instrumenting ActiveRecord. Note that this setting may not be compatible with other gems that patch ActiveRecord.'
+        },
         :disable_vm_sampler => {
           :default      => false,
           :public       => true,
@@ -1265,53 +1555,57 @@ module NewRelic
           :allowed_from_server => false,
           :description  => 'If <code>true</code>, the agent won\'t measure the depth of Delayed Job queues.'
         },
-        :disable_active_record_4 => {
+        :disable_active_record_notifications => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 4.'
-        },
-        :disable_active_record_5 => {
-          :default      => false,
-          :public       => true,
-          :type         => Boolean,
-          :dynamic_name => true,
-          :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 5.'
+          :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 4, 5, and 6.'
         },
         :disable_bunny => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
+          :deprecated   => true,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for the bunny gem.'
+          :description  => deprecated_description(:'instrumentation.bunny', 'If <code>true</code>, disables instrumentation for the bunny gem.')
         },
         :disable_curb => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
+          :deprecated => true,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for the curb gem.'
+          :description  =>  deprecated_description(:'instrumentation.curb', 'If <code>true</code>, disables instrumentation for the curb gem.' )
         },
         :disable_excon => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
           :dynamic_name => true,
+          :deprecated   => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for the excon gem.'
+          :description  => deprecated_description(:'instrumentation.excon', 'If <code>true</code>, disables instrumentation for the excon gem.')
+        },
+        :'instrumentation.excon' => {
+          :default => instrumentation_value_of(:disable_excon),
+          :public => :true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Excon at start up.  May be one of [enabled|disabled]."
         },
         :disable_httpclient => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
           :dynamic_name => true,
+          :deprecated   => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for the httpclient gem.'
+          :description  => deprecated_description(:'instrumentation.httpclient', 'If <code>true</code>, disables instrumentation for the httpclient gem.')
         },
         :disable_net_http => {
           :default      => false,
@@ -1319,7 +1613,10 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for Net::HTTP.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.net_http',
+            'If <code>true</code>, disables instrumentation for Net::HTTP.'
+          )
         },
         :disable_rack => {
           :default      => false,
@@ -1327,7 +1624,8 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, prevents the agent from hooking into the <code>to_app</code> method in Rack::Builder to find gems to instrument during application startup.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.rack',  'If <code>true</code>, prevents the agent from hooking into the <code>to_app</code> method in Rack::Builder to find gems to instrument during application startup.')
         },
         :disable_rack_urlmap => {
           :default      => false,
@@ -1335,7 +1633,8 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, prevents the agent from hooking into Rack::URLMap to install middleware tracing.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.rack_urlmap', 'If <code>true</code>, prevents the agent from hooking into Rack::URLMap to install middleware tracing.')
         },
         :disable_puma_rack => {
           :default      => value_of(:disable_rack),
@@ -1343,7 +1642,8 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, prevents the agent from hooking into the <code>to_app</code> method in Puma::Rack::Builder to find gems to instrument during application startup.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.puma_rack', 'If <code>true</code>, prevents the agent from hooking into the <code>to_app</code> method in Puma::Rack::Builder to find gems to instrument during application startup.')
         },
         :disable_puma_rack_urlmap => {
           :default      => value_of(:disable_rack_urlmap),
@@ -1351,23 +1651,26 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, prevents the agent from hooking into Puma::Rack::URLMap to install middleware tracing.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.puma_rack_urlmap', 'If <code>true</code>, prevents the agent from hooking into Puma::Rack::URLMap to install middleware tracing.')
         },
         :disable_typhoeus => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
           :dynamic_name => true,
+          :deprecated   => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, the agent won\'t install instrumentation for the typhoeus gem.'
+          :description  => deprecated_description(:'instrumentation.typhoeus', 'If <code>true</code>, the agent won\'t install instrumentation for the typhoeus gem.' )
         },
         :disable_httprb => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
           :dynamic_name => true,
+          :deprecated   => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, the agent won\'t install instrumentation for the http.rb gem.'
+          :description  => deprecated_description(:'instrumentation.httprb', 'If <code>true</code>, the agent won\'t install instrumentation for the http.rb gem.' )
         },
         :disable_middleware_instrumentation => {
           :default      => false,
@@ -1476,14 +1779,28 @@ module NewRelic
           :public       => false,
           :type         => Boolean,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, the agent won\'t install Grape instrumentation.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.grape',
+            'If <code>true</code>, the agent won\'t install Grape instrumentation.'
+          )
         },
         :disable_grape => {
           :default      => false,
           :public       => true,
           :type         => Boolean,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, the agent won\'t install Grape instrumentation.'
+          :deprecated   => true,
+          :description  => deprecated_description(:'instrumentation.grape',
+            'If <code>true</code>, the agent won\'t install Grape instrumentation.'
+          )
+        },
+        :'instrumentation.grape' => {
+          :default => instrumentation_value_of(:disable_grape_instrumentation),
+          :public => :true,
+          :type => String,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description => "Controls auto-instrumentation of Grape at start up.  May be one of [auto|prepend|chain|disabled]."
         },
         :'attributes.enabled' => {
           :default     => true,
@@ -1692,6 +2009,13 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'If <code>true</code>, the agent automatically detects that it is running in Docker.'
         },
+        :'utilization.detect_kubernetes' => {
+          :default     => true,
+          :public      => true,
+          :type        => Boolean,
+          :allowed_from_server => false,
+          :description => 'If <code>true</code>, the agent automatically detects that it is running in Kubernetes.'
+        },
         :'utilization.billing_hostname' => {
           :default     => nil,
           :allow_nil   => true,
@@ -1735,7 +2059,7 @@ module NewRelic
           :public      => true,
           :type        => Boolean,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, the agent will clear <code>TransactionState</code> in <code>Agent.drop_buffered_data</code>.'
+          :description => 'If <code>true</code>, the agent will clear <code>Tracer::State</code> in <code>Agent.drop_buffered_data</code>.'
         },
         :account_id => {
           :default => nil,
@@ -1784,17 +2108,51 @@ module NewRelic
         },
         :'span_events.enabled' => {
           :default => true,
-          :public => false,
+          :public => true,
           :type => Boolean,
           :allowed_from_server => true,
           :description => 'If <code>true</code>, enables span event sampling.'
         },
+        :'span_events.queue_size' => {
+          :default => 10_000,
+          :public => true,
+          :type => Integer,
+          :allowed_from_server => false,
+          :external => :infinite_tracing,
+          :description => "Sets the maximum number of span events to buffer when streaming to the trace observer."
+        },
         :'span_events.max_samples_stored' => {
           :default => 1000,
-          :public => false,
+          :public => true,
           :type => Integer,
           :allowed_from_server => true,
           :description => 'Defines the maximum number of span events reported from a single harvest.'
+        },
+        :'exclude_newrelic_header' => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => true,
+          :description => "Allows newrelic distributed tracing headers to be suppressed on outbound requests."
+        },
+        :'infinite_tracing.trace_observer.host' => {
+          :default => '',
+          :public => true,
+          :type => String,
+          :allowed_from_server => false,
+          :external => :infinite_tracing,
+          :description => "Configures the hostname for the Trace Observer Host. " \
+            "When configured, enables tail-based sampling by sending all recorded spans " \
+            "to a Trace Observer for further sampling decisions, irrespective of any usual " \
+            "agent sampling decision."
+        },
+        :'infinite_tracing.trace_observer.port' => {
+          :default => 443,
+          :public => true,
+          :type => Integer,
+          :allowed_from_server => false,
+          :external => :infinite_tracing,
+          :description => "Configures the TCP/IP port for the Trace Observer Host"
         }
       }.freeze
     end