newrelic_rpm 9.0.0 → 9.2.2

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

@@ -14,30 +14,6 @@ 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 do
-          if NewRelic::Agent.config[disable_key]
-            "disabled"
-          elsif prepend_key && !NewRelic::Agent.config[prepend_key]
-            "chain"
-          else
-            "auto"
-          end
-        end
-      end
-
       def self.instrumentation_value_from_boolean(key)
         proc do
           NewRelic::Agent.config[key] ? 'auto' : 'disabled'
@@ -47,7 +23,7 @@ module NewRelic
       # Marks the config option as deprecated in the documentation once generated.
       # Does not appear in logs.
       def self.deprecated_description(new_setting, description)
-        link_ref = new_setting.to_s.tr(".", "-")
+        link_ref = new_setting.to_s.tr('.', '-')
         %{Please see: [#{new_setting}](docs/agents/ruby-agent/configuration/ruby-agent-configuration##{link_ref}). \n\n#{description}}
       end
 
@@ -80,34 +56,35 @@ module NewRelic
           default_settings[:transform] if default_settings
         end
 
-        def self.config_search_paths
+        def self.config_search_paths # rubocop:disable Metrics/AbcSize
           proc {
-            paths = [
-              File.join("config", "newrelic.yml"),
-              File.join("newrelic.yml"),
-              File.join("config", "newrelic.yml.erb"),
-              File.join("newrelic.yml.erb")
-            ]
+            yaml = 'newrelic.yml'
+            config_yaml = File.join('config', yaml)
+            erb = 'newrelic.yml.erb'
+            config_erb = File.join('config', erb)
+
+            paths = [config_yaml, yaml, config_erb, 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")
+              paths << File.join(NewRelic::Control.instance.root, config_yaml)
+              paths << File.join(NewRelic::Control.instance.root, yaml)
+              paths << File.join(NewRelic::Control.instance.root, config_erb)
+              paths << File.join(NewRelic::Control.instance.root, 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")
+              paths << File.join(ENV['HOME'], '.newrelic', yaml)
+              paths << File.join(ENV['HOME'], yaml)
+              paths << File.join(ENV['HOME'], '.newrelic', erb)
+              paths << File.join(ENV['HOME'], 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")
+            # the following line needs else branch coverage
+            if ENV['GEM_HOME'] && ENV['GEM_HOME'].end_with?('.jar!') # rubocop:disable Style/SafeNavigation
+              app_name = File.basename(ENV['GEM_HOME'], '.jar!')
+              paths << File.join(ENV['GEM_HOME'], app_name, config_yaml)
+              paths << File.join(ENV['GEM_HOME'], app_name, config_erb)
             end
 
             paths
@@ -206,11 +183,11 @@ module NewRelic
           # only used for deployment task
           proc do
             api_version = if NewRelic::Agent.config[:api_key].nil? || NewRelic::Agent.config[:api_key].empty?
-              "rpm"
+              'rpm'
             else
-              "api"
+              'api'
             end
-            api_region = "eu." if String(NewRelic::Agent.config[:license_key]).start_with?('eu')
+            api_region = 'eu.' if String(NewRelic::Agent.config[:license_key]).start_with?('eu')
 
             "#{api_version}.#{api_region}newrelic.com"
           end
@@ -341,7 +318,7 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
-          :description => 'Your New Relic <LicenseKey />.'
+          :description => 'Your New Relic <InlinePopover type="licenseKey" />.'
         },
         :log_level => {
           :default => 'info',
@@ -376,7 +353,7 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
-          :description => 'Your New Relic [user key](/docs/apis/intro-apis/new-relic-api-keys/#overview-keys). Required when using the New Relic REST API v2 to record deployments using the `newrelic deployments` command.'
+          :description => 'Your New Relic <InlinePopover type="userKey" />. Required when using the New Relic REST API v2 to record deployments using the `newrelic deployments` command.'
         },
         :backport_fast_active_record_connection_lookup => {
           :default => false,
@@ -409,7 +386,7 @@ module NewRelic
             When `true`, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and [`TransactionError` events](/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241).
 
                 <Callout variant="caution">
-                  When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. <b>Recommendation:</b> To filter secret information from request parameters, use the [`attributes.include` setting](/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby) instead. For more information, see the <a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">Ruby attribute examples</a>.
+                  When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. `Recommendation:` To filter secret information from request parameters, use the [`attributes.include` setting](/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby) instead. For more information, see the <a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">Ruby attribute examples</a>.
                 </Callout>
           DESCRIPTION
         },
@@ -425,14 +402,20 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
-          :description => 'Path to <b>newrelic.yml</b>. If undefined, the agent checks the following directories (in order): <b>config/newrelic.yml</b>, <b>newrelic.yml</b>, <b>$HOME/.newrelic/newrelic.yml</b> and <b>$HOME/newrelic.yml</b>.'
+          :description => <<~DESC
+            Path to `newrelic.yml`. If undefined, the agent checks the following directories (in order):
+                * `config/newrelic.yml`
+                * `newrelic.yml`
+                * `$HOME/.newrelic/newrelic.yml`
+                * `$HOME/newrelic.yml`
+          DESC
         },
         :'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."
+          :description => 'Allows newrelic distributed tracing headers to be suppressed on outbound requests.'
         },
         :force_install_exit_handler => {
           :default => false,
@@ -645,7 +628,7 @@ module NewRelic
           :type => Boolean,
           :allowed_from_server => true,
           :dynamic_name => true,
-          :description => 'If `true`, the agent collects [TransactionError events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights).'
+          :description => 'If `true`, the agent collects [`TransactionError` events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights).'
         },
         :'error_collector.enabled' => {
           :default => true,
@@ -725,7 +708,7 @@ module NewRelic
           :public => true,
           :type => Integer,
           :allowed_from_server => true,
-          :description => 'Defines the maximum number of [TransactionError events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) reported per harvest cycle.'
+          :description => 'Defines the maximum number of [`TransactionError` events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) reported per harvest cycle.'
         },
         # Browser monitoring
         :'browser_monitoring.auto_instrument' => {
@@ -959,12 +942,12 @@ module NewRelic
           :description => 'If `true`, enables an audit log which logs communications with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector).'
         },
         :'audit_log.endpoints' => {
-          :default => [".*"],
+          :default => ['.*'],
           :public => true,
           :type => Array,
           :allowed_from_server => false,
           :transform => DefaultSource.method(:convert_to_regexp_list),
-          :description => 'List of allowed endpoints to include in audit log'
+          :description => 'List of allowed endpoints to include in audit log.'
         },
         :'audit_log.path' => {
           :default => DefaultSource.audit_log_path,
@@ -980,21 +963,21 @@ module NewRelic
           :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 `,`. For example, `Rails::Console,UninstrumentedBackgroundJob`.'
+          :description => 'Specify a list of constants that should prevent the agent from starting automatically. Separate individual constants with a comma `,`. For example, `"Rails::Console,UninstrumentedBackgroundJob"`.'
         },
         :'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, `rake,my_ruby_script.rb`.'
+          :description => 'Defines a comma-delimited list of executables that the agent should not instrument. For example, `"rake,my_ruby_script.rb"`.'
         },
         :'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, `assets:precompile,db:migrate`.'
+          :description => 'Defines a comma-delimited list of Rake tasks that the agent should not instrument. For example, `"assets:precompile,db:migrate"`.'
         },
         # Code level metrics
         :'code_level_metrics.enabled' => {
@@ -1158,7 +1141,7 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If `true`, disables the use of GC::Profiler to measure time spent in garbage collection'
+          :description => 'If `true`, disables the use of `GC::Profiler` to measure time spent in garbage collection'
         },
         :disable_memory_sampler => {
           :default => false,
@@ -1173,7 +1156,7 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'If `true`, the agent won\'t wrap third-party middlewares in instrumentation (regardless of whether they are installed via Rack::Builder or Rails).'
+          :description => 'If `true`, the agent won\'t wrap third-party middlewares in instrumentation (regardless of whether they are installed via `Rack::Builder` or Rails).'
         },
         :disable_samplers => {
           :default => false,
@@ -1209,7 +1192,7 @@ module NewRelic
 
                   To continue using cross application tracing, update the following options in your `newrelic.yml` configuration file:
 
-                  ```
+                  ```yaml
                   # newrelic.yml
 
                     cross_application_tracer:
@@ -1272,7 +1255,7 @@ module NewRelic
           :type => Array,
           :allowed_from_server => false,
           :transform => DefaultSource.method(:convert_to_list),
-          :description => 'Ordinarily the agent reports dyno names with a trailing dot and process ID (for example, <b>worker.3</b>). You can remove this trailing data by specifying the prefixes you want to report without trailing data (for example, <b>worker</b>).'
+          :description => 'Ordinarily the agent reports dyno names with a trailing dot and process ID (for example, `worker.3`). You can remove this trailing data by specifying the prefixes you want to report without trailing data (for example, `worker`).'
         },
         # Infinite tracing
         :'infinite_tracing.trace_observer.host' => {
@@ -1281,10 +1264,10 @@ module NewRelic
           :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."
+          :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,
@@ -1292,7 +1275,7 @@ module NewRelic
           :type => Integer,
           :allowed_from_server => false,
           :external => :infinite_tracing,
-          :description => "Configures the TCP/IP port for the trace observer Host"
+          :description => 'Configures the TCP/IP port for the trace observer Host'
         },
         # Instrumentation
         :'instrumentation.active_support_logger' => {
@@ -1302,7 +1285,7 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of ActiveSupport::Logger at start up.  May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of `ActiveSupport::Logger` at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.bunny' => {
           :default => 'auto',
@@ -1310,7 +1293,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of bunny at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.fiber' => {
           :default => 'auto',
@@ -1318,7 +1301,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the Fiber class at start up. May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the Fiber class at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.concurrent_ruby' => {
           :default => 'auto',
@@ -1326,7 +1309,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the concurrent-ruby library at start up. May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the concurrent-ruby library at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.curb' => {
           :default => 'auto',
@@ -1335,7 +1318,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of Curb at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.delayed_job' => {
           :default => 'auto',
@@ -1344,7 +1327,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of Delayed Job at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.elasticsearch' => {
           :default => 'auto',
@@ -1352,7 +1335,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the elasticsearch library at start up. May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the elasticsearch library at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.excon' => {
           :default => 'enabled',
@@ -1361,7 +1344,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of Excon at start up.  May be one of [enabled|disabled]."
+          :description => 'Controls auto-instrumentation of Excon at start up.  May be one of: `enabled`, `disabled`.'
         },
         :'instrumentation.grape' => {
           :default => 'auto',
@@ -1369,16 +1352,16 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of Grape at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.grpc_client' => {
-          :default => instrumentation_value_of(:disable_grpc_client),
+          :default => 'auto',
           :documentation_default => 'auto',
           :public => true,
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of gRPC clients at start up.  May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of gRPC clients at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.grpc.host_denylist' => {
           :default => [],
@@ -1386,16 +1369,16 @@ module NewRelic
           :type => Array,
           :allowed_from_server => false,
           :transform => DefaultSource.method(:convert_to_regexp_list),
-          :description => %Q(Specifies a list of hostname patterns separated by commas that will match gRPC hostnames that traffic is to be ignored by New Relic for. New Relic's gRPC client instrumentation will ignore traffic streamed to a host matching any of these patterns, and New Relic's gRPC server instrumentation will ignore traffic for a server running on a host whose hostname matches any of these patterns. By default, no traffic is ignored when gRPC instrumentation is itself enabled. For example, "private.com$,exception.*")
+          :description => %Q(Specifies a list of hostname patterns separated by commas that will match gRPC hostnames that traffic is to be ignored by New Relic for. New Relic's gRPC client instrumentation will ignore traffic streamed to a host matching any of these patterns, and New Relic's gRPC server instrumentation will ignore traffic for a server running on a host whose hostname matches any of these patterns. By default, no traffic is ignored when gRPC instrumentation is itself enabled. For example, `"private.com$,exception.*"`)
         },
         :'instrumentation.grpc_server' => {
-          :default => instrumentation_value_of(:disable_grpc_server),
+          :default => 'auto',
           :documentation_default => 'auto',
           :public => true,
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of gRPC servers at start up.  May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of gRPC servers at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.httpclient' => {
           :default => 'auto',
@@ -1404,7 +1387,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of HTTPClient at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.httprb' => {
           :default => 'auto',
@@ -1413,7 +1396,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of http.rb gem at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.logger' => {
           :default => instrumentation_value_from_boolean(:'application_logging.enabled'),
@@ -1422,7 +1405,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of Ruby standard library Logger at start up.  May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of Ruby standard library Logger at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.memcache' => {
           :default => 'auto',
@@ -1430,7 +1413,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of dalli gem for Memcache at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.memcached' => {
           :default => 'auto',
@@ -1439,16 +1422,16 @@ module NewRelic
           :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].'
+          :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),
+          :default => 'auto',
           :documentation_default => 'auto',
           :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].'
