newrelic_rpm 8.16.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36c4100794a9189b995fb7c649be61e3770b1e47ea5c961624c6519bea637770
-  data.tar.gz: bd4cf6f4a56bdad905768d3306ab26649c8ff9564619ec0b4099db63043bc1f9
+  metadata.gz: b4283d6fa7224688ad73c78ae5b36f499eb377c96b0511050b588ac2b0884d8e
+  data.tar.gz: a10eafed3eaef851da18ba4b4bc8b8c3984f2fd4d7291750be84c418ba942132
 SHA512:
-  metadata.gz: 9a97a4611de30a1d96ea4afb7b24220dd86f289761fb17cac531acbaeb09ed55be183127a78fbb7c5dac153f68305d6f8e87164be7fe0ab97ef3faf5e42ce2d5
-  data.tar.gz: 8a5e4c91f9c89ba0e3317984865127ad30b9746b469f67246c9da20257ed4a2851d0148f191b19288655aec642d79edbcd71d98f0cd2ebe60c7c7e95e8696336
+  metadata.gz: e680bc7110e8fd9efd9e25ec3559512c74f7f254922a73f80b79cefbef1f5a88d43c6b68cefe4297f64cc430b96e0a561e9980abaa6c7074a51dd8b8f5f13fb0
+  data.tar.gz: 0530bc3faa79c4259eee31482bf08adeea08966fead73979f65c7c17f0f33293b905c265a125fd69318f0130c48ae61ab5a4071fa9a1be101c0e47bba2b61abd

data/.rubocop.yml

@@ -1081,18 +1081,6 @@ Performance/MapCompact:
 Performance/MethodObjectAsBlock:
   Enabled: false
 
-# TODO: OLD RUBIES - Requires 2.4
-Performance/RegexpMatch:
-  Enabled: false
-
-# TODO: OLD RUBIES - Requires 2.4
-Performance/Sum:
-  Enabled: false
-
-# TODO: OLD RUBIES - Requires 2.3
-Performance/UnfreezeString:
-  Enabled: false
-
 # Disabling for now
 Security/Eval:
   Enabled: false
@@ -1330,11 +1318,6 @@ Style/ExplicitBlockArgument:
 Style/ExponentialNotation:
   Enabled: false
 
-# TODO: MAJOR VERSION - Re-enable FetchEnvVar after dropping support for Ruby 2.2
-#                       Ruby 2.3+ allows for ENV.fetch('KEY') { default }
-Style/FetchEnvVar:
-  Enabled: false
-
 Style/FloatDivision:
   Enabled: false
 
@@ -1740,17 +1723,6 @@ Style/RescueStandardError:
 Style/ReturnNil:
   Enabled: false
 
-# Can't use, not available in Ruby 2.2
-Style/SafeNavigation:
-  Enabled: false
-  # ConvertCodeThatCanStartToReturnNil: false
-  # AllowedMethods:
-  #   - present?
-  #   - blank?
-  #   - presence
-  #   - try
-  #   - try!
-
 Style/Sample:
   Enabled: true
 

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-10-03 22:57:47 UTC using RuboCop version 1.36.0.
+# on 2023-02-02 15:27:55 UTC using RuboCop version 1.44.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 412
+# Offense count: 422
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 54
@@ -31,7 +31,13 @@ Minitest/DuplicateTestRun:
     - 'test/multiverse/suites/rails/error_tracing_test.rb'
     - 'test/multiverse/suites/sinatra/ignoring_test.rb'
 
-# Offense count: 263
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Minitest/EmptyLineBeforeAssertionMethods:
+  Exclude:
+    - 'test/new_relic/agent_test.rb'
+
+# Offense count: 269
 Minitest/MultipleAssertions:
   Max: 28
 
@@ -57,6 +63,38 @@ Minitest/EmptyLineBeforeAssertionMethods:
     - 'test/new_relic/agent_test.rb'
     - 'test/new_relic/cli/commands/deployments_test.rb'
 
+# Offense count: 23
+# This cop supports safe autocorrection (--autocorrect).
+Performance/RegexpMatch:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: OnlySumOrWithInitialValue.
+Performance/Sum:
+  Exclude:
+    - 'lib/new_relic/agent/system_info.rb'
+
+# Offense count: 72
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Performance/UnfreezeString:
+  Enabled: false
+
+# Offense count: 21
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedVars.
+Style/FetchEnvVar:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
 Style/RedundantStringEscape:
   Exclude:
     - 'test/new_relic/agent/logging_test.rb'
