newrelic_rpm 8.10.1 → 8.12.0

data/lib/tasks/instrumentation_generator/templates/chain.tt

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -10,9 +9,10 @@ module NewRelic::Agent::Instrumentation
         include NewRelic::Agent::Instrumentation::<%= @class_name %>
 
         alias_method(:<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>)
+        alias_method(:<%= @method.downcase %>, :<%= @method.downcase %>_with_new_relic)
 
         def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-          <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> do
+          <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> do
             <%= @method.downcase %>_without_new_relic<%= "(#{@args})" unless @args.empty? %>
           end
         end

data/lib/tasks/instrumentation_generator/templates/chain_method.tt

@@ -1,7 +1,8 @@
-alias_method :<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>
+alias_method(:<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>)
+alias_method(:<%= @method.downcase %>, :<%= @method.downcase %>_with_new_relic)
 
 def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-  <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> do
+  <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> do
     <%= @method.downcase %>_without_new_relic<%= "(#{@args})" unless @args.empty? %>
   end
 end

data/lib/tasks/instrumentation_generator/templates/dependency_detection.tt

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true

data/lib/tasks/instrumentation_generator/templates/instrumentation.tt

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -6,8 +5,9 @@
 module NewRelic::Agent::Instrumentation
   module <%= @class_name %>
 
-    def <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %>
+    def <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %>
       # add instrumentation content here
+      yield
     end
   end
 end

data/lib/tasks/instrumentation_generator/templates/instrumentation_method.tt

@@ -1,3 +1,3 @@
-def <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %>
+def <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %>
   # add instrumentation content here
 end

data/lib/tasks/instrumentation_generator/templates/prepend.tt

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -8,7 +7,7 @@ module NewRelic::Agent::Instrumentation
     include NewRelic::Agent::Instrumentation::<%= @class_name %>
 
     def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-      <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> { super }
+      <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> { super }
     end
   end
 end

data/lib/tasks/instrumentation_generator/templates/prepend_method.tt

@@ -1,3 +1,3 @@
 def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-  <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> { super }
+  <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> { super }
 end

data/lib/tasks/instrumentation_generator/templates/test.tt

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -12,5 +11,5 @@ class <%= @class_name %>InstrumentationTest < Minitest::Test
     NewRelic::Agent.instance.stats_engine.clear_stats
   end
 
-  # Add tests Here
+  # Add tests here
 end

data/lib/tasks/multiverse.rake

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true

data/lib/tasks/multiverse.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -36,6 +35,9 @@
 #   # Runs with a specific test seed
 #   bundle exec rake test:multiverse[my_gem,seed=1337]
 
+require_relative 'helpers/removers'
+include Removers
+
 namespace :test do
   desc "Run functional test suite for New Relic"
   task :multiverse, [:suite, :param1, :param2, :param3, :param4] => ['multiverse:env'] do |_, args|
@@ -43,34 +45,6 @@ namespace :test do
   end
 
   namespace :multiverse do
-    def remove_local_multiverse_databases
-      list_databases_command = %(echo "show databases" | mysql -u root)
-      databases = `#{list_databases_command}`.chomp!.split("\n").select { |s| s =~ /multiverse/ }
-      databases.each do |database|
-        puts "Dropping #{database}"
-        `echo "drop database #{database}" | mysql -u root`
-      end
-    rescue => error
-      puts "ERROR: Cannot get MySQL databases..."
-      puts error.message
-    end
-
-    def remove_generated_gemfiles
-      file_path = File.expand_path("test/multiverse/suites")
-      Dir.glob(File.join(file_path, "**", "Gemfile*")).each do |fn|
-        puts "Removing #{fn.gsub(file_path, '.../suites')}"
-        FileUtils.rm(fn)
-      end
-    end
-
-    def remove_generated_gemfile_lockfiles
-      file_path = File.expand_path("test/environments")
-      Dir.glob(File.join(file_path, "**", "Gemfile.lock")).each do |fn|
-        puts "Removing #{fn.gsub(file_path, '.../environments')}"
-        FileUtils.rm(fn)
-      end
-    end
-
     task :env do
       # ENV['SUITES_DIRECTORY'] = File.expand_path('../../test/multiverse/suites', __FILE__)
       require File.expand_path('../../../test/multiverse/lib/multiverse', __FILE__)

data/lib/tasks/newrelic.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true

data/lib/tasks/tests.rake

@@ -1,8 +1,10 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
+require_relative 'helpers/matches'
+include Matches
+
 begin
   require 'rake/testtask'
 rescue LoadError
@@ -10,13 +12,6 @@ end
 
 if defined? Rake::TestTask
   namespace :test do
