Prerelease 9.17.0-pre

CHANGELOG.md

@@ -1,6 +1,6 @@
 # New Relic Ruby Agent Release Notes
 
-## dev
+## v9.17.0
 
 - **Feature: Add support for Trilogy database adapter**
 

lib/new_relic/version.rb

@@ -6,7 +6,7 @@
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 9
-    MINOR = 16
+    MINOR = 17
     TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

newrelic.yml

@@ -129,43 +129,42 @@ common: &default_settings
   # Here is some Ruby source code that defines a render_png instance method for an
   # Image class and a notify class method for a User class, both within a
   # MyCompany module namespace:
-  #
+  # ``rb
   # module MyCompany
-  #   class Image
-  #     def render_png
-  #       # code to render a PNG
-  #     end
-  #   end
-  #
-  #   class User
-  #     def self.notify
-  #       # code to notify users
-  #     end
-  #   end
+  # class Image
+  # def render_png
+  # # code to render a PNG
   # end
-  #
+  # end
+  # class User
+  # def self.notify
+  # # code to notify users
+  # end
+  # end
+  # end
+  # `
   # Given that source code, the newrelic.yml config file might request
   # instrumentation for both of these methods like so:
-  #
+  # `yaml
   # automatic_custom_instrumentation_method_list:
   # - MyCompany::Image#render_png
   # - MyCompany::User.notify
-  #
+  # `
   # That configuration example uses YAML array syntax to specify both methods.
   # Alternatively, you can use a comma-delimited string:
-  #
+  # `yaml
   # automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png,
   # MyCompany::User.notify'
-  #
+  # `
   # Whitespace around the comma(s) in the list is optional. When configuring the
   # agent with a list of methods via the
   # NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST environment variable,
   # use this comma-delimited string format:
-  #
+  # `sh
   # export
   # NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png,
   # MyCompany::User.notify'
-  #
+  # ``
   # automatic_custom_instrumentation_method_list: []
 
   # Specify a list of constants that should prevent the agent from starting
@@ -205,9 +204,8 @@ common: &default_settings
   # monitoring scripts. For now, auto-injection only works with Rails 5.2+.
   # browser_monitoring.content_security_policy_nonce: true
 
-  # Manual override for the path to your local CA bundle. This CA bundle will be
-  # used to validate the SSL certificate presented by New Relic's data collection
-  # service.
+  # Manual override for the path to your local CA bundle. This CA bundle validates
+  # the SSL certificate presented by New Relic's data collection service.
   # ca_bundle_path: nil
 
   # Enable or disable the capture of memcache keys from transaction traces.
@@ -323,7 +321,18 @@ common: &default_settings
   # If true, disables agent middleware for Sinatra. This middleware is responsible
   # for advanced feature support such as cross application tracing, page load
   # timing, and error collection.
-  #
+  # Cross application tracing is deprecated in favor of distributed tracing.
+  # Distributed tracing is on by default for Ruby agent versions 8.0.0 and above.
+  # Middlewares are not required to support distributed tracing.
+  # To continue using cross application tracing, update the following options in
+  # your newrelic.yml configuration file:
+  # ``yaml
+  # # newrelic.yml
+  # cross_application_tracer:
+  # enabled: true
+  # distributed_tracing:
+  # enabled: false
+  # ``
   # disable_sinatra_auto_middleware: false
 
   # If true, disables view instrumentation.
@@ -723,8 +732,8 @@ common: &default_settings
 
   # If true, the agent will operate in a streamlined mode suitable for use with
   # short-lived serverless functions. NOTE: Only AWS Lambda functions are
-  # supported currently and this option is not intended for use without New
-  # Relic's Ruby Lambda layer offering.
+  # supported currently and this option isn't intended for use without New Relic's
+  # Ruby Lambda layer offering.
   # serverless_mode.enabled: false
 
   # An array of strings that will collectively serve as a denylist for filtering
@@ -803,17 +812,17 @@ common: &default_settings
   # not be reported to New Relic. Each string in this array will be turned into a
   # regular expression via
   # Regexp.new to permit advanced matching. For each hash pair, if either the key