+          :description => 'Controls auto-instrumentation of memcache-client gem for Memcache at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.mongo' => {
           :default => 'enabled',
@@ -1457,7 +1440,7 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of Mongo at start up.  May be one of [enabled|disabled]."
+          :description => 'Controls auto-instrumentation of Mongo at start up.  May be one of: `enabled`, `disabled`.'
         },
         :'instrumentation.net_http' => {
           :default => 'auto',
@@ -1466,7 +1449,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of `Net::HTTP` at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.puma_rack' => {
           :default => value_of(:'instrumentation.rack'),
@@ -1475,9 +1458,9 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of Puma::Rack. When enabled, the agent hooks into the " \
-                           "`to_app` method in Puma::Rack::Builder to find gems to instrument during " \
-                           "application startup.  May be one of [auto|prepend|chain|disabled]."
+          :description => 'Controls auto-instrumentation of `Puma::Rack`. When enabled, the agent hooks into the ' \
+                           '`to_app` 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 => value_of(:'instrumentation.rack_urlmap'),
@@ -1486,7 +1469,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of `Puma::Rack::URLMap` at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.rack' => {
           :default => 'auto',
@@ -1495,9 +1478,9 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of Rack. When enabled, the agent hooks into the " \
-                           "`to_app` method in Rack::Builder to find gems to instrument during " \
-                           "application startup.  May be one of [auto|prepend|chain|disabled]."
+          :description => 'Controls auto-instrumentation of Rack. When enabled, the agent hooks into the ' \
+                           '`to_app` method in `Rack::Builder` to find gems to instrument during ' \
+                           'application startup.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.rack_urlmap' => {
           :default => 'auto',
@@ -1506,7 +1489,7 @@ module NewRelic
           :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].'
+          :description => 'Controls auto-instrumentation of `Rack::URLMap` at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.rake' => {
           :default => 'auto',
@@ -1514,7 +1497,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of rake at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.redis' => {
           :default => 'auto',
@@ -1522,7 +1505,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of Redis at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.resque' => {
           :default => 'auto',
@@ -1531,7 +1514,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of resque at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.sinatra' => {
           :default => 'auto',
@@ -1539,7 +1522,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of Sinatra at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.thread' => {
           :default => 'auto',
@@ -1547,29 +1530,29 @@ module NewRelic
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of the Thread class at start up to allow the agent to correctly nest spans inside of an asynchronous transaction. This does not enable the agent to automatically trace all threads created (see `instrumentation.thread.tracing`). May be one of [auto|prepend|chain|disabled]."
+          :description => 'Controls auto-instrumentation of the Thread class at start up to allow the agent to correctly nest spans inside of an asynchronous transaction. This does not enable the agent to automatically trace all threads created (see `instrumentation.thread.tracing`). May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.thread.tracing' => {
           :default => true,
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of the Thread class at start up to automatically add tracing to all Threads created in the application."
+          :description => 'Controls auto-instrumentation of the Thread class at start up to automatically add tracing to all Threads created in the application.'
         },
         :'thread_ids_enabled' => {
           :default => false,
           :public => false,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => "If enabled, will append the current Thread and Fiber object ids onto the segment names of segments created in Threads and concurrent-ruby"
+          :description => 'If enabled, will append the current Thread and Fiber object ids onto the segment names of segments created in Threads and concurrent-ruby'
         },
         :'instrumentation.tilt' => {
-          :default => "auto",
+          :default => 'auto',
           :public => true,
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the Tilt template rendering library at start up. May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the Tilt template rendering library at start up. May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         :'instrumentation.typhoeus' => {
           :default => 'auto',
@@ -1578,7 +1561,7 @@ module NewRelic
           :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]."
+          :description => 'Controls auto-instrumentation of Typhoeus at start up.  May be one of: `auto`, `prepend`, `chain`, `disabled`.'
         },
         # Message tracer
         :'message_tracer.segment_parameters.enabled' => {
@@ -1686,14 +1669,14 @@ module NewRelic
           :public => true,
           :type => String,
           :allowed_from_server => true,
-          :description => 'Defines an obfuscation level for slow SQL queries. Valid options are `obfuscated`, `raw`, or `none`).'
+          :description => 'Defines an obfuscation level for slow SQL queries. Valid options are `obfuscated`, `raw`, or `none`.'
         },
         :'slow_sql.use_longer_sql_id' => {
           :default => false,
           :public => true,
           :type => Boolean,
           :allowed_from_server => true,
-          :description => 'Generate a longer sql_id for slow SQL traces. sql_id is used for aggregation of similar queries.'
+          :description => 'Generate a longer `sql_id` for slow SQL traces. `sql_id` is used for aggregation of similar queries.'
         },
         # Span events
         :'span_events.enabled' => {
@@ -1709,14 +1692,14 @@ module NewRelic
           :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."
+          :description => 'Sets the maximum number of span events to buffer when streaming to the trace observer.'
         },
         :'span_events.max_samples_stored' => {
           :default => 2000,
           :public => true,
           :type => Integer,
           :allowed_from_server => true,
-          :description => 'Defines the maximum number of span events reported from a single harvest. Any Integer between 1 and 10000 is valid.'
+          :description => 'Defines the maximum number of span events reported from a single harvest. Any Integer between `1` and `10000` is valid.'
         },
         # Strip exception messages
         :'strip_exception_messages.enabled' => {
@@ -2016,7 +1999,7 @@ module NewRelic
           :public => false,
           :type => String,
           :allowed_from_server => false,
-          :description => "URI for the New Relic data collection service."
+          :description => 'URI for the New Relic data collection service.'
         },
         :'infinite_tracing.batching' => {
           :default => true,
@@ -2024,8 +2007,8 @@ module NewRelic
           :type => Boolean,
           :allowed_from_server => false,
           :external => :infinite_tracing,
-          :description => "If `true` (the default), data sent to the trace observer is batched\ninstead of sending " \
-                          "each span individually."
+          :description => 'If `true` (the default), data sent to the trace observer is batched instead of ' \
+          'sending each span individually.'
         },
         :'infinite_tracing.compression_level' => {
           :default => :high,
@@ -2033,8 +2016,13 @@ module NewRelic
           :type => Symbol,
           :allowed_from_server => false,
           :external => :infinite_tracing,
-          :description => "Configure the compression level for data sent to the trace observer\nMay be one of " \
-          "[none|low|medium|high]\n'high' is the default. Set the level to 'none' to disable compression"
+          :description => <<~DESC
+            Configure the compression level for data sent to the trace observer.
+
+              May be one of: `:none`, `:low`, `:medium`, `:high`.
+
+              Set the level to `:none` to disable compression.
+          DESC
         },
         :js_agent_file => {
           :default => '',