newrelic_rpm 9.5.0 → 9.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5e1f4605a4afe166aa2035486a2433f91f4d0432666b787e6d9c5af9e5ee717
-  data.tar.gz: 16e7707b8c81774ea0c2bea54825d023c2849d0a03ab553e25800c131d9c2972
+  metadata.gz: 0ece3a3703c9847f5ddf5ddd8776a58ff03c6400e3d61053bfe227ea7ddc3d83
+  data.tar.gz: 14aa9f742b5a9e73d510ff88cfe5292007fb97a002a23d15bc835be72b3ae483
 SHA512:
-  metadata.gz: 8180f7caa158ce2ea794914376f441f5f912f46fbce8caca074b8c2c9a06fb84ca5e290eab2aa63dfa68f5385e6f7f9f3ede8ee00ee97fbc30d692b93721ec8e
-  data.tar.gz: 21062253bf9236563dcd226ccc4e5e2f8d1fceaed24f6047fb6ed23f485f8b0e4607bbe9b7985c4a63809767c2f4b5785e4ec52c25ff6d2ac186ff7fb8a149f7
+  metadata.gz: 670682da76dcf65d64bd634579e63bf82ab33dafbfd72b5e66605b136d10dcdcc655e8a1d5ecac2db58e948ec57775ef74c337a43428b8458a5436458c1d1522
+  data.tar.gz: 9f5e190e03218aa49d57dba5299770a93f0e835436f21144f65c9e149427a496468644950ccfd6274cdda0ed735002a46a20703afc79483767439266043c5f8e

data/CHANGELOG.md

@@ -1,5 +1,110 @@
 # New Relic Ruby Agent Release Notes
 
