newrelic_rpm 8.7.0 → 8.11.0

data/lib/new_relic/control/instance_methods.rb

@@ -1,17 +1,20 @@
-# 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 'new_relic/agent/null_logger'
 require 'new_relic/agent/memory_logger'
 require 'new_relic/agent/agent_logger'
 
+require_relative 'private_instance_methods'
+
 module NewRelic
   class Control
     # Contains methods that relate to the runtime usage of the control
     # object. Note that these are subject to override in the
     # NewRelic::Control::Framework classes that are actually instantiated
     module InstanceMethods
+      include PrivateInstanceMethods
       # The env is the setting used to identify which section of the newrelic.yml
       # to load.  This defaults to a framework specific value, such as ENV['RAILS_ENV']
       # but can be overridden as long as you set it before calling #init_plugin
@@ -52,9 +55,7 @@ module NewRelic
         configure_agent(env, options)
 
         # Be sure to only create once! RUBY-1020
-        if ::NewRelic::Agent.logger.is_startup_logger?
-          ::NewRelic::Agent.logger = NewRelic::Agent::AgentLogger.new(root, options.delete(:log))
-        end
+        create_logger(options)
 
         # Merge the stringified options into the config as overrides:
         environment_name = options.delete(:env) and self.env = environment_name
@@ -63,21 +64,11 @@ module NewRelic
 
         # An artifact of earlier implementation, we put both #add_method_tracer and #trace_execution
         # methods in the module methods.
-        Module.send :include, NewRelic::Agent::MethodTracer::ClassMethods
-        Module.send :include, NewRelic::Agent::MethodTracer
+        Module.send(:include, NewRelic::Agent::MethodTracer::ClassMethods)
+        Module.send(:include, NewRelic::Agent::MethodTracer)
         init_config(options)
         NewRelic::Agent.agent = NewRelic::Agent::Agent.instance
-
-        if !security_settings_valid?
-          handle_invalid_security_settings
-        elsif Agent.config[:agent_enabled] && !NewRelic::Agent.instance.started?
-          start_agent
-          install_instrumentation
-        elsif !Agent.config[:agent_enabled]
-          install_shim
-        else
-          DependencyDetection.detect!
-        end
+        init_instrumentation
       end
 
       def determine_env(options)
@@ -85,11 +76,13 @@ module NewRelic
         env = env.to_s
 
         if @started_in_env && @started_in_env != env
-          Agent.logger.error("Attempted to start agent in #{env.inspect} environment, but agent was already running in #{@started_in_env.inspect}",
-            "The agent will continue running in #{@started_in_env.inspect}. To alter this, ensure the desired environment is set before the agent starts.")
+          Agent.logger.error("Attempted to start agent in #{env.inspect} environment, but agent was already running " \
+            "in #{@started_in_env.inspect}", "The agent will continue running in #{@started_in_env.inspect}. To " \
+            "alter this, ensure the desired environment is set before the agent starts.")
         else
-          Agent.logger.info("Starting the New Relic agent version #{NewRelic::VERSION::STRING} in #{env.inspect} environment.",
-            "To prevent agent startup add a NEW_RELIC_AGENT_ENABLED=false environment variable or modify the #{env.inspect} section of your newrelic.yml.")
+          Agent.logger.info("Starting the New Relic agent version #{NewRelic::VERSION::STRING} in #{env.inspect} " \
+            "environment.", "To prevent agent startup add a NEW_RELIC_AGENT_ENABLED=false environment variable or " \
+            "modify the #{env.inspect} section of your newrelic.yml.")
         end
 
         env
@@ -98,33 +91,20 @@ module NewRelic
       def configure_agent(env, options)
         manual = Agent::Configuration::ManualSource.new(options)
         Agent.config.replace_or_add_config(manual)
-
-        config_file_path = @config_file_override || Agent.config[:config_path]
         yaml_source = Agent::Configuration::YamlSource.new(config_file_path, env)
-        if yaml_source.failed?
-          yaml_source.failures.each do |msg|
-            stdout.puts Agent::AgentLogger.format_fatal_error(msg)
-          end
-        end
+        log_yaml_source_failures(yaml_source) if yaml_source.failed?
         Agent.config.replace_or_add_config(yaml_source)
