newrelic_rpm 6.8.0.360 → 8.13.1

data/lib/tasks/config.rake

@@ -1,130 +1,35 @@
+# 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"
+    GENERAL = "general"
+    DISABLING = "disabling"
     ATTRIBUTES = "attributes"
 
+    # these configuration options are not able to be set using environment variables
+    NON_ENV_CONFIGS = ['error_collector.ignore_classes', 'error_collector.ignore_messages', 'error_collector.expected_classes', 'error_collector.expected_messages']
+
     SECTION_DESCRIPTIONS = {
-      GENERAL              => 'These settings are available for agent configuration. Some settings depend on your New Relic subscription level.',
-      DISABLING            => 'Use these settings to toggle instrumentation types during agent startup.',
-      ATTRIBUTES           => '<a href="https://docs.newrelic.com/docs/features/agent-attributes">Attributes</a> are key-value pairs containing information that determines the properties of an event or transaction. These key-value pairs can be viewed within transaction traces in New Relic APM, traced errors in New Relic APM, transaction events in Insights, and page views in Insights. You can customize exactly which attributes will be sent to each of these destinations.',
-      "transaction_tracer" => 'The <a href="/docs/apm/traces/transaction-traces/transaction-traces">transaction traces</a> feature collects detailed information from a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level.',
-      "error_collector"    => 'The agent collects and reports all uncaught exceptions by default. These configuration options allow you to customize the error collection.',
-      "browser_monitoring" => 'New Relic Browser\'s <a href="/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process">page load timing</a> feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users\' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page.',
-      "analytics_events"   => '<a href="/docs/insights/new-relic-insights/understanding-insights/new-relic-insights">New Relic Insights</a> is a software analytics resource to gather and visualize data about your software and what it says about your business. With it you can quickly and easily create real-time dashboards to get immediate answers about end-user experiences, clickstreams, mobile activities, and server transactions.'
+      GENERAL => 'These settings are available for agent configuration. Some settings depend on your New Relic subscription level.',
+      DISABLING => 'Use these settings to toggle instrumentation types during agent startup.',
+      ATTRIBUTES => '[Attributes](/docs/features/agent-attributes) are key-value pairs containing information that determines the properties of an event or transaction. These key-value pairs can be viewed within transaction traces in APM, traced errors in APM, transaction events in dashboards, and page views in dashboards. You can customize exactly which attributes will be sent to each of these destinations',
+      "transaction_tracer" => 'The [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces) feature collects detailed information from a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level.',
+      "error_collector" => "The agent collects and reports all uncaught exceptions by default. These configuration options allow you to customize the error collection.\n\nFor information on ignored and expected errors, [see this page on Error Analytics in APM](/docs/agents/manage-apm-agents/agent-data/manage-errors-apm-collect-ignore-or-mark-expected/). To set expected errors via the `NewRelic::Agent.notice_error` Ruby method, [consult the Ruby Agent API](/docs/agents/ruby-agent/api-guides/sending-handled-errors-new-relic/).",
+      "browser_monitoring" => "The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process) feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page.",
+      "analytics_events" => '[New Relic dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-new-relic-one-dashboards) is a resource to gather and visualize data about your software and what it says about your business. With it you can quickly and easily create real-time dashboards to get immediate answers about end-user experiences, clickstreams, mobile activities, and server transactions.'
     }
 
     NAME_OVERRIDES = {
-      "slow_sql"     => "Slow SQL"
+      "slow_sql" => "Slow SQL",
+      "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)
-      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        # "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.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 = value[:description]
-      description = "<b>DEPRECATED</b> #{description}" if value[:deprecated]
-      description
-    end
-
-    def format_default_value(spec)
-      if spec[:default].is_a?(Proc)
-        '(Dynamic)'
-      else
-        "<code>#{spec[:default].inspect}</code>"
-      end
-    end
-
-    def format_env_var(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/config.html.erb

@@ -0,0 +1,21 @@
+<% sections.each do |(section_key, section_name, section_description, configs)| %>
+## <%=section_name%>
+
+<%= "#{section_description}" unless section_description.nil? %>
+
+<CollapserGroup>
+  <% configs.each do |config|%>
+  <Collapser id="<%= config[:key].gsub('.', '-') %>" title="<%=config[:key]%>">
+    <table>
+      <tbody>
+        <tr><th>Type</th><td><%=config[:type]%></td></tr>
+        <tr><th>Default</th><td>`<%=config[:default]%>`</td></tr>
+        <tr><th>Environ variable</th><td>`<%=config[:env_var]%>`</td></tr>
+      </tbody>
+    </table>
+
+  <%=config[:description]%>
+  </Collapser>
+  <% end %>
+</CollapserGroup>
+<% 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') == 0
+      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 was first created. This prototype generated the required files to add instrumentation. The prototype accepted three arguments: name (name of the library), method (method to instrument), args (arguments for the method). This prototype has evolved into the current directory.
+
+This project leverages 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 to guide users)
+
+# - [ ] Handle multi-word gem names (camel case for classes, handle hyphens, concurrent-ruby as example)
+
+# - [ ] Allow multiple method arguments to be passed to the command line
+
+# - [ ] Add tests for the instrumentation_generator code
+
+# - [ ] See if instrumentation PRs can get automatically generated when an already instrumented library adds methods to its codebase

data/lib/tasks/instrumentation_generator/instrumentation.thor

@@ -0,0 +1,124 @@
+# 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 '../../new_relic/language_support'
+require 'thor'
+
+class Instrumentation < Thor
+  include Thor::Actions
+
+  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
+    `instrumentation scaffold` 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.
+  LONGDESC
+
+  source_root(File.dirname(__FILE__))
+
+  option :method,
+    default: 'method_to_instrument',
+    desc: 'The method you would like to prepend or chain instrumentation onto'
+  option :args,
+    default: '*args',
+    desc: 'The arguments associated with the original method'
+
+  def scaffold(name)
+    @name = name
+    @method = options[:method] if options[:method]
+    @args = options[:args] if options[:args]
+    @class_name = ::NewRelic::LanguageSupport.camelize(name)
+    base_path = "#{INSTRUMENTATION_ROOT}#{name.downcase}"
+
+    empty_directory(base_path)
+    create_instrumentation_files(base_path)
+    append_to_default_source(name)
+    append_to_newrelic_yml(name)
+    create_tests(name)
+  end
+
+  desc 'add_new_method NAME', 'Inserts a new method into an existing piece of instrumentation'
+
+  option :method, required: true, desc: 'The name of the method to instrument'
+  option :args, default: '*args', desc: 'The arguments associated with the instrumented method'
+
+  def add_new_method(name, method_name)
+    # Verify that existing instrumentation exists
+    # if it doesn't, should we just call the #scaffold method instead since we have all the stuff
+    # otherwise, inject the new method into the instrumentation matching the first arg
+    # add to only chain, instrumentation, prepend
+    # move the method content to a partial
+  end
+
+  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 %>'
+    base_path = "#{MULTIVERSE_SUITE_ROOT}#{@name.downcase}"
+    empty_directory(base_path)
+    template('templates/Envfile.tt', "#{base_path}/Envfile")
+    template('templates/test.tt', "#{base_path}/#{@name.downcase}_instrumentation_test.rb")
+
+    empty_directory("#{base_path}/config")
+    template('templates/newrelic.yml.tt', "#{base_path}/config/newrelic.yml")
+  end
+
+  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} library at start up. May be one of [auto|prepend|chain|disabled].'
+        },
+    CONFIG
+  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
+
+Instrumentation.start(ARGV)

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

@@ -0,0 +1,9 @@
+# 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
+
+instrumentation_methods :chain, :prepend
+
+gemfile <<-RB
+  gem '<%= @name.downcase %>'
+RB

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

@@ -0,0 +1,22 @@
+# 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::Agent::Instrumentation
+  module <%= @class_name %>
+    def self.instrument!
+      ::<%= @class_name %>.class_eval do
+        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_new_relic<%= "(#{@args})" unless @args.empty? %> do
+            <%= @method.downcase %>_without_new_relic<%= "(#{@args})" unless @args.empty? %>
+          end
+        end
+      end
+    end
+  end
+end