-  # or value is matched the
-  # pair will not be reported. By default, no user_data is reported, so this
-  # option should only be used if
-  # the stripe.user_data.include option is being used.
+  # or value is matched the pair
+  # isn't reported. By default, no user_data is reported. Use this option only if
+  # the
+  # stripe.user_data.include option is also used.
   # stripe.user_data.exclude: []
 
   # An array of strings to specify which keys inside a Stripe event's user_data
   # hash should be reported
   # to New Relic. Each string in this array will be turned into a regular
   # expression via Regexp.new to
-  # permit advanced matching. Setting the value to ["."] will report all
+  # enable advanced matching. Setting the value to ["."] will report all
   # user_data.
   # stripe.user_data.include: []
 
@@ -877,7 +886,7 @@ common: &default_settings
 
   # If true, enables the collection of explain plans in transaction traces. This
   # setting will also apply to explain plans in slow SQL traces if
-  # slow_sql.explain_enabled is not set separately.
+  # slow_sql.explain_enabled isn't set separately.
   # transaction_tracer.explain_enabled: true
 
   # Threshold (in seconds) above which the agent will collect explain plans.
@@ -951,20 +960,20 @@ common: &default_settings
   #   NOTE: All "security.*" configuration parameters are related only to the
   #         security agent, and all other configuration parameters that may
   #         have "security" in the name somewhere are related to the APM agent.
-
-  # If true, the security agent is loaded (a Ruby 'require' is performed)
+  
+  # If true, the security agent loads (the agent performs a Ruby 'require')
   # security.agent.enabled: false
 
   # The port the application is listening on. This setting is mandatory for
-  # Passenger servers. Other servers are detected by default.
+  # Passenger servers. The agent detects other servers by default.
   # security.application_info.port: nil
 
   # If true, the security agent is started (the agent runs in its event loop)
   # security.enabled: false
 
   # Defines API paths the security agent should ignore in IAST scans. Accepts an
   # array of regex patterns matching the URI to ignore. The regex pattern should
-  # provide a complete match for the URL without the endpoint. For example,
+  # find a complete match for the URL without the endpoint. For example,
   # [".*account.*"], [".*/\api\/v1\/.*?\/login"]
   # security.exclude_from_iast_scan.api: []
 
@@ -985,8 +994,8 @@ common: &default_settings
   # If true, disables system command injection detection in IAST scans.
   # security.exclude_from_iast_scan.iast_detection_category.command_injection: false
 
-  # If true, disables the detection of low-severity insecure settings (e.g., hash,
-  # crypto, cookie, random generators, trust boundary).
+  # If true, disables the detection of low-severity insecure settings. For
+  # example, hash, crypto, cookie, random generators, trust boundary).
   # security.exclude_from_iast_scan.iast_detection_category.insecure_settings: false
 
   # If true, disables file operation-related IAST detections (File Access &
@@ -1015,8 +1024,8 @@ common: &default_settings
   # If true, disables XPATH injection detection in IAST scans.
   # security.exclude_from_iast_scan.iast_detection_category.xpath_injection: false
 
-  # Unique test identifier when runnning IAST in CI/CD environment to
-  # differentiate between different test runs, e.g., a build number.
+  # A unique test identifier when runnning IAST in a CI/CD environment to
+  # differentiate between different test runs. For example, a build number.
   # security.iast_test_identifier: nil
 
   # Defines the mode for the security agent to operate in. Currently only IAST is
@@ -1031,20 +1040,20 @@ common: &default_settings
   # disables Reflected Cross-Site Scripting (RXSS) vulnerability detection.
   # security.scan_controllers.report_http_response_body: true
 
-  # The number of application instances for a specific entity on which IAST
-  # analysis is performed.
+  # The number of application instances for a specific entity to perform IAST
+  # analysis on.
   # security.scan_controllers.scan_instance_count: 0
 
-  # If true, allows IAST to continuously gather trace data in the background.
-  # Collected data will be used by the security agent to perform an IAST scan at
-  # the scheduled time.
+  # If true, allows IAST to continuously gather trace data in the background. The
+  # security agent uses collected data to perform an IAST scan at the scheduled
+  # time.
   # security.scan_schedule.always_sample_traces: false
 
   # Specifies the delay time (in minutes) before the IAST scan begins after the
   # application starts.
   # security.scan_schedule.delay: 0
 
-  # Specifies the length of time (in minutes) that the IAST scan will run.
+  # Indicates the duration (in minutes) for which the IAST scan will be performed.
   # security.scan_schedule.duration: 0
 
   # Specifies a cron expression that sets when the IAST scan should run.