-
-        if security_settings_valid? && Agent.config[:high_security]
-          Agent.logger.info("Installing high security configuration based on local configuration")
-          Agent.config.replace_or_add_config(Agent::Configuration::HighSecuritySource.new(Agent.config))
-        end
+        configure_high_security
       end
 
       def security_settings_valid?
-        !Agent.config[:high_security] ||
-          Agent.config[:security_policies_token].empty?
+        !Agent.config[:high_security] || Agent.config[:security_policies_token].empty?
       end
 
       def handle_invalid_security_settings
-        NewRelic::Agent.logger.error "Security Policies and High Security " \
-          "Mode cannot both be present in the agent configuration. If " \
-          "Security Policies have been set for your account, please " \
-          "ensure the security_policies_token is set but high_security is " \
-          "disabled (default)."
+        NewRelic::Agent.logger.error("Security Policies and High Security Mode cannot both be present in the agent " \
+          "configuration. If Security Policies have been set for your account, please ensure the " \
+          "security_policies_token is set but high_security is disabled (default).")
         install_shim
       end
 
@@ -167,10 +147,8 @@ module NewRelic
         @install_lock = Mutex.new
         @local_env = local_env
         @started_in_env = nil
-
         @instrumented = nil
         @instrumentation_files = []
-
         @config_file_override = config_file_override
       end
 

data/lib/new_relic/control/instrumentation.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
   class Control
@@ -12,12 +12,12 @@ module NewRelic
       # This requires the files within a rescue block, so that any
       # errors within instrumentation files do not affect the overall
       # agent or application in which it runs.
-      def load_instrumentation_files pattern
+      def load_instrumentation_files(pattern)
         Dir.glob(pattern) do |file|
           begin
             require file.to_s
           rescue => e
-            ::NewRelic::Agent.logger.warn "Error loading instrumentation file '#{file}':", e
+            ::NewRelic::Agent.logger.warn("Error loading instrumentation file '#{file}':", e)
           end
         end
       end
@@ -33,9 +33,9 @@ module NewRelic
       #
       # This happens after the agent has loaded and all dependencies
       # are ready to be instrumented
-      def add_instrumentation pattern
+      def add_instrumentation(pattern)
         if @instrumented
-          load_instrumentation_files pattern
+          load_instrumentation_files(pattern)
         else
           @instrumentation_files << pattern
         end
@@ -60,11 +60,11 @@ module NewRelic
         @instrumentation_files <<
           File.join(instrumentation_path, '*.rb') <<
           File.join(instrumentation_path, app.to_s, '*.rb')
-        @instrumentation_files.each { |pattern| load_instrumentation_files pattern }
+        @instrumentation_files.each { |pattern| load_instrumentation_files(pattern) }
         DependencyDetection.detect!
         ruby_22_deprecation
         rails_32_deprecation
-        ::NewRelic::Agent.logger.info "Finished instrumentation"
+        ::NewRelic::Agent.logger.info("Finished instrumentation")
       end
     end
 

data/lib/new_relic/control/private_instance_methods.rb

@@ -0,0 +1,48 @@
+# 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 'new_relic/agent/memory_logger'
+require 'new_relic/agent/agent_logger'
+
+module NewRelic
+  class Control
+    module PrivateInstanceMethods
+      private
+
+      def configure_high_security
+        if security_settings_valid? && Agent.config[:high_security]
+          Agent.logger.info("Installing high security configuration based on local configuration")
+          Agent.config.replace_or_add_config(Agent::Configuration::HighSecuritySource.new(Agent.config))
+        end
+      end
+
+      def log_yaml_source_failures(yaml_source)
+        yaml_source.failures.each { |msg| stdout.puts Agent::AgentLogger.format_fatal_error(msg) }
+      end
+
+      def config_file_path
+        @config_file_override || Agent.config[:config_path]
+      end
+
+      def create_logger(options)
+        if ::NewRelic::Agent.logger.is_startup_logger?
+          ::NewRelic::Agent.logger = NewRelic::Agent::AgentLogger.new(root, options.delete(:log))
+        end
+      end
+
+      def init_instrumentation
+        if !security_settings_valid?
+          handle_invalid_security_settings
+        elsif Agent.config[:agent_enabled] && !NewRelic::Agent.instance.started?
+          start_agent
+          install_instrumentation
+        elsif !Agent.config[:agent_enabled]
+          install_shim
+        else
+          DependencyDetection.detect!
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/control/server_methods.rb

@@ -1,11 +1,11 @@
-# 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
   class Control
     # Structs holding info for the remote server and proxy server
