Merge pull request #2683 from newrelic/dev

Release 9.10.1

Author: kaylareopelle

.github/workflows/ci_cron.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Configure git
         run: 'git config --global init.defaultBranch main'
       - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # tag v4.1.2
-      - uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+      - uses: ruby/setup-ruby@943103cae7d3f1bb1e4951d5fcc7928b40e4b742 # tag v1.177.1
         with:
           ruby-version: '3.3'
       - run: bundle
@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [2.4.10, 2.5.9, 2.6.10, 2.7.8, 3.0.7, 3.1.5, 3.2.4, 3.3.1]
+        ruby-version: [2.4.10, 2.5.9, 2.6.10, 2.7.8, 3.0.7, 3.1.5, 3.2.4, 3.3.1, 3.4.0-preview1]
 
     steps:
       - name: Configure git
@@ -50,7 +50,7 @@ jobs:
         run: sudo apt-get update; sudo apt-get install -y --no-install-recommends libcurl4-nss-dev libsasl2-dev libxslt1-dev
 
       - name: Install Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+        uses: ruby/setup-ruby@943103cae7d3f1bb1e4951d5fcc7928b40e4b742 # tag v1.177.1
         with:
           ruby-version: ${{ matrix.ruby-version }}
 
@@ -83,6 +83,9 @@ jobs:
               },
               "3.3.1": {
                 "rails": "norails,rails61,rails70"
+              },
+              "3.4.0-preview1": {
+                "rails": "norails,rails61,rails70"
               }
             }
 
@@ -200,7 +203,7 @@ jobs:
       fail-fast: false
       matrix:
         multiverse: [agent, ai, background, background_2, database, frameworks, httpclients, httpclients_2, rails, rest]
-        ruby-version: [2.4.10, 2.5.9, 2.6.10, 2.7.8, 3.0.7, 3.1.5, 3.2.4, 3.3.1]
+        ruby-version: [2.4.10, 2.5.9, 2.6.10, 2.7.8, 3.0.7, 3.1.5, 3.2.4, 3.3.1, 3.4.0-preview1]
     steps:
       - name: Configure git
         run: 'git config --global init.defaultBranch main'
@@ -213,7 +216,7 @@ jobs:
         run: sudo apt-get update; sudo apt-get install -y --no-install-recommends libcurl4-nss-dev libsasl2-dev libxslt1-dev
 
       - name: Install Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+        uses: ruby/setup-ruby@943103cae7d3f1bb1e4951d5fcc7928b40e4b742 # tag v1.177.1
         with:
           ruby-version: ${{ matrix.ruby-version }}
 
@@ -278,14 +281,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [2.7.8, 3.0.7, 3.1.5, 3.2.4, 3.3.1]
+        ruby-version: [2.7.8, 3.0.7, 3.1.5, 3.2.4, 3.3.1, 3.4.0-preview1]
     steps:
       - name: Configure git
         run: 'git config --global init.defaultBranch main'
       - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # tag v4.1.2
 
       - name: Install Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+        uses: ruby/setup-ruby@943103cae7d3f1bb1e4951d5fcc7928b40e4b742 # tag v1.177.1
         with:
           ruby-version: ${{ matrix.ruby-version }}
 

CHANGELOG.md

@@ -1,5 +1,11 @@
 # New Relic Ruby Agent Release Notes
 
