newrelic_rpm 8.10.1 → 8.11.0

data/lib/new_relic/control/instance_methods.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,12 +6,15 @@ 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
@@ -53,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
@@ -68,17 +68,7 @@ module NewRelic
         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)
@@ -86,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
@@ -99,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
 
@@ -168,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,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/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,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/control.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/delayed_job_injection.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/dependency_detection.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
@@ -140,7 +139,7 @@ module DependencyDetection
     end
 
     def depends_on(&block)
-      @dependencies << block if block_given?
+      @dependencies << block if block
     end
 
     def allowed_by_config?
@@ -206,11 +205,11 @@ module DependencyDetection
     end
 
     def executes(&block)
-      @executes << block if block_given?
+      @executes << block if block
     end
 
     def conflicts_with_prepend(&block)
-      @prepend_conflicts << block if block_given?
+      @prepend_conflicts << block if block
     end
 
     def use_prepend?

data/lib/new_relic/environment_report.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
@@ -94,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
@@ -124,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,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
@@ -66,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,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
@@ -10,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
 
@@ -57,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...

data/lib/new_relic/latest_changes.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
@@ -31,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
@@ -53,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,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
@@ -35,8 +34,8 @@ 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)
@@ -183,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

data/lib/new_relic/metric_data.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
@@ -9,9 +8,11 @@ module NewRelic
   class MetricData
     # a NewRelic::MetricSpec object
     attr_reader :metric_spec
-    # the actual statistics object
+    # a NewRelic::Agent::Stats object
     attr_accessor :stats
 
+    include NewRelic::Coerce
+
     def initialize(metric_spec, stats)
       @original_spec = nil
       @metric_spec = metric_spec
@@ -22,8 +23,12 @@ module NewRelic
       (metric_spec.eql?(o.metric_spec)) && (stats.eql?(o.stats))
     end
 
-    def original_spec
-      @original_spec || @metric_spec
+    def hash
+      [metric_spec, stats].hash
+    end
+
+    def inspect
+      "#<MetricData metric_spec:#{metric_spec.inspect}, stats:#{stats.inspect}>"
     end
 
     # assigns a new metric spec, and retains the old metric spec as
@@ -33,8 +38,13 @@ module NewRelic
       @metric_spec = new_spec
     end
 
-    def hash
-      [metric_spec, stats].hash
+    def original_spec
+      @original_spec || @metric_spec
+    end
+
+    def to_collector_array(encoder = nil)
+      stat_key = {'name' => metric_spec.name, 'scope' => metric_spec.scope}
+      [stat_key, stats_collector_array(stat_key)]
     end
 
     def to_json(*a)
@@ -45,23 +55,18 @@ module NewRelic
       "#{metric_spec.name}(#{metric_spec.scope}): #{stats}"
     end
 
-    def inspect
-      "#<MetricData metric_spec:#{metric_spec.inspect}, stats:#{stats.inspect}>"
-    end
-
-    include NewRelic::Coerce
+    private
 
-    def to_collector_array(encoder = nil)
-      stat_key = {'name' => metric_spec.name, 'scope' => metric_spec.scope}
-      [stat_key,
-        [
-          int(stats.call_count, stat_key),
-          float(stats.total_call_time, stat_key),
-          float(stats.total_exclusive_time, stat_key),
-          float(stats.min_call_time, stat_key),
-          float(stats.max_call_time, stat_key),
-          float(stats.sum_of_squares, stat_key)
-        ]]
+    def stats_collector_array(stat_key)
+      [[:call_count, Integer], [:total_call_time, Float],
+        [:total_exclusive_time, Float], [:min_call_time, Float],
+        [:max_call_time, Float], [:sum_of_squares, Float]].map do |attr_types|
+        if attr_types[1].eql?(Integer)
+          int(stats.send(attr_types[0]), stat_key)
+        elsif attr_types[1].eql?(Float)
+          float(stats.send(attr_types[0]), stat_key)
+        end
+      end
     end
   end
 end

data/lib/new_relic/metric_spec.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/noticed_error.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
@@ -135,10 +134,8 @@ class NewRelic::NoticedError
 
   def build_error_attributes
     @attributes_from_notice_error ||= {}
-    @attributes_from_notice_error.merge!({
-      ERROR_MESSAGE_KEY => string(message),
-      ERROR_CLASS_KEY => string(exception_class_name)
-    })
+    @attributes_from_notice_error[ERROR_MESSAGE_KEY] = string(message)
+    @attributes_from_notice_error[ERROR_CLASS_KEY] = string(exception_class_name)
 
     @attributes_from_notice_error[ERROR_EXPECTED_KEY] = true if expected
   end
@@ -189,7 +186,7 @@ class NewRelic::NoticedError
     if exception.nil?
       @exception_class_name = UNKNOWN_ERROR_CLASS_NAME
       @message = NIL_ERROR_MESSAGE
-    elsif exception.is_a?(NewRelic::Agent::NoticibleError)
+    elsif exception.is_a?(NewRelic::Agent::NoticeableError)
       @exception_class_name = exception.class_name
       @message = exception.message
     else

data/lib/new_relic/rack/agent_hooks.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/rack/agent_middleware.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