-    class Server < Struct.new :name, :port # :nodoc:
+    class Server < Struct.new(:name, :port) # :nodoc:
       def to_s; "#{name}:#{port}"; end
     end
 

data/lib/new_relic/control.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
 
 require 'yaml'
 require 'new_relic/dependency_detection'

data/lib/new_relic/delayed_job_injection.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 DelayedJobInjection

data/lib/new_relic/dependency_detection.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 DependencyDetection
   module_function
@@ -75,40 +75,40 @@ module DependencyDetection
       !executed and check_dependencies
     end
 
-    def source_location_for klass, method_name
+    def source_location_for(klass, method_name)
       Object.instance_method(:method).bind(klass.allocate).call(method_name).source_location.to_s
     end
 
     # Extracts the instrumented library name from the instrumenting module's name
     # Given "NewRelic::Agent::Instrumentation::NetHTTP::Prepend"
     # Will extract "NetHTTP" which is in the 2nd to last spot
-    def extract_supportability_name instrumenting_module
+    def extract_supportability_name(instrumenting_module)
       instrumenting_module.to_s.split("::")[-2]
     end
 
-    def log_and_instrument method, instrumenting_module, supportability_name
+    def log_and_instrument(method, instrumenting_module, supportability_name)
       supportability_name ||= extract_supportability_name(instrumenting_module)
-      NewRelic::Agent.logger.info "Installing New Relic supported #{supportability_name} instrumentation using #{method}"
+      NewRelic::Agent.logger.info("Installing New Relic supported #{supportability_name} instrumentation using #{method}")
       NewRelic::Agent.record_metric("Supportability/Instrumentation/#{supportability_name}/#{method}", 0.0)
       yield
     end
 
-    def prepend_instrument target_class, instrumenting_module, supportability_name = nil
+    def prepend_instrument(target_class, instrumenting_module, supportability_name = nil)
       log_and_instrument("Prepend", instrumenting_module, supportability_name) do
-        target_class.send :prepend, instrumenting_module
+        target_class.send(:prepend, instrumenting_module)
       end
     end
 
-    def chain_instrument instrumenting_module, supportability_name = nil
+    def chain_instrument(instrumenting_module, supportability_name = nil)
       log_and_instrument("MethodChaining", instrumenting_module, supportability_name) do
         instrumenting_module.instrument!
       end
     end
 
-    def chain_instrument_target target, instrumenting_module, supportability_name = nil
-      NewRelic::Agent.logger.info "Installing deferred #{target} instrumentation"
+    def chain_instrument_target(target, instrumenting_module, supportability_name = nil)
+      NewRelic::Agent.logger.info("Installing deferred #{target} instrumentation")
       log_and_instrument("MethodChaining", instrumenting_module, supportability_name) do
-        instrumenting_module.instrument! target
+        instrumenting_module.instrument!(target)
       end
     end
 
@@ -117,7 +117,7 @@ module DependencyDetection
         begin
           x.call
         rescue => err
-          NewRelic::Agent.logger.error "Error while installing #{self.name} instrumentation:", err
+          NewRelic::Agent.logger.error("Error while installing #{self.name} instrumentation:", err)
           break
         end
       end
@@ -138,8 +138,8 @@ module DependencyDetection
       end
     end
 
-    def depends_on &block
-      @dependencies << block if block_given?
+    def depends_on(&block)
+      @dependencies << block if block
     end
 
     def allowed_by_config?
@@ -155,9 +155,10 @@ module DependencyDetection
       return false unless ::NewRelic::Agent.config[key] == true
 
       ::NewRelic::Agent.logger.debug("Not installing #{self.name} instrumentation because of configuration #{key}")
-      ::NewRelic::Agent.logger.debug \
-        "[DEPRECATED] configuration #{key} for #{self.name} will be removed in the next major release." \
-        " Use `#{config_key}` with one of `#{VALID_CONFIG_VALUES.map(&:to_s).inspect}`"
+      ::NewRelic::Agent.logger.debug( \
+        "[DEPRECATED] configuration #{key} for #{self.name} will be removed in the next major release. " \
+        "Use `#{config_key}` with one of `#{VALID_CONFIG_VALUES.map(&:to_s).inspect}`"
+      )
 
       return true
     end
@@ -178,7 +179,7 @@ module DependencyDetection
 
     # returns only a valid value for instrumentation configuration
     # If user uses "enabled" it's converted to "auto"