+## v9.10.1
+
+- **Bugfix: Incompatibility with Bootstrap**
+
+Version 9.10.1 fixes an incompatibility between the agent and the [Bootstrap](https://github.com/twbs/bootstrap-rubygem) gem caused by agent v9.10.0's introduction of a `lib/bootstrap.rb` file. Thank you to [@dorner](https://github.com/dorner) for reporting the bug and identifying the 'bootstrap' name collision as the root cause. [BUG#2675](https://github.com/newrelic/newrelic-ruby-agent/issues/2675) [PR#2676](https://github.com/newrelic/newrelic-ruby-agent/pull/2676)
+
 ## v9.10.0
 
 Version 9.10.0 introduces instrumentation for DynamoDB, adds a new feature to automatically apply nonces from the Rails content security policy, fixes a bug that would cause an expected error to negatively impact a transaction's Apdex, and fixes the agent's autostart logic so that by default `rails runner` and `rails db` commands will not cause the agent to start.

lib/bootstrap.rb renamed to lib/boot/strap.rb

@@ -27,7 +27,7 @@
 #   - Next, use the "RUBYOPT" environment variable to require ("-r") this
 #     file (note that the ".rb" extension is dropped):
 #       ```
-#       export RUBYOPT="-r /newrelic/lib/bootstrap"
+#       export RUBYOPT="-r /newrelic/lib/boot/strap"
 #       ```
 #    - Add your New Relic license key as an environment variable.
 #       ```
@@ -50,7 +50,7 @@ def require(*_groups)
   end
 
   def require_newrelic
-    lib = File.dirname(__FILE__)
+    lib = File.expand_path('../..', __FILE__)
     $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
     Kernel.require NR_AGENT_GEM
   end
@@ -65,40 +65,36 @@ def self.patch
     check_for_rubyopt
     check_for_bundler
     Bundler::Runtime.prepend(NRBundlerPatch)
+  rescue StandardError => e
+    Kernel.warn "New Relic entrypoint at #{__FILE__} encountered an issue:\n  #{e.message}"
   end
 
   private
 
   def self.check_for_require
-    warn_and_exit "#{__FILE__} is meant to be required, not invoked directly" if $PROGRAM_NAME == __FILE__
+    raise "#{__FILE__} is meant to be required, not invoked directly" if $PROGRAM_NAME == __FILE__
   end
 
   def self.check_for_rubyopt
     unless ENV[RUBYOPT].to_s.match?("-r #{__FILE__.rpartition('.').first}")
-      warn_and_exit "#{__FILE__} is meant to be required via the RUBYOPT env var"
+      raise "#{__FILE__} is meant to be required via the RUBYOPT env var"
     end
   end
 
   def self.check_for_bundler
     require_bundler
 
-    warn_and_exit 'Required Ruby Bundler class Bundler::Runtime not defined!' unless defined?(Bundler::Runtime)
+    raise 'Required Ruby Bundler class Bundler::Runtime not defined!' unless defined?(Bundler::Runtime)
 
     unless Bundler::Runtime.method_defined?(:require)
-      warn_and_exit "The active Ruby Bundler instance doesn't offer Bundler::Runtime#require"
+      raise "The active Ruby Bundler instance doesn't offer Bundler::Runtime#require"
     end
   end
 
   def self.require_bundler
     require BUNDLER
   rescue LoadError => e
-    warn_and_exit "Required Ruby library '#{BUNDLER}' could not be required - #{e}"
-  end
-
-  def self.warn_and_exit(msg)
-    warn "New Relic entrypoint at #{__FILE__} encountered an issue:\n\t#{msg}"
-
-    exit 1
+    raise "Required Ruby library '#{BUNDLER}' could not be required - #{e}"
   end
 end
 

lib/new_relic/agent/configuration/default_source.rb

@@ -782,7 +782,7 @@ def self.enforce_fallback(allowed_values: nil, fallback: nil)
         # CSP nonce
         :'browser_monitoring.content_security_policy_nonce' => {
           :default => value_of(:'rum.enabled'),
-          :documentation_default => false,
+          :documentation_default => true,
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,

lib/new_relic/agent/instrumentation/elasticsearch/instrumentation.rb

@@ -8,6 +8,54 @@ module NewRelic::Agent::Instrumentation
   module Elasticsearch
     PRODUCT_NAME = 'Elasticsearch'
     OPERATION = 'perform_request'
+
+    # Pattern to use with client caller location strings. Look for a location
+    # that contains '/lib/elasticsearch/api/' and is NOT followed by the
+    # string held in the OPERATION constant
+    OPERATION_PATTERN = %r{/lib/elasticsearch/api/(?!.+#{OPERATION})}.freeze
+
+    # Use the OPERATION_PATTERN pattern to find the appropriate caller location
+    # that will contain the client instance method (example: 'search') and
+    # return that method name.
+    #
+    # A Ruby caller location matching the OPERATION_PATTERN will contain an
+    # elasticsearch client instance method name (such as "search"), and that
+    # method name will be used as the operation name.
+    #
+    # With Ruby < 3.4 the method name is listed as:
+    #
+    #   `search'
+    #
+    # with an opening backtick and a closing single tick. And only the
+    # method name itself is listed.
+    #
+    # With Ruby 3.4+ the method name is listed as:
+    #
+    #   'Elasticsearch::API::Actions#search'
+    #
+    # with opening and closing single ticks and the class defining the
+    # instance method listed.
+    #
+    # (?:) = ?: prevents capturing
+    # (?:`|') = allow ` or '
+    # (?:.+#) = allow the class name and '#' prefix to exist but ignore it
+    # ([^']+)' = after the opening ` or ', capturing everything up to the
+    #            closing '.  [^']+ = one or more characters that are not '
+    #
+    # Example Ruby 3.3.1 input:
+    #
+    #   /Users/fallwith/.rubies/ruby-3.3.1/lib/ruby/gems/3.3.0/gems/elasticsearch-api-7.17.10/lib/elasticsearch/api/actions/index.rb:74:in `index'
+    #
+    # Example Ruby 3.4.0-preview1 input:
+    #
+    #   /Users/fallwith/.rubies/ruby-3.4.0-preview1/lib/ruby/gems/3.4.0+0/gems/elasticsearch-api-7.17.10/lib/elasticsearch/api/actions/index.rb:74:in 'Elasticsearch::API::Actions#index'
+    #
+    # Example output for both Rubies:
+    #
+    #   index
+
+    INSTANCE_METHOD_PATTERN = /:in (?:`|')(?:.+#)?([^']+)'\z/.freeze
+
     INSTRUMENTATION_NAME = NewRelic::Agent.base_name(name)
 
     # We need the positional arguments `params` and `body`
@@ -40,13 +88,10 @@ def perform_request_with_tracing(_method, _path, params = {}, body = nil, _heade
     private
 
     def nr_operation
-      operation_index = caller_locations.index do |line|
-        string = line.to_s
-        string.include?('lib/elasticsearch/api') && !string.include?(OPERATION)
-      end
-      return nil unless operation_index
+      location = caller_locations.detect { |loc| loc.to_s.match?(OPERATION_PATTERN) }
+      return unless location && location.to_s =~ INSTANCE_METHOD_PATTERN
 
-      caller_locations[operation_index].to_s.split('`')[-1].gsub(/\W/, '')
+      Regexp.last_match(1)
     end
 
     def nr_reported_query(query)

lib/new_relic/version.rb

@@ -7,7 +7,7 @@ module NewRelic
   module VERSION # :nodoc:
     MAJOR = 9
     MINOR = 10
-    TINY = 0
+    TINY = 1
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
   end

lib/sequel/extensions/new_relic_instrumentation.rb

@@ -78,8 +78,9 @@ def notice_sql(sql)
     end
 
     THREAD_SAFE_CONNECTION_POOL_CLASSES = [
-      (defined?(::Sequel::ThreadedConnectionPool) && ::Sequel::ThreadedConnectionPool)
-    ].freeze
+      (defined?(::Sequel::ThreadedConnectionPool) && ::Sequel::ThreadedConnectionPool),
+      (defined?(::Sequel::TimedQueueConnectionPool) && RUBY_VERSION >= '3.4' && ::Sequel::TimedQueueConnectionPool)
+    ].compact.freeze
 
     def explainer_for(sql)
       proc do |*|

newrelic.yml

@@ -43,6 +43,8 @@ common: &default_settings
   # The excluded attributes include:
   # * content from LlmChatCompletionMessage events
   # * input from LlmEmbedding events
+  # This is an optional security setting to prevent recording sensitive data sent to
+  # and received from your LLMs.
   # ai_monitoring.record_content.enabled: true
 
   # If true, enables capture of all HTTP request headers for all destinations.
@@ -146,7 +148,7 @@ common: &default_settings
 
   # If true, enables auto-injection of Content Security Policy Nonce in browser
   # monitoring scripts. For now, auto-injection only works with Rails 5.2+.
-  # browser_monitoring.content_security_policy_nonce: false
+  # 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
@@ -358,8 +360,8 @@ common: &default_settings
   # embedded service within another framework and the agent is detecting the Sinatra
   # app and skipping the at_exit handler as a result. Sinatra classically runs the
   # entire application in an at_exit block and would otherwise misbehave if the
-  # agent's at_exit handler was also installed in those circumstances. Note:
-  # send_data_on_exit should also be set to true in  tandem with this setting.
+  # Agent's at_exit handler was also installed in those circumstances. Note:
+  # send_data_on_exit should also be set to true in  tandem with this setting."
   # force_install_exit_handler: false
 
   # Ordinarily the agent reports dyno names with a trailing dot and process ID (for
@@ -420,15 +422,15 @@ common: &default_settings
   # instrumentation.delayed_job: auto
 
   # Controls auto-instrumentation of the aws-sdk-dynamodb library at start-up. May
-  # be one of [auto|prepend|chain|disabled].
+  # be one of auto, prepend, chain, disabled.
   # instrumentation.dynamodb: 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 ethon at start up. May be one of
-  # [auto|prepend|chain|disabled]
+  # Controls auto-instrumentation of ethon at start up. May be one of auto, prepend,
+  # chain, disabled
   # instrumentation.ethon: auto
 
   # Controls auto-instrumentation of Excon at start-up. May be one of: enabled,
@@ -468,8 +470,8 @@ common: &default_settings
   # prepend, chain, disabled.
   # instrumentation.httprb: auto
 
-  # Controls auto-instrumentation of httpx at start up. May be one of
-  # [auto|prepend|chain|disabled]
+  # Controls auto-instrumentation of httpx at start up. May be one of auto, prepend,
+  # chain, disabled
   # instrumentation.httpx: auto
 
   # Controls auto-instrumentation of Ruby standard library Logger at start-up. May
@@ -531,7 +533,7 @@ common: &default_settings
   # instrumentation.roda: auto
 
   # Controls auto-instrumentation of the ruby-openai gem at start-up. May be one of:
-  # auto, prepend, chain, disabled.
+  # auto, prepend, chain, disabled. Defaults to disabled in high security mode.
   # instrumentation.ruby_openai: auto
 
   # Controls auto-instrumentation of Sinatra at start-up. May be one of: auto,
@@ -695,8 +697,10 @@ common: &default_settings
   # If true, enables span event sampling.
   # span_events.enabled: true
 
-  # Defines the maximum number of span events reported from a single harvest. Any
-  # Integer between 1 and 10000 is valid.
+  # * Defines the maximum number of span events reported from a single harvest. Any
+  # Integer between 1 and 10000 is valid.'
+  # * When configuring the agent for AI monitoring, set to max value 10000.  This
+  # ensures that the agent captures the maximum amount of distributed traces.
   # span_events.max_samples_stored: 2000
 
   # Sets the maximum number of span events to buffer when streaming to the trace

test/agent_helper.rb

@@ -1039,3 +1039,7 @@ def first_call_for(subject)
 
   items.first
 end
+
+def ruby_version_float
+  RUBY_VERSION.split('.')[0..1].join('.').to_f
+end

test/environments/norails/Gemfile

@@ -22,3 +22,8 @@ gem 'simplecov' if ENV['VERBOSE_TEST_OUTPUT']
 
 gem 'warning'
 gem 'loofah', '~> 2.20.0' if RUBY_VERSION >= '2.4.0' && RUBY_VERSION < '2.5.0'
+
+if RUBY_VERSION.split('.')[0..1].join('.').to_f >= 3.4
+  gem 'mutex_m'
+  gem 'ostruct'
+end

test/environments/rails61/Gemfile

@@ -39,3 +39,10 @@ end
 
 gem 'simplecov' if ENV['VERBOSE_TEST_OUTPUT']
 gem 'warning'
+
+if RUBY_VERSION.split('.')[0..1].join('.').to_f >= 3.4
+  gem 'base64'
+  gem 'bigdecimal'
+  gem 'mutex_m'
+  gem 'ostruct'
+end

test/environments/rails70/Gemfile

@@ -25,3 +25,10 @@ end
 
 gem 'simplecov' if ENV['VERBOSE_TEST_OUTPUT']
 gem 'warning'
+
+if RUBY_VERSION.split('.')[0..1].join('.').to_f >= 3.4
+  gem 'base64'
+  gem 'bigdecimal'
+  gem 'mutex_m'
+  gem 'ostruct'
+end