+
+# Offense count: 115
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,131 @@
 # New Relic Ruby Agent Release Notes
 
+## v9.0.0
+
+  Version 9.0.0 of the agent removes several deprecated configuration options and API methods, enables Thread tracing by default, adds Fiber instrumentation, removes support for Ruby versions 2.2 and 2.3, removes instrumentation for several deprecated gems, changes how the API method `set_transaction_name` works, and updates `rails_defer_initialization` to be an environment variable only configuration option.
+
+
+- **Remove deprecated configuration options**
+
+  The following configuration options have been removed and will no longer work. Please update all configs to use the replacements listed below. [PR#1782](https://github.com/newrelic/newrelic-ruby-agent/pull/1782)
+
+  |  Removed                                  | Replacement                               | `newrelic.yml` example                                                              |
+  | ----------------------------------------- | ----------------------------------------- | ----------------------------------------------------------------------------------- |
+  | `analytics_events.capture_attributes`     | `transaction_events.attributes.enabled`   | `transaction_events.attributes.enabled: false`                                      |
+  | `browser_monitoring.capture_attributes`   | `browser_monitoring.attributes.enabled`   | `browser_monitoring.attributes.enabled: false`                                      |
+  | `error_collector.capture_attributes`      | `error_collector.attributes.enabled`      | `error_collector.attributes.enabled: false`                                         |
+  | `resque.capture_params`                   | `attributes.include`                      | `attributes.include: ['job.resque.args.*']`                                         |
+  | `sidekiq.capture_params`                  | `attributes.include`                      | `attributes.include: ['job.sidekiq.args.*']`                                        |
+  | `transaction_tracer.capture_attributes`   | `transaction_tracer.attributes.enabled`   | `transaction_tracer.attributes.enabled: false`                                      |
+  | `error_collector.ignore_errors`           | `error_collector.ignore_classes`          | `error_collector.ignore_classes: ['ActionController::RoutingError', 'CustomError']` |
+  | `analytics_events.enabled`                | `transaction_events.enabled`              | `transaction_events.enabled: false`                                                 |
+  | `analytics_events.max_samples_stored`     | `transaction_events.max_samples_stored`   | `transaction_events.max_samples_stored: 1200`                                       |
+  | `disable_database_instrumentation`        | `disable_sequel_instrumentation`          | `disable_sequel_instrumentation: true`                                              |
+  | `disable_bunny`                           | `instrumentation.bunny`                   | `instrumentation.bunny: disabled`                                                   |
+  | `disable_curb`                            | `instrumentation.curb`                    | `instrumentation.curb: disabled`                                                    |
+  | `disable_dj`                              | `instrumentation.delayed_job`             | `instrumentation.delayed_job: disabled`                                             |
+  | `disable_excon`                           | `instrumentation.excon`                   | `instrumentation.excon: disabled`                                                   |
+  | `disable_grape`                           | `instrumentation.grape`                   | `instrumentation.grape: disabled`                                                   |
+  | `disable_grape_instrumentation`           | `instrumentation.grape`                   | `instrumentation.grape: disabled`                                                   |
+  | `disable_httpclient`                      | `instrumentation.httpclient`              | `instrumentation.httpcient: disabled`                                               |
+  | `disable_httprb`                          | `instrumentation.httprb`                  | `instrumentation.httprb: disabled`                                                  |
+  | `disable_dalli`                           | `instrumentation.memcache`                | `instrumentation.memcache: disabled`                                                |
+  | `disable_dalli_cas_client`                | `instrumentation.memcache`                | `instrumentation.memcache: disabled`                                                |
+  | `disable_memcache_client`                 | `instrumentation.memcache-client`         | `instrumentation.memcache-client: disabled`                                         |
+  | `disable_memcache_instrumentation`        | `instrumentation.memcache`                | `instrumentation.memcache: disabled`                                                |
+  | `disable_memcached`                       | `instrumentation.memcached`               | `instrumentation.memcached: disabled`                                               |
+  | `disable_mongo`                           | `instrumentation.mongo`                   | `instrumentation.mongo: disabled`                                                   |
+  | `disable_net_http`                        | `instrumentation.net_http`                | `instrumentation.net_http: disabled`                                                |
+  | `prepend_net_instrumentation`             | `instrumentation.net_http`                | `instrumentation.net_http: prepend`                                                 |
+  | `disable_puma_rack`                       | `instrumentation.puma_rack`               | `instrumentation.puma_rack: disabled`                                               |
+  | `disable_puma_rack_urlmap`                | `instrumentation.puma_rack_urlmap`        | `instrumentation.puma_rack_urlmap: disabled`                                        |
+  | `disable_rack`                            | `instrumentation.rack`                    | `instrumentation.rack: disabled`                                                    |
+  | `disable_rack_urlmap`                     | `instrumentation.rack_urlmap`             | `instrumentation.rack_urlmap: disabled`                                             |
+  | `disable_redis`                           | `instrumentation.redis`                   | `instrumentation.redis: disabled`                                                   |
+  | `disable_redis_instrumentation`           | `instrumentation.redis`                   | `instrumentation.redis: disabled`                                                   |
+  | `disable_resque`                          | `instrumentation.resque`                  | `instrumentation.resque: disabled`                                                  |
+  | `disable_sinatra`                         | `instrumentation.sinatra`                 | `instrumentation.sinatra: disabled`                                                 |
+  | `disable_rake`                            | `instrumentation.rake`                    | `instrumentation.rake: disabled`                                                    |
+  | `disable_rake_instrumentation`            | `instrumentation.rake`                    | `instrumentation.rake: disabled`                                                    |
+  | `disable_typhoeus`                        | `instrumentation.typhoeus`                | `instrumentation.typhoeus: disabled`                                                |
+
+
+
+
+- **Enable Thread instrumentation by default**
+
+  The configuration option `instrumentation.thread.tracing` is now enabled by default. This configuration allows the agent to properly monitor code occurring inside threads. In Ruby agent 9.0, instrumented code within threads will be recorded and associated with the current transaction when the thread was created.
+
+  This may be a breaking change if you are currently using custom thread instrumentation. New transactions inside of threads will no longer be started if one already exists. [PR#1767](https://github.com/newrelic/newrelic-ruby-agent/pull/1767)
+
+- **Add Fiber instrumentation**
+
+  `Fiber` instances are now automatically instrumented similarly to `Thread` instances. This can be [configured](https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration/#instrumentation-fiber) using `instrumentation.fiber`. [PR#1802](https://github.com/newrelic/newrelic-ruby-agent/pull/1802)
+
+
+- **Removed support for Ruby 2.2 and 2.3**
+
+  Ruby 2.2 and 2.3 are no longer supported by the Ruby agent. To continue using the latest Ruby Agent version, please update to Ruby 2.4.0 or above. [PR#1778](https://github.com/newrelic/newrelic-ruby-agent/pull/1778)
+
+- **Removed deprecated instrumentation**
+
+  Instrumentation for the following gems had been previously deprecated and has now been removed. [PR#1788](https://github.com/newrelic/newrelic-ruby-agent/pull/1788)
+    - Acts As Solr
+    - Authlogic
+    - DataMapper
+    - Rainbows
+    - Sunspot
+
+  Versions of the following technologies had been previously deprecated and are no longer supported.
+
+    - Passenger: 2.2.x - 4.0.x
+    - Puma: 2.0.x
+    - Grape: 0.2.0
+    - Padrino: 0.14.x
+    - Rails: 3.2.x
+    - Sinatra: 1.4.x, 1.5.x
+    - Mongo: 1.8.x - 2.3.x
+    - Sequel: 3.37.x, 4.0.x
+    - Delayed_Job: 2.0.x - 4.0.x
+    - Sidekiq: 4.2.x
+    - Excon: below 0.55.0
+    - HttpClient: 2.2.0 - 2.8.0
+    - HttpRb: 0.9.9 - 2.2.1
+    - Typhoeus: 0.5.3 - 1.2.x
+    - Bunny: 2.0.x - 2.6.x 
+    - ActiveMerchant: 1.25.0 - 1.64.x 
+
+
+- **Updated API method `set_transaction_name`**
+
+  When the method `NewRelic::Agent.set_transaction_name` is called, it will now always change the name and category of the currently running transaction to what is passed into the method. This is a change from previous agent versions.
+
+  Previously, if `set_transaction_name` was called with a new transaction name and a new category that did not match the category already assigned to a transaction, neither the new name nor category would be saved to the transaction. If this method is being called in a situation in which it was previously ignored due to category differences, this will now change the name and category of the transaction. [PR#1797](https://github.com/newrelic/newrelic-ruby-agent/pull/1797)
+
+- **Removed API method: `NewRelic::Agent.disable_transaction_tracing`**
+
+  The deprecated API method `NewRelic::Agent.disable_transaction_tracing` has been removed. Instead use either `NewRelic::Agent#ignore_transaction` to disable the recording of the current transaction or `NewRelic::Agent.disable_all_tracing` to yield a block without collecting any metrics or traces in any of the subsequent calls. [PR#1792](https://github.com/newrelic/newrelic-ruby-agent/pull/1792)
+
+- **Renamed ActiveJob metrics**
+
+  Previously, ActiveJob was categorized as a message broker, which is inaccurate. We've updated the naming of ActiveJob traces from leading with `MessageBroker/ActiveJob` to simply leading with `ActiveJob`. [PR#1811](https://github.com/newrelic/newrelic-ruby-agent/pull/1811)
+
+- **Code cleanup**
+
+  Thank you to community member [@esquith](https://github.com/esquith) for contributing some cleanup of orphaned constants in our code base. [PR#1793](https://github.com/newrelic/newrelic-ruby-agent/pull/1793) [PR#1794](https://github.com/newrelic/newrelic-ruby-agent/pull/1794) [PR#1808](https://github.com/newrelic/newrelic-ruby-agent/pull/1808)
+
+  Community member [@fchatterji](https://github.com/fchatterji) helped standardize how we reference `NewRelic` throughout our codebase [PR#1795](https://github.com/newrelic/newrelic-ruby-agent/pull/1795) and updated our README's community header [PR#1815](https://github.com/newrelic/newrelic-ruby-agent/pull/1815). Thanks fchatterji!
+
+
+- **Bugfix: Allow rails initialization to be deferred by environment variable**
+
+  The Ruby agent may force some Rails libraries to load on agent initialization, preventing some settings defined in `config/initializers` from being applied. Changing the initialization process to run after `config/initializers`, however, may break the configuration for other gems (ex. Roadie Rails).
+
+  For those having troubles with agent initialization and Rails initializers, you can now pass the environment variable `NEW_RELIC_DEFER_RAILS_INITIALIZATION=true` to make the agent initialize after `config/initializers` are run. This config option can only be set using an environment variable and can't be set using YAML. [PR#1791](https://github.com/newrelic/newrelic-ruby-agent/pull/1791)
+
+  Thanks to [@jdelStrother](https://github.com/jdelStrother) for bringing this issue to our attention and testing our fixes along the way. [Issue#662](https://github.com/newrelic/newrelic-ruby-agent/issues/662)
+
+
 ## 8.16.0
 
 Version 8.16.0 introduces more Ruby on Rails instrumentation (especially for Rails 6 and 7) for various Action\*/Active\* libraries whose actions produce [Active Support notifications events](https://guides.rubyonrails.org/active_support_instrumentation.html).

data/CONTRIBUTING.md

@@ -94,7 +94,7 @@ includes unreleased work. Please create all new branches off of `dev`.
     - Fork the repository inside GitHub
     - `git clone git@github.com:<gh username>/newrelic-ruby-agent.git`
 1. Pick a Ruby version
-    - Use rbenv, rvm, chruby, asdf, etc. to install any version of Ruby between 2.2 up to the latest stable version
+    - Use rbenv, rvm, chruby, asdf, etc. to install any version of Ruby between 2.4 up to the latest stable version
 1. Install development dependencies
     - `bundle install`
 1. Check that your env is setup correctly

data/README.md

@@ -1,4 +1,4 @@
-[![Open Source, New Relic Community Plus: This code is currently maintained by New Relic engineering teams and delivered here in GitHub. See the README for troubleshooting and defect reporting instructions.](https://github.com/newrelic/open-source-office/raw/master/examples/categories/images/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+[![Community Plus header](https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
 
 
 # New Relic Ruby Agent
@@ -12,6 +12,8 @@ to help you improve the customer experience and make data-driven business decisi
 The New Relic Ruby agent is dual-purposed as either a Gem or a Rails plugin,
 hosted on [github](https://github.com/newrelic/newrelic-ruby-agent).
 
+This code is actively maintained by New Relic engineering teams and delivered here in GitHub. See below for troubleshooting and defect reporting instructions.
+
 [![Gem Version](https://badge.fury.io/rb/newrelic_rpm.svg)](https://badge.fury.io/rb/newrelic_rpm)
 
 ## Supported Environments

data/bin/nrdebug

@@ -155,7 +155,7 @@ class RubyProcess
   def gdb_script_body(backtrace_file)
     backtrace_gathering_code = 'Thread.list.each { |t| bt = t.backtrace rescue nil; ' \
       'puts \"#{t.inspect}\n#{bt && bt.join(\"\n\")}\n\n\" }'
-    <<-END
+    <<~END
       attach #{pid}
       t a a bt
       call (void)close(1)
@@ -247,21 +247,21 @@ class ProcessReport
 end
 
 def prompt_for_confirmation(target_pid, target_cmd)
-  puts <<-PROMPT
-  Are you sure you want to attach to PID #{target_pid} ('#{target_cmd}')}?
-  
-  ************************** !WARNING! **************************
-  Extracting debug information from this process may cause it to CRASH OR HANG.
-  
-  It is highly recommended that you only run this script against processes that
-  are already unresponsive.
-  
-  Additionally, the output may contain sensitive information from the program's
-  command line arguments, environment, or open file list. Please examine the
-  output before sharing it.
-  ************************** !WARNING! **************************
-  
-  To continue, type 'continue':
+  puts <<~PROMPT
+    Are you sure you want to attach to PID #{target_pid} ('#{target_cmd}')}?
+
+    ************************** !WARNING! **************************
+    Extracting debug information from this process may cause it to CRASH OR HANG.
+
+    It is highly recommended that you only run this script against processes that
+    are already unresponsive.
+
+    Additionally, the output may contain sensitive information from the program's
+    command line arguments, environment, or open file list. Please examine the
+    output before sharing it.
+    ************************** !WARNING! **************************
+
+    To continue, type 'continue':
   PROMPT
 
   until $stdin.gets.strip == 'continue'

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

@@ -162,7 +162,7 @@ module NewRelic
 
         def connect_options(options)
           {
-            keep_retrying: Agent.config[:keep_retrying],
+            keep_retrying: true,
             force_reconnect: Agent.config[:force_reconnect]
           }.merge(options)
         end

data/lib/new_relic/agent/agent_helpers/special_startup.rb

@@ -10,8 +10,7 @@ module NewRelic
         # requests, we need to wait until the children are forked
         # before connecting, otherwise the parent process sends useless data
         def using_forking_dispatcher?
-          # TODO: MAJOR VERSION - remove :rainbows
-          if [:puma, :passenger, :rainbows, :unicorn].include?(Agent.config[:dispatcher])
+          if [:puma, :passenger, :unicorn].include?(Agent.config[:dispatcher])
             ::NewRelic::Agent.logger.info("Deferring startup of agent reporting thread because " \
               "#{Agent.config[:dispatcher]} may fork.")
             true

data/lib/new_relic/agent/attribute_filter.rb

@@ -124,8 +124,6 @@ module NewRelic
 
       def prep_capture_params_rules(config)
         build_rule(['request.parameters.*'], include_destinations_for_capture_params(config[:capture_params]), true)
-        build_rule(['job.resque.args.*'], include_destinations_for_capture_params(config[:'resque.capture_params']), true)
-        build_rule(['job.sidekiq.args.*'], include_destinations_for_capture_params(config[:'sidekiq.capture_params']), true)
       end
 
       def prep_datastore_rules(config)

data/lib/new_relic/agent/commands/thread_profiler_session.rb

@@ -89,9 +89,9 @@ module NewRelic
         end
 
         def raise_unsupported_error
-          msg = <<-EOF
-Thread profiling is not supported for Resque processes. If you did not intend to
-profile a Resque process, profiling again might select an appropriate agent.
+          msg = <<~EOF
+            Thread profiling is not supported for Resque processes. If you did not intend to
+            profile a Resque process, profiling again might select an appropriate agent.
           EOF
           raise_command_error(msg)
         end