+## v9.7.0
+
+
+Version 9.7.0 introduces ViewComponent instrumentation, changes the endpoint used to access the cluster name for Elasticsearch instrumentation, removes the creation of the Ruby/Thread and Ruby/Fiber spans, and adds support for Falcon.
+
+- **Feature: ViewComponent instrumentation**
+
+  [ViewComponent](https://viewcomponent.org/) is a now an instrumented framework. The agent currently supports Roda versions 2.0.0+. [PR#2367](https://github.com/newrelic/newrelic-ruby-agent/pull/2367) 
+
+- **Feature: Use root path to access Elasticsearch cluster name**
+
+  Previously, the agent used the cluster health endpoint (`/_cluster/health`) to access the cluster name. However, this has been found to make startup unstable for large clusters. Now, the agent uses the more performant root endpoint (`/`).
+
+  Our thanks go to [@erikkessler1](https://github.com/erikkessler1), [@gremerritt](https://github.com/gremerritt), and [@joshbranham](https://github.com/joshbranham) for reporting the issue, suggesting solutions, and testing them. [Issue#2360](https://github.com/newrelic/newrelic-ruby-agent/issues/2360) [PR#2377](https://github.com/newrelic/newrelic-ruby-agent/pull/2377)
+
+- **Feature: Remove base64 dependency, use direct calls to String methods**
+
+  In version 9.6.0, the agent required the Ruby `base64` gem as a depdendency to prepare for deprecation warnings in Ruby 3.3 and the gem's removal from the Ruby standard libraries in 3.4. Including `base64` as a dependency has caused problems with version resolution in some environments.
+
+  To resolve this, the agent now directly calls the `String` methods used in the `base64` library in the new `NewRelic::Base64` module.
+
+  Thank you, [@Earlopain](https://github.com/Earlopain), for submitting this change. [PR#2378](https://github.com/newrelic/newrelic-ruby-agent/pull/2378)
+
+- **Feature: Add Falcon support**
+
+  The agent now supports the web server [Falcon](https://socketry.github.io/falcon/). [PR#2383](https://github.com/newrelic/newrelic-ruby-agent/pull/2383)
+
+- **Feature: Remove spans with name Ruby/Thread and Ruby/Fiber**
+
+  Due to the lack of helpful information and the confusion commonly caused by the spans named Ruby/Thread and Ruby/Fiber, these spans have been removed. However, the agents ability to monitor instrumented code running in a thread or fiber will remain unchanged. [PR#2389](https://github.com/newrelic/newrelic-ruby-agent/pull/2389)
+
+## v9.6.0
+
+Version 9.6.0 adds instrumentation for Async::HTTP, Ethon, and HTTPX, adds the ability to ignore specific routes with Roda, gleans Docker container IDs from cgroups v2-based containers, records additional synthetics attributes, fixes an issue with Rails 7.1 that could cause duplicate log records to be sent to New Relic, fixes a deprecation warning for the Sidekiq error handler, adds additional attributes for OpenTelemetry compatibility, and resolves some technical debt, thanks to the community.
+
+- **Feature: Add instrumentation for Async::HTTP**
+
+  The agent will now record spans for Async::HTTP requests. Versions 0.59.0 and above of the async-http gem are supported. [PR#2272](https://github.com/newrelic/newrelic-ruby-agent/pull/2272)
+
+- **Feature: Add instrumentation for Ethon**
+
+  Instrumentation has been added for the [Ethon](https://github.com/typhoeus/ethon) HTTP client gem. Versions 0.12.0 and above are supported. The agent will now record external request segments for invocations of `Ethon::Easy#perform` and `Ethon::Multi#perform`. NOTE: The [Typhoeus](https://github.com/typhoeus/typhoeus) gem is maintained by the same team that maintains Ethon and depends on Ethon for its functionality. To prevent duplicate reporting for each HTTP request, the Ethon instrumentation will be disabled when Typhoeus is detected. [PR#2260](https://github.com/newrelic/newrelic-ruby-agent/pull/2260)
+
+- **Feature: Add instrumentation for HTTPX**
+
+  The agent now offers instrumentation for the HTTP client [HTTPX](https://honeyryderchuck.gitlab.io/httpx/), provided the gem is at version 1.0.0 or above. [PR#2278](https://github.com/newrelic/newrelic-ruby-agent/pull/2278)
+
+- **Feature: Prevent the agent from starting in "rails" commands in Rails 7**
+
+  Previously, the agent ignored many Rails commands by default, such as `rails routes`, using Rake-specific logic. This was accomplished by setting these commands as default values for the config option `autostart.denylisted_rake_tasks`. However, Rails 7 no longer uses Rake for these commands, causing the agent to start running and attempting to record data when running these commands. The commands have now been added to the default value for the config option `autostart.denylisted_constants`, which will allow the agent to recognize these commands correctly in Rails 7 and prevent the agent from starting during ignored tasks. Note that the agent will continue to start-up when the `rails server` and `rails runner` commands are invoked. [PR#2239](https://github.com/newrelic/newrelic-ruby-agent/pull/2239)
+
+- **Feature: Glean Docker container ID for cgroups v2-based containers**
+
+  Previously, the agent was only capable of determining a host Docker container's ID if the container was based on cgroups v1. Now, containers based on cgroups v2 will also have their container IDs reported to New Relic. [PR#2229](https://github.com/newrelic/newrelic-ruby-agent/issues/2229).
+
+- **Feature: Update events with additional synthetics attributes when available**
+
+  The agent will now record additional synthetics attributes on synthetics events if these attributes are available.  [PR#2203](https://github.com/newrelic/newrelic-ruby-agent/pull/2203)
+
+- **Feature: Declare a gem dependency on the Ruby Base 64 gem 'base64'**
+
+  For compatibility with Ruby 3.4 and to silence compatibility warnings present in Ruby 3.3, declare a dependency on the `base64` gem. The New Relic Ruby agent uses the native Ruby `base64` gem for Base 64 encoding/decoding. The agent is joined by Ruby on Rails ([rails/rails@3e52adf](https://github.com/rails/rails/commit/3e52adf28e90af490f7e3bdc4bcc85618a4e0867)) and others in making this change in preparation for Ruby 3.3/3.4. [PR#2238](https://github.com/newrelic/newrelic-ruby-agent/pull/2238)
+
+- **Feature: Add Roda support for the newrelic_ignore\* family of methods**
+
+  The agent can now selectively disable instrumentation for particular requests within Roda applications. Supported methods include:
+  - `newrelic_ignore`: ignore a given route.
+  - `newrelic_ignore_apdex`: exclude a given route from consideration in overall Apdex calculations.
+  - `newrelic_ignore_enduser`: prevent automatic injection of the page load timing JavaScript when a route is rendered.
+
+  For more information, see [Roda Instrumentation](https://docs.newrelic.com/docs/apm/agents/ruby-agent/instrumented-gems/roda-instrumentation/). [PR#2267](https://github.com/newrelic/newrelic-ruby-agent/pull/2267)
+
+- **Feature: Add additional span attributes for OpenTelemetry compatibility**
+
+  For improved compatibility with OpenTelemetry's semantic conventions, the agent's datastore (for databases) and external request (for HTTP clients) segments have been updated with additional attributes.
+
+  Datastore segments now offer 3 additional attributes:
+  - `db.system`: The database system. For Ruby we use the database adapter name here.
+  - `server.address`: The database host.
+  - `server.port`: The database port.
+
+  External request segments now offer 3 additional attributes:
+  - `http.request.method`: The HTTP method (ex: 'GET')
+  - `server.address`: The target host.
+  - `server.port`: The target port.
+
+  For maximum backwards compatibility, no existing attributes have been renamed or removed. [PR#2283](https://github.com/newrelic/newrelic-ruby-agent/pull/2283)
+
+- **Bugfix: Stop sending duplicate log events for Rails 7.1 users**
+
+  Rails 7.1 introduced the public API [`ActiveSupport::BroadcastLogger`](https://api.rubyonrails.org/classes/ActiveSupport/BroadcastLogger.html). This logger replaces a private API, `ActiveSupport::Logger.broadcast`. In Rails versions below 7.1, the agent uses the `broadcast` method to stop duplicate logs from being recoded by broadcasted loggers. Now, we've updated the code to provide a similar duplication fix for the `ActiveSupport::BroadcastLogger` class. [PR#2252](https://github.com/newrelic/newrelic-ruby-agent/pull/2252)
+
+- **Bugfix: Resolve Sidekiq 8.0 error handler deprecation warning**
+
+  Sidekiq 8.0 will require procs passed to the error handler to include three arguments: error, context, and config. Users running sidekiq/main would receive a deprecation warning with this change any time an error was raised within a job. Thank you, [@fukayatsu](https://github.com/fukayatsu) for your proactive fix! [PR#2261](https://github.com/newrelic/newrelic-ruby-agent/pull/2261)
+
+- **Community: Resolve technical debt**
+
+  We also received some great contributions from community members to resolve some outstanding technical debt issues. Thank you for your contributions!
+    * Add and Replace SLASH and ROOT constants: [PR#2256](https://github.com/newrelic/newrelic-ruby-agent/pull/2256) [chahmedejaz](https://github.com/chahmedejaz)
+    * Remove pry as a dev dependency: PR#2665, PR#2273, AlajeBash (profile no longer active)
+    * Replace "start up" with "start-up": [PR#2249](https://github.com/newrelic/newrelic-ruby-agent/pull/2249) [chahmedejaz](https://github.com/chahmedejaz)
+    * Remove unused variables in test suites: [PR#2250](https://github.com/newrelic/newrelic-ruby-agent/pull/2250)
+
+
 ## v9.5.0
 
 Version 9.5.0 introduces Stripe instrumentation, allows the agent to record additional response information on a transaction when middleware instrumentation is disabled, introduces new `:'sidekiq.args.include'` and `:'sidekiq.args.exclude:` configuration options to permit capturing only certain Sidekiq job arguments, updates Elasticsearch datastore instance metrics, and fixes a bug in `NewRelic::Rack::AgentHooks.needed?`.
@@ -435,7 +540,7 @@ Version 8.15.0 of the agent confirms compatibility with Ruby 3.2.0, adds instrum
 
   | Configuration name                | Default | Behavior                                                                                                                        |
   | --------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
-  | `instrumentation.concurrent_ruby` | auto    | Controls auto-instrumentation of the concurrent-ruby library at start up. May be one of `auto`, `prepend`, `chain`, `disabled`. |
+  | `instrumentation.concurrent_ruby` | auto    | Controls auto-instrumentation of the concurrent-ruby library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`. |
 
 - **Infinite Tracing: Use batching and compression**
 
@@ -534,7 +639,7 @@ Version 8.12.0 of the agent delivers new Elasticsearch instrumentation, increase
 
   | Configuration name                | Default | Behavior                                                                                                                      |
   | --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
-  | `instrumentation.elasticsearch`   | auto    | Controls auto-instrumentation of the elasticsearch library at start up. May be one of `auto`, `prepend`, `chain`, `disabled`. |
+  | `instrumentation.elasticsearch`   | auto    | Controls auto-instrumentation of the elasticsearch library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`. |
   | `elasticsearch.capture_queries`   | true    | If `true`, the agent captures Elasticsearch queries in transaction traces.                                                    |
   | `elasticsearch.obfuscate_queries` | true    | If `true`, the agent obfuscates Elasticsearch queries in transaction traces.                                                  |
 
@@ -1149,7 +1254,7 @@ The multiverse collection of test suites requires a variety of data handling sof
 - **Bugfix: Prevent browser monitoring middleware from installing to middleware multiple times**
 
   In rare cases on jRuby, the BrowserMonitoring middleware could attempt to install itself
-  multiple times at start up. This bug fix addresses that by using a mutex to introduce
+  multiple times at start-up. This bug fix addresses that by using a mutex to introduce
   thread safety to the operation. Sintra in particular can have this race condition because
   its middleware stack is not installed until the first request is received.
 
@@ -1160,7 +1265,7 @@ The multiverse collection of test suites requires a variety of data handling sof
 - **Bugfix: nil Middlewares injection now prevented and gracefully handled in Sinatra**
 
   Previously, the agent could potentially inject multiples of an instrumented middleware if Sinatra received many
-  requests at once during start up and initialization due to Sinatra's ability to delay full start up as long as possible.
+  requests at once during start-up and initialization due to Sinatra's ability to delay full start-up as long as possible.
   This has now been fixed and the Ruby agent correctly instruments only once as well as gracefully handles nil middleware
   classes in general.
 
@@ -1391,7 +1496,7 @@ The multiverse collection of test suites requires a variety of data handling sof
 
 - **Additional Transaction Information applied to Span Events**
 
-  When Distributed Tracing and/or Infinite Tracing are enabled, the Agent will now incorporate additional information from the Transaction Event on to the root Span Event of the transaction.
+  When Distributed Tracing and/or Infinite Tracing are enabled, the agent will now incorporate additional information from the Transaction Event on to the root Span Event of the transaction.
 
   The following items are affected:
 
@@ -3377,7 +3482,7 @@ For more details on our Resque support, see https://docs.newrelic.com/docs/agent
 - Support agent when starting Resque Pool from Rake task
 
 When running resque-pool with its provided rake tasks, the agent would not
-start up properly. Thanks Tiago Sousa for the fix!
+start-up properly. Thanks Tiago Sousa for the fix!
 
 - Fix for DelayedJob + Rails 4.x queue depth metrics
 
@@ -5321,7 +5426,7 @@ Agent improvements to support future RPM enhancements
 - fix incompatibility in the developer mode with the safe_erb plugin
 - fix module namespace issue causing an error accessing
   NewRelic::Instrumentation modules
-- fix issue where the agent sometimes failed to start up if there was a
+- fix issue where the agent sometimes failed to start-up if there was a
   transient network problem
 - fix IgnoreSilentlyException message
 

data/CONTRIBUTING.md

@@ -178,13 +178,6 @@ opensource@newrelic.com.
 For more information about CLAs, please check out Alex Russell’s excellent post,
 [“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
 
-## Slack
-
-We host a public Slack with a dedicated channel for contributors and maintainers
-of open source projects hosted by New Relic.  If you are contributing to this
-project, you're welcome to request access to the #oss-contributors channel in
-the newrelicusers.slack.com workspace.  To request access, please use this [link](https://join.slack.com/t/newrelicusers/shared_invite/zt-1ayj69rzm-~go~Eo1whIQGYnu3qi15ng).
-
 ## Explorer's Hub
 
 New Relic hosts and moderates an online forum where customers can interact with

data/Rakefile

@@ -131,7 +131,7 @@ end
 
 desc 'Start an interactive console session'
 task :console do
-  require 'pry'
+  require 'pry' if ENV['ENABLE_PRY']
   require 'newrelic_rpm'
   ARGV.clear
   Pry.start

data/bin/newrelic

@@ -1,15 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# This command has been renamed "newrelic_rpm"
 # executes one of the commands in the new_relic/commands directory
 # pass the name of the command as an argument
 
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'new_relic/cli/command'
-begin
-  NewRelic::Cli::Command.run
-rescue NewRelic::Cli::Command::CommandFailure => failure
-  STDERR.puts failure.message
-  STDERR.puts failure.options if failure.options
-  exit(1)
-end
+load File.dirname(__FILE__) + '/newrelic_rpm'

data/bin/newrelic_rpm

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# executes one of the commands in the new_relic/commands directory
+# pass the name of the command as an argument
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'new_relic/cli/command'
+begin
+  NewRelic::Cli::Command.run
+rescue NewRelic::Cli::Command::CommandFailure => failure
+  STDERR.puts failure.message
+  STDERR.puts failure.options if failure.options
+  exit(1)
+end

data/init.rb

@@ -2,7 +2,7 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-# This is the initialization for the New Relic Ruby Agent when used as
+# This is the initialization for the New Relic Ruby agent when used as
 # a plugin
 require 'new_relic/control'
 
@@ -12,7 +12,7 @@ require 'new_relic/control'
 # If you can't find any log files and you don't see anything in your
 # application log files please visit support.newrelic.com.
 
-# Initializer for the NewRelic Ruby Agent
+# Initializer for the New Relic Ruby agent
 
 # After version 2.0 of Rails we can access the configuration directly.
 # We need it to add dev mode routes after initialization finished.

data/lib/new_relic/agent/agent.rb

@@ -47,7 +47,7 @@ require 'new_relic/agent/agent_helpers/transmit'
 
 module NewRelic
   module Agent
-    # The Agent is a singleton that is instantiated when the plugin is
+    # The agent is a singleton that is instantiated when the plugin is
     # activated.  It collects performance data from ruby applications
     # in realtime as the application runs, and periodically sends that
     # data to the NewRelic server.

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

@@ -11,7 +11,7 @@ module NewRelic
         def shutdown
           return unless started?
 
-          ::NewRelic::Agent.logger.info('Starting Agent shutdown')
+          ::NewRelic::Agent.logger.info('Starting agent shutdown')
 
           stop_event_loop
           trap_signals_for_litespeed

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

@@ -10,7 +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?
-          if [:puma, :passenger, :unicorn].include?(Agent.config[:dispatcher])
+          if [:puma, :passenger, :unicorn, :falcon].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/agent_helpers/start_worker_thread.rb

@@ -19,12 +19,12 @@ module NewRelic
         # See #connect for a description of connection_options.
         def start_worker_thread(connection_options = {})
           if disable = NewRelic::Agent.config[:disable_harvest_thread]
-            NewRelic::Agent.logger.info('Not starting Ruby Agent worker thread because :disable_harvest_thread is ' \
+            NewRelic::Agent.logger.info('Not starting Ruby agent worker thread because :disable_harvest_thread is ' \
               "#{disable}")
             return
           end
 
-          ::NewRelic::Agent.logger.debug('Creating Ruby Agent worker thread.')
+          ::NewRelic::Agent.logger.debug('Creating Ruby agent worker thread.')
           @worker_thread = Threading::AgentThread.create('Worker Loop') do
             deferred_work!(connection_options)
           end

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

@@ -103,7 +103,7 @@ module NewRelic
         # so we can disambiguate processes in the log file and make
         # sure they're running a reasonable version
         def log_version_and_pid
-          ::NewRelic::Agent.logger.debug("New Relic Ruby Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}")
+          ::NewRelic::Agent.logger.debug("New Relic Ruby agent #{NewRelic::VERSION::STRING} initialized: pid = #{$$}")
         end
 
         # Logs the configured application names
@@ -180,7 +180,7 @@ module NewRelic
 
           unless app_name_configured?
             NewRelic::Agent.logger.error('No application name configured.',
-              'The Agent cannot start without at least one. Please check your ',
+              'The agent cannot start without at least one. Please check your ',
               'newrelic.yml and ensure that it is valid and has at least one ',
               "value set for app_name in the #{NewRelic::Control.instance.env} ",
               'environment.')

data/lib/new_relic/agent/attribute_filter.rb

@@ -2,7 +2,7 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-# This class applies filtering rules as specified in the Agent Attributes
+# This class applies filtering rules as specified in the agent attributes
 # cross-agent spec.
 #
 # Instances of it are constructed by deriving a set of rules from the agent
@@ -44,7 +44,7 @@
 # 1. First, the names are compared lexicographically. This has the impact of
 #    forcing shorter (more general) rules towards the top of the list and longer
 #    (more specific) rules towards the bottom. This is important, because the
-#    Agent Attributes spec stipulates that the most specific rule for a given
+#    agent Attributes spec stipulates that the most specific rule for a given
 #    destination should take precedence. Since rules are applied top-to-bottom,
 #    this sorting guarantees that the most specific rule will be applied last.
 # 2. If the names are identical, we next examine the wildcard flag. Rules ending
@@ -274,7 +274,7 @@ module NewRelic
 
       def initialize(attribute_name, destinations, is_include)
         @attribute_name = attribute_name.sub(/\*$/, '')
-        @wildcard = attribute_name.end_with?('*')
+        @wildcard = attribute_name.end_with?(ASTERISK)
         @is_include = is_include
         @destinations = is_include ? destinations : ~destinations
       end