newrelic_rpm 8.10.1 → 8.11.0

data/lib/tasks/config.rake

@@ -1,12 +1,12 @@
-# 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/format'
+include Format
+
 namespace :newrelic do
   namespace :config do
-    desc "Describe available New Relic configuration settings."
-
     GENERAL = "general"
     DISABLING = "disabling"
     ATTRIBUTES = "attributes"
@@ -29,116 +29,7 @@ namespace :newrelic do
       "custom_insights_events" => "Custom Events"
     }
 
-    def output(format)
-      config_hash = build_config_hash
-      sections = flatten_config_hash(config_hash)
-
-      puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
-      sections # silences unused warning to return this
-    end
-
-    def build_config_hash
-      sections = Hash.new { |hash, key| hash[key] = [] }
-      NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
-        next unless value[:public]
-
-        section_key = GENERAL
-        key = key.to_s
-        components = key.split(".")
-
-        if key.match(/^disable_/) # "disable_httpclient"
-          section_key = DISABLING
-        elsif components.length >= 2 && !(components[1] == "attributes") # "analytics_events.enabled"
-          section_key = components.first
-        elsif components[1] == "attributes" # "transaction_tracer.attributes.enabled"
-          section_key = ATTRIBUTES
-        end
-
-        sections[section_key] << {
-          :key => key,
-          :type => format_type(value[:type]),
-          :description => format_description(value),
-          :default => format_default_value(value),
-          :env_var => format_env_var(key)
-        }
-      end
-      sections
-    end
-
-    def flatten_config_hash(config_hash)
-      sections = []
-      sections << pluck(GENERAL, config_hash)
-      sections << pluck("transaction_tracer", config_hash)
-      sections << pluck("error_collector", config_hash)
-      sections << pluck("browser_monitoring", config_hash)
-      sections << pluck("analytics_events", config_hash)
-      sections << pluck("transaction_events", config_hash)
-      sections << pluck("application_logging", config_hash)
-      sections.concat(config_hash.to_a.sort_by { |a| a.first })
-
-      add_data_to_sections(sections)
-
-      sections
-    end
-
-    def add_data_to_sections(sections)
-      sections.each do |section|
-        section_key = section[0]
-        section.insert(1, format_name(section_key))
-        section.insert(2, SECTION_DESCRIPTIONS[section_key])
-      end
-    end
-
-    def format_name(key)
-      name = NAME_OVERRIDES[key]
-      return name if name
-
-      key.split("_")
-        .each { |fragment| fragment[0] = fragment[0].upcase }
-        .join(" ")
-    end
-
-    def format_type(type)
-      if type == NewRelic::Agent::Configuration::Boolean
-        "Boolean"
-      else
-        type
-      end
-    end
-
-    def format_description(value)
-      description = ''
-      description += "<b>DEPRECATED</b> " if value[:deprecated]
-      description += value[:description]
-      description
-    end
-
-    def format_default_value(spec)
-      return spec[:documentation_default] if !spec[:documentation_default].nil?
-      if spec[:default].is_a?(Proc)
-        '(Dynamic)'
-      else
-        "#{spec[:default].inspect}"
-      end
-    end
-
-    def format_env_var(key)
-      return "None" if NON_ENV_CONFIGS.include?(key)
-      "NEW_RELIC_#{key.gsub(".", "_").upcase}"
-    end
-
-    def pluck(key, config_hash)
-      value = config_hash.delete(key)
-      [key, value]
-    end
-
-    def build_erb(format)
-      require 'erb'
-      path = File.join(File.dirname(__FILE__), "config.#{format}.erb")
-      template = File.read(File.expand_path(path))
-      ERB.new(template)
-    end
-
+    desc "Describe available New Relic configuration settings"
     task :docs, [:format] => [] do |t, args|
       require File.expand_path(File.join(File.dirname(__FILE__), "..", "new_relic", "agent", "configuration", "default_source.rb"))
       format = args[:format] || "text"

data/lib/tasks/coverage_report.rake

@@ -1,33 +1,28 @@
-# encoding: utf-8
 # frozen_string_literal: true
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-namespace :coverage do
-  desc "Collates all result sets generated by the different test runners"
-  task :report do
-    require 'simplecov'
-    require 'fileutils'
+if ENV['CI']
+  namespace :coverage do
+    desc "Collates all result sets generated by the different test runners"
+    task :report do
+      require 'simplecov'
+      require 'fileutils'
 
-    SimpleCov.coverage_dir('coverage_results')
+      SimpleCov.coverage_dir('coverage_results')
 