-    def valid_config_value retrieved_value
+    def valid_config_value(retrieved_value)
       VALID_CONFIG_VALUES.include?(retrieved_value) ? retrieved_value : AUTO_CONFIG_VALUE
     end
 
@@ -203,12 +204,12 @@ module DependencyDetection
       self.config_name = new_config_name
     end
 
-    def executes &block
-      @executes << block if block_given?
+    def executes(&block)
+      @executes << block if block
     end
 
-    def conflicts_with_prepend &block
-      @prepend_conflicts << block if block_given?
+    def conflicts_with_prepend(&block)
+      @prepend_conflicts << block if block
     end
 
     def use_prepend?

data/lib/new_relic/environment_report.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
   # The EnvironmentReport is responsible for analyzing the application's
@@ -93,20 +93,9 @@ module NewRelic
       @data = self.class.registered_reporters.inject(Hash.new) do |data, (key, logic)|
         begin
           value = logic.call
-          if value
-            data[key] = value
-
-            Agent.record_metric("Supportability/EnvironmentReport/success", 0.0)
-            Agent.record_metric("Supportability/EnvironmentReport/success/#{key}", 0.0)
-          else
-            Agent.logger.debug("EnvironmentReport ignoring value for #{key.inspect} which came back falsey: #{value.inspect}")
-            Agent.record_metric("Supportability/EnvironmentReport/empty", 0.0)
-            Agent.record_metric("Supportability/EnvironmentReport/empty/#{key}", 0.0)
-          end
+          value ? record_value(data, key, value) : record_empty_value(key, value)
         rescue => e
-          Agent.logger.debug("EnvironmentReport failed to retrieve value for #{key.inspect}: #{e}")
-          Agent.record_metric("Supportability/EnvironmentReport/error", 0.0)
-          Agent.record_metric("Supportability/EnvironmentReport/error/#{key}", 0.0)
+          rescue_initialize(key, e)
         end
         data
       end
@@ -123,5 +112,26 @@ module NewRelic
     def to_a
       @data.to_a
     end
+
+    private
+
+    def record_value(data, key, value)
+      data[key] = value
+
+      Agent.record_metric("Supportability/EnvironmentReport/success", 0.0)
+      Agent.record_metric("Supportability/EnvironmentReport/success/#{key}", 0.0)
+    end
+
+    def record_empty_value(key, value)
+      Agent.logger.debug("EnvironmentReport ignoring value for #{key.inspect} which came back falsey: #{value.inspect}")
+      Agent.record_metric("Supportability/EnvironmentReport/empty", 0.0)
+      Agent.record_metric("Supportability/EnvironmentReport/empty/#{key}", 0.0)
+    end
+
+    def rescue_initialize(key, exception)
+      Agent.logger.debug("EnvironmentReport failed to retrieve value for #{key.inspect}: #{exception}")
+      Agent.record_metric("Supportability/EnvironmentReport/error", 0.0)
+      Agent.record_metric("Supportability/EnvironmentReport/error/#{key}", 0.0)
+    end
   end
 end

data/lib/new_relic/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
 
 require 'new_relic/language_support'
 require 'open3'
@@ -16,16 +16,16 @@ module NewRelic
     # Confirm a string is correctly encoded,
     # If not force the encoding to ASCII-8BIT (binary)
     def correctly_encoded(string)
-      return string unless string.is_a? String
+      return string unless string.is_a?(String)
       # The .dup here is intentional, since force_encoding mutates the target,
       # and we don't know who is going to use this string downstream of us.
       string.valid_encoding? ? string : string.dup.force_encoding(Encoding::ASCII_8BIT)
     end
 
     def instance_method_visibility(klass, method_name)
-      if klass.private_instance_methods.map { |s| s.to_sym }.include? method_name.to_sym
+      if klass.private_instance_methods.map { |s| s.to_sym }.include?(method_name.to_sym)
         :private
-      elsif klass.protected_instance_methods.map { |s| s.to_sym }.include? method_name.to_sym
+      elsif klass.protected_instance_methods.map { |s| s.to_sym }.include?(method_name.to_sym)
         :protected
       else
         :public
@@ -65,7 +65,7 @@ module NewRelic
       output.chomp
     end
 