-    def look_for_seed(tasks)
-      matches = tasks.map { |t| /(seed=.*?)[,\]]/.match(t) }.compact
-      if matches.any?
-        matches.first[1]
-      end
-    end
-
     tasks = Rake.application.top_level_tasks
     ENV["TESTOPTS"] ||= ""
     if tasks.any? { |t| t.include?("verbose") }

data/newrelic.yml

@@ -145,7 +145,7 @@ common: &default_settings
 
   # Specify a maximum number of custom Insights events to buffer in memory at a
   # time.
-  # custom_insights_events.max_samples_stored: 1000
+  # custom_insights_events.max_samples_stored: 3000
 
   # If false, the agent will not add database_name parameter to transaction or #
   # slow sql traces.
@@ -271,7 +271,7 @@ common: &default_settings
 
   # Forces the exit handler that sends all cached data to collector before
   # shutting down to be installed regardless of detecting scenarios where it
-  # generally should bot be. Known use-case for this option is where Sinatra is
+  # generally should not be. Known use-case for this option is where Sinatra is
   # running as an 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
@@ -301,6 +301,15 @@ common: &default_settings
   # Configures the TCP/IP port for the Trace Observer Host
   # infinite_tracing.trace_observer.port: 443
 
+  # Configure the compression level for data sent to the Trace Observer
+  # May be one of [none|low|medium|high]
+  # By default, compression is not used (level = none)
+  # infinite_tracing.compression_level: none
+
+  # If true, data sent to the Trace Observer will be batched instead of
+  # the default of each span being sent individually
+  # infinite_tracing.batching: false
+
   # Controls auto-instrumentation of bunny at start up.
   # May be one of [auto|prepend|chain|disabled].
   # instrumentation.bunny: auto
@@ -313,6 +322,10 @@ common: &default_settings
   # May be one of [auto|prepend|chain|disabled].
   # instrumentation.delayed_job: 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 Excon at start up.
   # May be one of [enabled|disabled].
   # instrumentation.excon: auto
@@ -399,7 +412,7 @@ common: &default_settings
   # May be one of [auto|prepend|chain|disabled].
   # instrumentation.typhoeus: auto
 
-  # Controls auto-instrumentation of the Thread class at start up to allow the agent to correctly nest spans inside of an asyncronous transaction.
+  # Controls auto-instrumentation of the Thread class at start up to allow the agent to correctly nest spans inside of an asynchronous transaction.
   # May be one of [auto|prepend|chain|disabled].
   # instrumentation.thread: auto
 
@@ -425,7 +438,7 @@ common: &default_settings
   # instrumentation.grpc.host_denylist: ""
 
   # A dictionary of label names and values that will be applied to the data sent
-  # from this agent. May also be expressed asa semicolon-delimited ; string of
+  # from this agent. May also be expressed as a semicolon-delimited ; string of
   # colon-separated : pairs.
   # For example,<var>Server</var>:<var>One</var>;<var>Data Center</var>:<var>Primary</var>.
   # labels: ""
@@ -450,6 +463,12 @@ common: &default_settings
   # If true, the agent obfuscates Mongo queries in transaction traces.
   # mongo.obfuscate_queries: true
 
+  # If true, the agent captures Elasticsearch queries in transaction traces.
+  # elasticsearch.capture_queries: true
+
+  # If true, the agent obfuscates Elasticsearch queries in transaction traces.
+  # elasticsearch.obfuscate_queries: true
+
   # When true, the agent transmits data about your app to the New Relic collector.
   # monitor_mode: true
 

data/newrelic_rpm.gemspec

@@ -1,4 +1,3 @@
-#-*- coding: utf-8 -*-
 # frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
@@ -22,7 +21,7 @@ Gem or plugin, hosted on
 https://github.com/newrelic/newrelic-ruby-agent/
   EOS
   s.email = "support@newrelic.com"