-    if ENV['CI']
       SimpleCov.collate(Dir['*/coverage_*/.resultset.json']) do
         formatter SimpleCov::Formatter::HTMLFormatter
         refuse_coverage_drop
       end
-    else
-      SimpleCov.collate(Dir['lib/coverage_*/.resultset.json']) do
-        formatter SimpleCov::Formatter::HTMLFormatter
-      end
-    end
 
-    Dir['lib/coverage_{[!r][!e][!s][!u][!l][!t][!s]}*'].each { |dir| FileUtils.rm_rf(dir) }
-  end
+      Dir['lib/coverage_{[!r][!e][!s][!u][!l][!t][!s]}*'].each { |dir| FileUtils.rm_rf(dir) }
+    end
 
-  desc "Removes all coverage_* directories"
-  task :clear do
-    require 'fileutils'
-    Dir["lib/coverage_*"].each { |dir| FileUtils.rm_rf(dir) }
+    desc "Removes all coverage_* directories"
+    task :clear do
+      require 'fileutils'
+      Dir["lib/coverage_*"].each { |dir| FileUtils.rm_rf(dir) }
+    end
   end
 end

data/lib/tasks/helpers/format.rb

@@ -0,0 +1,120 @@
+# 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
+
+module Format
+  def output(format)
+    config_hash = build_config_hash
+    sections = flatten_config_hash(config_hash)
+
+    puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
+    sections # silences unused warning to return this
+  end
+
+  private
+
+  def add_data_to_sections(sections)
+    sections.each do |section|
+      section_key = section[0]
+      section.insert(1, format_name(section_key))
+      section.insert(2, SECTION_DESCRIPTIONS[section_key])
+    end
+  end
+
+  def build_config_hash
+    sections = Hash.new { |hash, key| hash[key] = [] }
+    NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
+      next unless value[:public]
+      key = key.to_s
+      section_key = section_key(key, key.split('.'))
+      sections[section_key] << format_sections(key, value)
+    end
+    sections
+  end
+
+  def build_erb(format)
+    require 'erb'
+    path = File.join(File.dirname(__FILE__), "config.#{format}.erb")
+    template = File.read(File.expand_path(path))
+    ERB.new(template)
+  end
+
+  def flatten_config_hash(config_hash)
+    sections = []
+    config = [GENERAL, 'transaction_tracer', 'error_collector',
+      'browser_monitoring', 'analytics_events', 'transaction_events',
+      'application_logging']
+
+    config.each { |config| sections << pluck(config, config_hash) }
+
+    sections.concat(config_hash.to_a.sort_by { |a| a.first })
+    add_data_to_sections(sections)
+
+    sections
+  end
+
+  def format_default_value(spec)
+    return spec[:documentation_default] if !spec[:documentation_default].nil?
+    if spec[:default].is_a?(Proc)
+      '(Dynamic)'
+    else
+      "#{spec[:default].inspect}"
+    end
+  end
+
+  def format_description(value)
+    description = ''
+    description += "<b>DEPRECATED</b> " if value[:deprecated]
+    description += value[:description]
+    description
+  end
+
+  def format_env_var(key)
+    return "None" if NON_ENV_CONFIGS.include?(key)
+    "NEW_RELIC_#{key.tr(".", "_").upcase}"
+  end
+
+  def format_name(key)
+    name = NAME_OVERRIDES[key]
+    return name if name
+
+    key.split("_")
+      .each { |fragment| fragment[0] = fragment[0].upcase }
+      .join(" ")
+  end
+
+  def format_sections(key, value)
+    {
+      :key => key,
+      :type => format_type(value[:type]),
+      :description => format_description(value),
+      :default => format_default_value(value),
+      :env_var => format_env_var(key)
+    }
+  end
+
+  def format_type(type)
+    if type == NewRelic::Agent::Configuration::Boolean
+      "Boolean"
+    else
+      type
+    end
+  end
+
+  def pluck(key, config_hash)
+    value = config_hash.delete(key)
+    [key, value]
+  end
+
+  def section_key(key, components)
+    if key =~ /^disable_/ # "disable_httpclient"
+      DISABLING
+    elsif components.length >= 2 && !(components[1] == "attributes") # "analytics_events.enabled"
+      components.first
+    elsif components[1] == "attributes" # "transaction_tracer.attributes.enabled"
+      ATTRIBUTES
+    else
+      GENERAL
+    end
+  end
+end

data/lib/tasks/helpers/matches.rb

@@ -0,0 +1,12 @@
+# 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
+
+module Matches
+  def look_for_seed(tasks)
+    matches = tasks.map { |t| /(seed=.*?)[,\]]/.match(t) }.compact
+    if matches.any?
+      matches.first[1]
+    end
+  end
+end

