newrelic_rpm 8.7.0 → 8.11.0

data/lib/new_relic/recipes.rb

@@ -1,6 +1,6 @@
-# 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
 
 # When installed as a plugin, this is loaded automatically.
 #

data/lib/new_relic/supportability_helper.rb

@@ -1,6 +1,6 @@
-# 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
 
 module NewRelic
   module SupportabilityHelper
@@ -62,21 +62,21 @@ module NewRelic
     def record_api_supportability_metric(method_name)
       agent = NewRelic::Agent.agent or return
       if metric = API_SUPPORTABILITY_METRICS[method_name]
-        agent.stats_engine.tl_record_unscoped_metrics metric, &:increment_count
+        agent.stats_engine.tl_record_unscoped_metrics(metric, &:increment_count)
       else
-        NewRelic::Agent.logger.debug "API supportability metric not found for :#{method_name}"
+        NewRelic::Agent.logger.debug("API supportability metric not found for :#{method_name}")
       end
     end
 
-    def valid_api_argument_class? arg, name, klass
+    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}"
 
-      NewRelic::Agent.logger.warn message
+      NewRelic::Agent.logger.warn(message)
       nil
     end
   end

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
@@ -7,19 +6,18 @@ module NewRelic
   #
   # This class allows the current transaction to be passed to a Thread so that nested segments can be created from the operations performed within the Thread's block.
   # To have the New Relic Ruby agent automatically trace all of your applications threads,
-  # enable the `instrumentation.thread.tracing` configuration option in your newrelic.yml.
+  # enable the +instrumentation.thread.tracing+ configuration option in your newrelic.yml.
   #
-  # Note: disabling the configuration option `instrumentation.thread` while using this class can cause incorrectly nested spans.
+  # Note: disabling the configuration option +instrumentation.thread+ while using this class can cause incorrectly nested spans.
   #
   # @api public
   class TracedThread < Thread
     #
     # Creates a new Thread whose work will be traced by New Relic.
     # Use this class as a replacement for the native Thread class.
-    # Example: Instead of using `Thread.new`, use:
-    # ```ruby
-    #   NewRelic::TracedThread.new { execute_some_code }
-    # ```
+    # Example: Instead of using +Thread.new+, use:
+    #
+    #     NewRelic::TracedThread.new { execute_some_code }
     #
     # @api public
     def initialize(*args, &block)

data/lib/new_relic/version.rb

@@ -1,12 +1,12 @@
 #!/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
 
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 8
-    MINOR = 7
+    MINOR = 11
     TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

data/lib/newrelic_rpm.rb

@@ -1,6 +1,6 @@
-# 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
 
 # == New Relic Initialization
 #

data/lib/sequel/extensions/newrelic_instrumentation.rb

@@ -1,7 +1,7 @@
 # -*- 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
 
 require 'sequel' unless defined?(Sequel)
 require 'newrelic_rpm' unless defined?(NewRelic)
@@ -62,18 +62,18 @@ 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
+    def notice_sql(sql)
       return unless txn = NewRelic::Agent::Tracer.current_transaction
 
       current_segment = txn.current_segment
       return unless current_segment.is_a?(NewRelic::Agent::Transaction::DatastoreSegment)
 
       if current_segment.sql_statement
-        current_segment.sql_statement.append_sql sql
+        current_segment.sql_statement.append_sql(sql)
       else
-        current_segment._notice_sql sql, self.opts, explainer_for(sql)
+        current_segment._notice_sql(sql, self.opts, explainer_for(sql))
       end
     end
 
@@ -81,8 +81,8 @@ module Sequel
       (defined?(::Sequel::ThreadedConnectionPool) && ::Sequel::ThreadedConnectionPool)
     ].freeze
 
-    def explainer_for sql
-      Proc.new do |*|
+    def explainer_for(sql)
+      proc do |*|
         if THREAD_SAFE_CONNECTION_POOL_CLASSES.include?(self.pool.class)
           self[sql].explain
         else
@@ -93,6 +93,6 @@ module Sequel
     end
   end # module NewRelicInstrumentation
 
-  NewRelic::Agent.logger.debug "Registering the :newrelic_instrumentation extension."
+  NewRelic::Agent.logger.debug("Registering the :newrelic_instrumentation extension.")
   Database.register_extension(:newrelic_instrumentation, NewRelicInstrumentation)
 end # module Sequel