-    # TODO: Open3 defers the actual excecution of a binary to Process.spawn,
+    # TODO: Open3 defers the actual execution of a binary to Process.spawn,
     #       which will raise an Errno::ENOENT exception for a file that
     #       cannot be found. We might want to take the time to evaluate
     #       relying on that Process.spawn behavior instead of checking for

data/lib/new_relic/language_support.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 LanguageSupport
@@ -9,7 +9,7 @@ module NewRelic
     @@forkable = nil
     def can_fork?
       # this is expensive to check, so we should only check once
-      return @@forkable if @@forkable != nil
+      return @@forkable if !@@forkable.nil?
       @@forkable = Process.respond_to?(:fork)
     end
 
@@ -56,7 +56,7 @@ module NewRelic
         begin
           result = namespace.const_get(name)
 
-          # const_get looks up the inheritence chain, so if it's a class
+          # const_get looks up the inheritance chain, so if it's a class
           # in the constant make sure we found the one in our namespace.
           #
           # Can't help if the constant isn't a class...
@@ -72,6 +72,11 @@ module NewRelic
       end
     end
 
+    def camelize(string)
+      camelized = string.downcase
+      camelized.split(/\-|\_/).map(&:capitalize).join
+    end
+
     def bundled_gem?(gem_name)
       defined?(Bundler) && Bundler.rubygems.all_specs.map(&:name).include?(gem_name)
     rescue => e

data/lib/new_relic/latest_changes.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 LatestChanges
@@ -30,8 +30,8 @@ EOS
 
       current_item = nil
       latest.each do |line|
-        if line.match(/^\s*\*.*/)
-          if line.match(/\(#{patch_level}\)/)
+        if line =~ /^\s*\*.*/
+          if line =~ /\(#{patch_level}\)/
             # Found a patch level item, so start tracking the lines!
             current_item = line
           else
@@ -52,7 +52,7 @@ EOS
       changes = []
       version_count = 0
       contents.each_line do |line|
-        if line.match(/##\s+v[\d.]+/)
+        if line =~ /##\s+v[\d.]+/
           version_count += 1
         end
         break if version_count >= 2

data/lib/new_relic/local_environment.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
 
 require 'set'
 require 'new_relic/version'
@@ -26,7 +26,7 @@ module NewRelic
   #
   # If the environment can't be determined, it will be set to nil.
   #
-  # NewRelic::LocalEnvironment should be accessed through NewRelic::Control#env (via the NewRelic::Control singleton).
+  # NewRelic::LocalEnvironment should be accessed through NewRelic::Control#local_env (via the NewRelic::Control singleton).
   class LocalEnvironment
     def discovered_dispatcher
       discover_dispatcher unless @discovered_dispatcher
@@ -34,11 +34,11 @@ module NewRelic
     end
 
     def initialize
-      # Extend self with any any submodules of LocalEnvironment.  These can override
-      # the discover methods to discover new framworks and dispatchers.
+      # Extend self with any submodules of LocalEnvironment.  These can override
+      # the discover methods to discover new frameworks and dispatchers.
       NewRelic::LocalEnvironment.constants.each do |const|
-        mod = NewRelic::LocalEnvironment.const_get const
-        self.extend mod if mod.instance_of? Module
+        mod = NewRelic::LocalEnvironment.const_get(const)
+        self.extend(mod) if mod.instance_of?(Module)
       end
 
       @discovered_dispatcher = nil
@@ -78,7 +78,7 @@ module NewRelic
       ]
       # TODO: MAJOR VERSION - remove rainbows
       while dispatchers.any? && @discovered_dispatcher.nil?
-        send 'check_for_' + (dispatchers.shift)
+        send('check_for_' + (dispatchers.shift))
       end
     end
 
@@ -182,7 +182,7 @@ module NewRelic
     end
 
     def check_for_litespeed
-      if caller.pop =~ /fcgi-bin\/RailsRunner\.rb/
+      if caller.pop.include?('fcgi-bin/RailsRunner.rb')
         @discovered_dispatcher = :litespeed
       end
     end
@@ -197,9 +197,7 @@ module NewRelic
 
     # outputs a human-readable description
     def to_s
-      s = "LocalEnvironment["
-      s << ";dispatcher=#{@discovered_dispatcher}" if @discovered_dispatcher
-      s << "]"
+      %Q(LocalEnvironment[#{";dispatcher=#{@discovered_dispatcher}" if @discovered_dispatcher}])
     end
 
     def executable