data/lib/tasks/helpers/prompt.rb

@@ -0,0 +1,24 @@
+# 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
+
+module Prompt
+  def prompt_to_continue(command, destination = 'local')
+    puts "The following rsync command will be executed to update the #{destination} copy of the specs:"
+    puts
+    puts command
+    puts
+    puts "CAUTION: Any unsaved changes that exist within the #{destination} content will be OVERWRITTEN!"
+    if destination.eql?('local')
+      puts 'CAUTION 2: Before continuing, make sure your local repo is on the correct, synced branch!'
+    end
+    puts
+    print "Do you wish to continue? ('y' to continue, return to cancel) [n] "
+    continue = STDIN.gets.chomp
+    if continue.casecmp('y').zero?
+      system(command)
+    else
+      puts 'Cancelled'
+    end
+  end
+end

data/lib/tasks/helpers/removers.rb

@@ -0,0 +1,33 @@
+# 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
+
+module Removers
+  def remove_local_multiverse_databases
+    list_databases_command = %(echo "show databases" | mysql -u root)
+    databases = `#{list_databases_command}`.chomp!.split("\n").select { |s| s.include?('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
+end

data/lib/tasks/install.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/instrumentation_generator/README.md

@@ -29,7 +29,7 @@ Run it using:
 
 `thor instrumentation:scaffold gem_name`
 
-It accepts two optional paramters:
+It accepts two optional parameters:
 
 - `--method`: the name of a method to instrument. Only one method can be accepted at this time. Defaults to `method_to_instrument`
 - `--args`: the arguments for the instrumented method. A comma-separated list can be given if there are multiple arguments. Defaults to `*args`.

data/lib/tasks/instrumentation_generator/instrumentation.thor

@@ -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
@@ -35,13 +34,9 @@ class Instrumentation < Thor
     @args = options[:args] if options[:args]
     @class_name = ::NewRelic::LanguageSupport.camelize(name)
     base_path = "#{INSTRUMENTATION_ROOT}#{name.downcase}"
-    empty_directory(base_path)
-
-    ['chain', 'instrumentation', 'prepend'].each do |file|
-      template("templates/#{file}.tt", "#{base_path}/#{file}.rb")
-    end
 
-    template('templates/dependency_detection.tt', "#{base_path}.rb")
+    empty_directory(base_path)
+    create_instrumentation_files(base_path)
     create_configuration(name)
     create_tests(name)
   end
@@ -61,6 +56,14 @@ class Instrumentation < Thor
 
   private
 
+  def create_instrumentation_files(base_path)
+    %w[chain instrumentation prepend].each do |file|
+      template("templates/#{file}.tt", "#{base_path}/#{file}.rb")
+    end
+
+    template('templates/dependency_detection.tt', "#{base_path}.rb")
+  end
+
   def create_tests(name)
     @name = name
     @instrumentation_method_global_erb_snippet = '<%= $instrumentation_method %>'
@@ -74,22 +77,25 @@ class Instrumentation < Thor
   end
 
   def create_configuration(name)
-    config = <<-CONFIG
-        :'instrumentation.#{name.downcase}' => {
+    insert_into_file(
+      DEFAULT_SOURCE_LOCATION,
+      config_block(name.downcase),
+      after: ":description => 'Controls auto-instrumentation of bunny at start up.  May be one of [auto|prepend|chain|disabled].'
+        },\n"
+    )
+  end
+
+  def config_block(library)
+    <<-CONFIG
+        :'instrumentation.#{library}' => {
           :default => 'auto',
           :public => true,
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the #{name.downcase} library at start up. May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the #{library} library at start up. May be one of [auto|prepend|chain|disabled].'
         },
     CONFIG
-    insert_into_file(
-      DEFAULT_SOURCE_LOCATION,
-      config,
-      after: ":description => 'Controls auto-instrumentation of bunny at start up.  May be one of [auto|prepend|chain|disabled].'
-        },\n"
-    )
   end
 end
 

data/lib/tasks/instrumentation_generator/templates/Envfile.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/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

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

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

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

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

@@ -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
@@ -399,7 +408,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
 

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,15 +49,15 @@ 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' if RUBY_VERSION > '2.5.0'
+  s.add_development_dependency 'rubocop-minitest' if RUBY_VERSION > '2.5.0'
+  s.add_development_dependency 'rubocop-performance' if RUBY_VERSION > '2.5.0'
+  s.add_development_dependency 'rubocop-rake' if RUBY_VERSION > '2.5.0'
   s.add_development_dependency 'simplecov' if RUBY_VERSION >= '2.7.0'
   s.add_development_dependency 'thor'
   s.add_development_dependency 'yard'

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