data/lib/sequel/plugins/newrelic_instrumentation.rb

@@ -1,7 +1,7 @@
 # -*- 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
 
 require 'sequel' unless defined?(Sequel)
 require 'newrelic_rpm' unless defined?(NewRelic)

data/lib/tasks/all.rb

@@ -1,6 +1,6 @@
-# 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
 
 # This is required to load in task definitions
 Dir.glob(File.join(File.dirname(__FILE__), '*.rake')) do |file|

data/lib/tasks/config.rake

@@ -1,7 +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
+
+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"
@@ -24,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

@@ -0,0 +1,28 @@
+# 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.
+
+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.collate(Dir['*/coverage_*/.resultset.json']) do
+        formatter SimpleCov::Formatter::HTMLFormatter
+        refuse_coverage_drop
+      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) }
+    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,3 +1,7 @@
+# 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
+
 namespace :newrelic do
   desc "Install a default config/newrelic.yml file"
   task :install do

data/lib/tasks/instrumentation_generator/README.md

@@ -0,0 +1,63 @@
+# Instrumentation Generator
+
+## Usage
+
+`thor list` can be passed to get a list of all available thor commands
+
+### instrumentation:scaffold
+
+This task requires one parameter by default: the name of the library or class you are instrumenting. This task generates the basic file structure needed to add new instrumentation to the Ruby agent.
+
+Run it using:
+
+`thor instrumentation:scaffold gem_name`
+
+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`.
+
+With the optional parameters, the task can be run like so:
+
+`thor instrumentation:scaffold gem_name --method=method_to_instrument --args=arg1,arg2,arg3`
+
+### WIP: instrumentation:add_new_method
+
+Are you trying add instrumentation for a method within library we already instrument? This task is for you! Instead of building the entire scaffold, this task inserts only the changes needed within the `instrumentation.rb` and test files to instrument the new method. It requires one argument, the name of the existing instrumentation to add the method to. If the instrumented library does not already exist, it will create a new scaffold for that library.
+
+Run it using:
+
+`thor instrumentation:scaffold gem_name`
+
+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`.
+
+With the optional parameters, the task can be run like so:
+
+`thor instrumentation:add_new_method gem_name --method=method_to_instrument --args=arg1,arg2,arg3`
+
+## Idea
+
+Create a CLI, similar to Rails’ generators and scaffold scripts, to create the required files and basic classes for instrumenting new libraries. The hope is that the parts of adding new instrumentation that is repetitive can be eliminated and/or reduced so that it takes less time to add new instrumentation and we can spend development time considering the best attributes to collect and interactions to measure. I also hope this project will reduce the overall toil related to adding new instrumentation.
+
+The files we create with little variation besides library and method names are:
+
+- Lib
+  - Dependency detection
+  - Chain
+  - Prepend
+  - Instrumentation
+- Tests
+  - configuration/newrelic.yml
+  - Envfile
+  - Test file
+
+Furthermore, we also create very similar snippets inside the default source configuration file that could be generated by this project as well.
+
+## Outcome
+
+A prototype outside the agent has been created that generates the required files to create new instrumentation. This prototype accepts three arguments: name (name of the library), method (method to instrument), args (arguments for the method).
+
+The Ruby gem Thor, a toolkit for building powerful command-line interfaces used in Bundler, Vagrant, Rails and others powers this CLI.

data/lib/tasks/instrumentation_generator/TODO.md

@@ -0,0 +1,33 @@
+# TODO
+
+# - [X] Create instrumentation file
+
+# - [X] Create chain file
+
+# - [X] Create prepend file
+
+# - [X] Create dependency detection file
+
+# - [X] Add config to default source
+
+# - [X] Create multiverse suite
+
+# - [X] Create Envfile
+
+# - [X] Create test file with examples
+
+# - [X] Create option for method names to instrument
+
+# - [X] Add entry to newrelic.yml
+
+# - [ ] Append a new method to instrument to an existing instrumentation class (with tests?)
+
+# - [ ] Documentation: examples of what to add in each gap
+
+# - [ ] Good examples of tests, instrumentation, etc. as comments
+
+# - [ ] Handle multi-word gem names (camel case for classes, handle hyphens, concurrent-ruby as example)
+
+# - [ ] Make sure multiple arguments can be passed to the command line
+
+# - [ ] Add tests