-  s.executables = ["newrelic_cmd", "newrelic", "nrdebug"]
+  s.executables = %w[newrelic_cmd newrelic nrdebug]
   s.extra_rdoc_files = [
     "CHANGELOG.md",
     "LICENSE",
@@ -50,16 +49,16 @@ https://github.com/newrelic/newrelic-ruby-agent/
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'feedjira', '3.2.1' unless ENV['CI'] || RUBY_VERSION < '2.5' # for Gabby
   s.add_development_dependency 'httparty' unless ENV['CI'] # for perf tests and Gabby
-  s.add_development_dependency 'minitest', '5.3.3'
+  s.add_development_dependency 'minitest', "#{RUBY_VERSION >= '2.7.0' ? '5.3.3' : '4.7.5'}"
   s.add_development_dependency 'minitest-stub-const', '0.6'
   s.add_development_dependency 'mocha', '~> 1.14.0'
   s.add_development_dependency 'pry' unless ENV['CI']
   s.add_development_dependency 'rake', '12.3.3'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-minitest'
-  s.add_development_dependency 'rubocop-performance'
-  s.add_development_dependency 'rubocop-rake' if RUBY_VERSION >= '2.4.0'
+  s.add_development_dependency 'rubocop' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop-minitest' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop-performance' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop-rake' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
   s.add_development_dependency 'simplecov' if RUBY_VERSION >= '2.7.0'
-  s.add_development_dependency 'thor'
-  s.add_development_dependency 'yard'
+  s.add_development_dependency 'thor' unless ENV['CI']
+  s.add_development_dependency 'yard', "#{RUBY_VERSION < '2.3.0' ? '0.9.26' : '> 0.9.26'}"
 end

data/recipes/newrelic.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true

data/test/agent_helper.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
@@ -31,15 +30,8 @@ def fake_guid(length = 16)
   NewRelic::Agent::GuidGenerator.generate_guid(length)
 end
 
-def assert_match(matcher, obj, msg = nil)
-  msg = message(msg) { "Expected #{mu_pp(matcher)} to match #{mu_pp(obj)}" }
-  assert_respond_to matcher, :"=~"
-  matcher = Regexp.new(Regexp.escape(matcher)) if String === matcher
-  assert matcher =~ obj, msg
-end
-
 def assert_between(floor, ceiling, value, message = "expected #{floor} <= #{value} <= #{ceiling}")
-  assert((floor <= value && value <= ceiling), message)
+  assert((floor <= value && value <= ceiling), message) # rubocop:disable Minitest/AssertWithExpectedArgument
 end
 
 def assert_in_delta(expected, actual, delta)
@@ -56,8 +48,7 @@ end
 
 def assert_has_traced_error(error_class)
   errors = harvest_error_traces!
-  assert \
-    errors.find { |e| e.exception_class_name == error_class.name } != nil, \
+  refute_nil errors.find { |e| e.exception_class_name == error_class.name }, \
     "Didn't find error of class #{error_class}"
 end
 
@@ -89,23 +80,17 @@ def last_error_event
   harvest_error_events!.last.last
 end
 
-unless defined? assert_block
-  def assert_block(*msgs)
-    assert yield, *msgs
-  end
-end
-
 unless defined? assert_includes
   def assert_includes(collection, member, msg = nil)
     msg = "Expected #{collection.inspect} to include #{member.inspect}"
-    assert_block(msg) { collection.include?(member) }
+    assert_includes collection, member, msg
   end
 end
 
 unless defined? assert_not_includes
   def assert_not_includes(collection, member, msg = nil)
     msg = "Expected #{collection.inspect} not to include #{member.inspect}"
-    assert !collection.include?(member), msg
+    refute_includes collection, member, msg
   end
 end
 
@@ -122,8 +107,7 @@ end
 
 def assert_log_contains(log, message)
   lines = log.array
-  failure_message = "Did not find '#{message}' in log. Log contained:\n#{lines.join('')}"
-  assert (lines.any? { |line| line.match(message) }), failure_message
+  assert (lines.any? { |line| line.match(message) })
 end
 
 def assert_audit_log_contains(audit_log_contents, needle)
@@ -133,7 +117,7 @@ def assert_audit_log_contains(audit_log_contents, needle)
   regex = /[:"]/
   needle = needle.gsub(regex, '')
   haystack = audit_log_contents.gsub(regex, '')
-  assert(haystack.include?(needle), "Expected log to contain '#{needle}'")
+  assert_includes(haystack, needle, "Expected log to contain '#{needle}'")
 end
 
 # Because we don't generate a strictly machine-readable representation of
@@ -243,7 +227,7 @@ def assert_metrics_recorded(expected)
       msg += "\nDid find specs: [\n#{matches.join(",\n")}\n]" unless matches.empty?
       msg += "\nAll specs in there were: #{format_metric_spec_list(all_specs)}"
 
-      assert(actual_stats, msg)
+      assert(actual_stats, msg) # rubocop:disable Minitest/AssertWithExpectedArgument
     end
     assert_stats_has_values(actual_stats, expected_spec, expected_attrs)
   end
@@ -276,12 +260,12 @@ def assert_metrics_recorded_exclusive(expected, options = {})
   expected_metrics = expected.keys.map { |s| metric_spec_from_specish(s) }
 
   unexpected_metrics = recorded_metrics - expected_metrics
-  unexpected_metrics.reject! { |m| m.name =~ /GC\/Transaction/ }
+  unexpected_metrics.reject! { |m| m.name.include?('GC/Transaction') }
 
   assert_equal(0, unexpected_metrics.size, "Found unexpected metrics: #{format_metric_spec_list(unexpected_metrics)}")
 end
 
-def assert_newrelic_metdata_present(metadata)
+def assert_newrelic_metadata_present(metadata)
   assert metadata.key?('newrelic')
   refute_nil metadata['newrelic']
 end
@@ -316,7 +300,7 @@ def assert_metrics_not_recorded(not_expected)
       found_but_not_expected << spec
     end
   end
-  assert_equal([], found_but_not_expected, "Found unexpected metrics: #{format_metric_spec_list(found_but_not_expected)}")
+  assert_empty(found_but_not_expected, "Found unexpected metrics: #{format_metric_spec_list(found_but_not_expected)}")
 end
 
 alias :refute_metrics_recorded :assert_metrics_not_recorded
@@ -327,8 +311,7 @@ def assert_no_metrics_match(regex)
     matching_metrics << metric if metric.match(regex)
   end
 
-  assert_equal(
-    [],
+  assert_empty(
     matching_metrics,
     "Found unexpected metrics:\n" + matching_metrics.map { |m| "  '#{m}'" }.join("\n") + "\n\n"
   )
@@ -345,17 +328,17 @@ end
 
 def assert_truthy(expected, msg = nil)
   msg ||= "Expected #{expected.inspect} to be truthy"
-  assert !!expected, msg
+  refute !expected, msg
 end
 
 def assert_falsy(expected, msg = nil)
   msg ||= "Expected #{expected.inspect} to be falsy"
-  assert !expected, msg
+  refute expected, msg
 end
 
 unless defined? assert_false
   def assert_false(expected)
-    assert_equal false, expected
+    refute expected
   end
 end
 
@@ -386,8 +369,7 @@ def in_transaction(*args, &blk)
   category = (opts && opts.delete(:category)) || :other
 
   # At least one test passes `:transaction_name => nil`, so handle it gently
-  name = opts.key?(:transaction_name) ? opts.delete(:transaction_name) :
-                                        args.first || 'dummy'
+  name = opts.key?(:transaction_name) ? opts.delete(:transaction_name) : args.first || 'dummy'
 
   state = NewRelic::Agent::Tracer.state
   txn = nil
@@ -412,7 +394,7 @@ def with_disabled_defaults_transformer(key)
 end
 
 # Convenience wrapper to stand up a transaction and provide a segment within
-# that transaction to work with.  The same arguements as provided to in_transaction
+# that transaction to work with.  The same arguments as provided to in_transaction
 # may be supplied.
 def with_segment(*args, &blk)
   segment = nil
@@ -429,6 +411,7 @@ end
 def build_deferred_error_attributes(segment)
   return unless segment.noticed_error
   return if segment.noticed_error_attributes.frozen?
+
   segment.noticed_error.build_error_attributes
 end
 
@@ -472,6 +455,7 @@ end
 
 def last_transaction_trace
   return unless last_sample = NewRelic::Agent.agent.transaction_sampler.last_sample
+
   NewRelic::Agent::Transaction::TraceBuilder.build_trace(last_sample)
 end
 
@@ -657,6 +641,7 @@ def constant_path(name, opts = {})
     if !path.last.constants.include?(part.to_sym)
       return allow_partial ? path : nil
     end
+
     path << path.last.const_get(part)
   end
   path
@@ -673,6 +658,7 @@ def undefine_constant(constant_symbol)
   parent = get_parent(const_str)
   const_name = const_str.gsub(/.*::/, '')
   return yield unless parent && parent.constants.include?(const_name.to_sym)
+
   removed_constant = parent.send(:remove_const, const_name)
   yield
 ensure
@@ -871,7 +857,7 @@ def load_cross_agent_test(name)
   data = File.read(test_file_path)
   data.gsub!('callCount', 'call_count')
   data = ::JSON.load(data)
-  data.each { |testcase| testcase['testname'].gsub!(' ', '_') if String === testcase['testname'] }
+  data.each { |testcase| testcase['testname'].tr!(' ', '_') if String === testcase['testname'] }
   data
 end
 
@@ -947,6 +933,7 @@ def mock_http_response(headers, wrap_it = true)
     net_http_resp.add_field(key.to_s, value)
   end
   return net_http_resp unless wrap_it
+
   NewRelic::Agent::HTTPClients::NetHTTPResponse.new(net_http_resp)
 end
 
@@ -992,6 +979,7 @@ def refute_raises(*exp)
   rescue MiniTest::Skip => e
     puts "SKIP REPORTS: #{e.inspect}"
     return e if exp.include?(MiniTest::Skip)
+
     raise e
   rescue Exception => e
     puts "EXCEPTION RAISED: #{e.inspect}\n#{e.backtrace}"