newrelic_rpm 8.10.1 → 8.12.0

data/lib/new_relic/recipes/helpers/send_deployment.rb

@@ -0,0 +1,69 @@
+# 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 SendDeployment
+  def send_deployment_notification_to_newrelic
+    require 'new_relic/cli/command'
+    debug("Uploading deployment to New Relic")
+    NewRelic::Cli::Deployments.new(deploy_options).run
+    info("Uploaded deployment information to New Relic")
+  rescue NewRelic::Cli::Command::CommandFailure => e
+    info(e.message)
+  rescue => e
+    info("Error creating New Relic deployment (#{e})\n#{e.backtrace.join("\n")}")
+  end
+
+  private
+
+  def deploy_options
+    {
+      :environment => fetch_environment,
+      :revision => fetch_rev,
+      :changelog => fetch_changelog,
+      :description => fetch(:newrelic_desc),
+      :appname => fetch(:newrelic_appname),
+      :user => fetch(:newrelic_user),
+      :license_key => fetch(:newrelic_license_key)
+    }
+  end
+
+  def fetch_changelog
+    has_scm? ? fetch(:newrelic_changelog) : lookup_changelog
+  end
+
+  def fetch_environment
+    fetch(:newrelic_rails_env, fetch(:rack_env, fetch(:rails_env, fetch(:stage, "production"))))
+  end
+
+  def fetch_rev
+    newrelic_rev = fetch(:newrelic_revision)
+    has_scm? && !newrelic_rev ? fetch(:current_revision) : newrelic_rev
+  end
+
+  def has_scm?
+    has_scm_from_plugin? || has_scm_from_config?
+  end
+
+  def has_scm_from_config?
+    defined?(scm) && !scm.nil? && scm != :none
+  end
+
+  def has_scm_from_plugin?
+    respond_to?(:scm_plugin_installed?) && scm_plugin_installed?
+  end
+
+  def lookup_changelog
+    previous_revision = fetch(:previous_revision)
+    current_revision = fetch(:current_revision)
+    return unless current_revision && previous_revision
+
+    debug("Retrieving changelog for New Relic Deployment details")
+
+    if Rake::Task.task_defined?("git:check")
+      log_command = "git --no-pager log --no-color --pretty=format:'  * %an: %s' " +
+        "--abbrev-commit --no-merges #{previous_revision}..#{current_revision}"
+      `#{log_command}`
+    end
+  end
+end

data/lib/new_relic/recipes.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/new_relic/supportability_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
@@ -72,7 +71,7 @@ module NewRelic
     def valid_api_argument_class?(arg, name, klass)
       return true if arg.is_a?(klass)
 
-      caller_location = caller_locations.first.label
+      caller_location = caller_locations(1..1).first.label
 
       message = "Bad argument passed to ##{caller_location}. " \
         "Expected #{klass} for `#{name}` but got #{arg.class}"

data/lib/new_relic/traced_thread.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
@@ -29,6 +28,7 @@ module NewRelic
 
     def create_traced_block(*args, &block)
       return block if NewRelic::Agent.config[:'instrumentation.thread.tracing'] # if this is on, don't double trace
+
       NewRelic::Agent::Tracer.thread_block_with_current_transaction(*args, &block)
     end
   end

data/lib/new_relic/version.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/ruby
-# 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
@@ -7,8 +6,8 @@
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 8
-    MINOR = 10
-    TINY = 1
+    MINOR = 12
+    TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
   end

data/lib/newrelic_rpm.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/sequel/extensions/newrelic_instrumentation.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-# 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
@@ -63,7 +62,7 @@ module Sequel
     # block in the sequel Plugin instrumentation. A simple ORM operation from the Plugin
     # instrumentation may trigger a number of calls to this method. We want to append
     # the statements that come from the disable_all_tracing block into this node's
-    # statement, otherwise we would end up ovewriting the sql statement with the
+    # statement, otherwise we would end up overwriting the sql statement with the
     # last one executed.
     def notice_sql(sql)
       return unless txn = NewRelic::Agent::Tracer.current_transaction
@@ -83,7 +82,7 @@ module Sequel
     ].freeze
 
     def explainer_for(sql)
-      Proc.new do |*|
+      proc do |*|
         if THREAD_SAFE_CONNECTION_POOL_CLASSES.include?(self.pool.class)
           self[sql].explain
         else

data/lib/sequel/plugins/newrelic_instrumentation.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-# 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/all.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/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,123 @@
+# 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
@@ -12,6 +11,7 @@ class Instrumentation < Thor
   INSTRUMENTATION_ROOT = 'lib/new_relic/agent/instrumentation/'
   MULTIVERSE_SUITE_ROOT = 'test/multiverse/suites/'
   DEFAULT_SOURCE_LOCATION = 'lib/new_relic/agent/configuration/default_source.rb'
+  NEWRELIC_YML_LOCATION = 'newrelic.yml'
 
   desc('scaffold NAME', 'Scaffold the required files for adding new instrumentation')
   long_desc <<-LONGDESC
@@ -35,14 +35,11 @@ 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")
-    create_configuration(name)
+    empty_directory(base_path)
+    create_instrumentation_files(base_path)
+    append_to_default_source(name)
+    append_to_newrelic_yml(name)
     create_tests(name)
   end
 
@@ -61,6 +58,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 %>'
@@ -73,23 +78,46 @@ class Instrumentation < Thor
     template('templates/newrelic.yml.tt', "#{base_path}/config/newrelic.yml")
   end
 
-  def create_configuration(name)
-    config = <<-CONFIG
+  def append_to_default_source(name)
+    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 append_to_newrelic_yml(name)
+    insert_into_file(
+      NEWRELIC_YML_LOCATION,
+      yaml_block(name),
+      after: "# instrumentation.bunny: auto\n"
+    )
+  end
+
+  def config_block(name)
+    <<-CONFIG
         :'instrumentation.#{name.downcase}' => {
           :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 #{name} 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
+
+  # TODO: OLD RUBIES - RUBY_VERSION 2.2
+  # When we only support 2.3+ this can be changed to a sqiggle heredoc (<<~)
+  # and use standard indentation
+  def yaml_block(name)
+<<HEREDOC # rubocop:disable Layout/IndentationWidth
+
+  # Controls auto-instrumentation of #{name} at start up.
+  # May be one of [auto|prepend|chain|disabled]
+  # instrumentation.#{name.downcase}: auto
+HEREDOC
   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