newrelic_rpm 9.14.0 → 9.18.0

data/lib/tasks/instrumentation_generator/instrumentation.thor

@@ -1,130 +0,0 @@
-# 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
-    @snake_name = snake_name(@name)
-    @method = options[:method] if options[:method]
-    @args = options[:args] if options[:args]
-    @class_name = ::NewRelic::LanguageSupport.camelize(name)
-    base_path = "#{INSTRUMENTATION_ROOT}#{@snake_name}"
-
-    empty_directory(base_path)
-    create_instrumentation_files(base_path)
-    append_to_default_source(@name, @snake_name)
-    # append_to_newrelic_yml(@name, @snake_name) # This is now done on release, we don't need it anymore, but leaving it to be sure.
-    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 %>'
-    @snake_name = snake_name(@name)
-    base_path = "#{MULTIVERSE_SUITE_ROOT}#{@snake_name}"
-    empty_directory(base_path)
-    template('templates/Envfile.tt', "#{base_path}/Envfile")
-    template('templates/test.tt', "#{base_path}/#{@snake_name}_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, snake_name)
-    insert_into_file(
-      DEFAULT_SOURCE_LOCATION,
-      config_block(name, snake_name),
-      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, snake_name)
-    insert_into_file(
-      NEWRELIC_YML_LOCATION,
-      yaml_block(name, snake_name),
-      after: "# instrumentation.bunny: auto\n"
-    )
-  end
-
-  def config_block(name, snake_name)
-    # Don't change to <<~
-    # We want to preserve the whitespace so the config is correctly indented
-    <<-CONFIG
-        :'instrumentation.#{snake_name}' => {
-          :default => 'auto',
-          :documentation_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
-
-  def yaml_block(name, snake_name)
-    <<~HEREDOC
-
-      # Controls auto-instrumentation of #{name} at start-up.
-      # May be one of [auto|prepend|chain|disabled]
-      # instrumentation.#{snake_name}: auto
-    HEREDOC
-  end
-
-  def snake_name(name)
-    name.downcase.tr('-', '_')
-  end
-end
-
-Instrumentation.start(ARGV)

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

@@ -1,9 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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 %>::Chain
-    def self.instrument!
-      ::<%= @class_name %>.class_eval do
-        include NewRelic::Agent::Instrumentation::<%= @class_name %>
-
-        alias_method(:<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>)
-
-        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

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

@@ -1,7 +0,0 @@
-alias_method(:<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>)
-
-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

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

@@ -1,29 +0,0 @@
-# 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 '<%= @snake_name.downcase %>/instrumentation'
-require_relative '<%= @snake_name.downcase %>/chain'
-require_relative '<%= @snake_name.downcase %>/prepend'
-
-DependencyDetection.defer do
-  named :<%= @name.match?(/\-|\_/) ? "'#{@snake_name}'" : @name.downcase %>
-
-  depends_on do
-    # The class that needs to be defined to prepend/chain onto. This can be used
-    # to determine whether the library is installed.
-    defined?(<%= @class_name %>)
-    # Add any additional requirements to verify whether this instrumentation
-    # should be installed
-  end
-
-  executes do
-    NewRelic::Agent.logger.info('Installing <%= @name.downcase %> instrumentation')
-
-    if use_prepend?
-      prepend_instrument <%= @class_name %>, NewRelic::Agent::Instrumentation::<%= @class_name %>::Prepend
-    else
-      chain_instrument NewRelic::Agent::Instrumentation::<%= @class_name %>::Chain
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-# 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 <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %>
-      # add instrumentation content here
-      yield
-    end
-  end
-end

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

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

data/lib/tasks/instrumentation_generator/templates/newrelic.yml.tt

@@ -1,19 +0,0 @@
----
-development:
-  error_collector:
-    enabled: true
-  apdex_t: 0.5
-  monitor_mode: true
-  license_key: bootstrap_newrelic_admin_license_key_000
-  instrumentation:
-    <%= @snake_name %>: <%= @instrumentation_method_global_erb_snippet %>
-  app_name: test
-  log_level: debug
-  host: 127.0.0.1
-  api_host: 127.0.0.1
-  transaction_trace:
-    record_sql: obfuscated
-    enabled: true
-    stack_trace_threshold: 0.5
-    transaction_threshold: 1.0
-  capture_params: false

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

@@ -1,13 +0,0 @@
-# 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 %>::Prepend
-    include NewRelic::Agent::Instrumentation::<%= @class_name %>
-
-    def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-      <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> { super }
-    end
-  end
-end

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

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

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

@@ -1,15 +0,0 @@
-# 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
-
-class <%= @class_name %>InstrumentationTest < Minitest::Test
-  def setup
-    @stats_engine = NewRelic::Agent.instance.stats_engine
-  end
-
-  def teardown
-    NewRelic::Agent.instance.stats_engine.clear_stats
-  end
-
-  # Add tests here
-end