newrelic_rpm 5.5.0.348 → 7.2.0

data/lib/new_relic/control/frameworks/rails3.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/control/frameworks/rails'
 

data/lib/new_relic/control/frameworks/rails4.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/control/frameworks/rails3'
 

data/lib/new_relic/control/frameworks/{rails5.rb → rails_notifications.rb}

@@ -1,13 +1,13 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/control/frameworks/rails4'
 
 module NewRelic
   class Control
     module Frameworks
-      class Rails5 < NewRelic::Control::Frameworks::Rails4
+      class RailsNotifications < NewRelic::Control::Frameworks::Rails4
       end
     end
   end

data/lib/new_relic/control/frameworks/ruby.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   class Control

data/lib/new_relic/control/frameworks/sinatra.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/control/frameworks/ruby'
 module NewRelic

data/lib/new_relic/control/instance_methods.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/null_logger'
 require 'new_relic/agent/memory_logger'
@@ -101,7 +101,13 @@ module NewRelic
         Agent.config.replace_or_add_config(manual)
 
         config_file_path = @config_file_override || Agent.config[:config_path]
-        Agent.config.replace_or_add_config(Agent::Configuration::YamlSource.new(config_file_path, env))
+        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
+        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")
@@ -159,6 +165,7 @@ module NewRelic
       protected
 
       def initialize(local_env, config_file_override=nil)
+        @install_lock = Mutex.new
         @local_env = local_env
         @started_in_env = nil
 
@@ -172,6 +179,9 @@ module NewRelic
         '.'
       end
 
+      def stdout
+        STDOUT
+      end
     end
     include InstanceMethods
   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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   class Control

data/lib/new_relic/control/server_methods.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   class Control

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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module DependencyDetection
 
@@ -21,6 +21,7 @@ module DependencyDetection
     end
 
     @items << item
+    return item
   end
 
   def detect!
@@ -51,28 +52,74 @@ module DependencyDetection
   class Dependent
     attr_reader :executed
     attr_accessor :name
+    attr_writer :config_name
+    attr_reader :dependencies
+    attr_reader :prepend_conflicts
+
+
     def executed!
       @executed = true
     end
 
-    attr_reader :dependencies
+    def config_name
+      @config_name || @name
+    end
 
     def initialize
       @dependencies = []
       @executes = []
+      @prepend_conflicts = []
       @name = nil
+      @config_name = nil
     end
 
     def dependencies_satisfied?
       !executed and check_dependencies
     end
 
+    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
+      instrumenting_module.to_s.split("::")[-2]
+    end
+
+    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.record_metric("Supportability/Instrumentation/#{supportability_name}/#{method}", 0.0)
+      yield
+    end
+
+    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
+      end
+    end
+
+    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"
+      log_and_instrument("MethodChaining", instrumenting_module, supportability_name) do
+        instrumenting_module.instrument! target
+      end
+    end
+
     def execute
       @executes.each do |x|
         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
@@ -93,29 +140,92 @@ module DependencyDetection
       end
     end
 
-    def depends_on
-      @dependencies << Proc.new
+    def depends_on &block
+      @dependencies << block if block_given?
     end
 
     def allowed_by_config?
-      # If we don't have a name, can't check config so allow it
-      return true if self.name.nil?
+      !(disabled_configured? || deprecated_disabled_configured?)
+    end
+
+    # TODO: Remove in 8.0
+    # will only return true if a disabled key is found and is truthy
+    def deprecated_disabled_configured?
+      return false if self.name.nil?
 
       key = "disable_#{self.name}".to_sym
-      if (::NewRelic::Agent.config[key] == true)
-        ::NewRelic::Agent.logger.debug("Not installing #{self.name} instrumentation because of configuration #{key}")
-        false
-      else
-        true
+      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}`"
+
+      return true
+    end
+
+    def config_key
+      return nil if self.config_name.nil?
+      @config_key ||= "instrumentation.#{self.config_name}".to_sym
+    end
+
+    VALID_CONFIG_VALUES = [:auto, :disabled, :prepend, :chain]
+    AUTO_CONFIG_VALUE = VALID_CONFIG_VALUES[0]
+
+    VALID_CONFIG_VALUES.each do |value|
+      define_method "#{value}_configured?" do
+        value == config_value
       end
     end
 
+    # returns only a valid value for instrumentation configuration
+    # If user uses "enabled" it's converted to "auto"
+    def valid_config_value retrieved_value
+      VALID_CONFIG_VALUES.include?(retrieved_value) ? retrieved_value : AUTO_CONFIG_VALUE
+    end
+
+    # fetches and transform potentially invalid value given to one of the valid config values
+    # logs the resolved value during debug mode.
+    def fetch_config_value(key)
+      valid_value = valid_config_value(::NewRelic::Agent.config[key].to_s.to_sym)
+      ::NewRelic::Agent.logger.debug("Using #{valid_value} configuration value for #{self.name} to configure instrumentation")
+      return valid_value
+    end
+
+    def config_value
+      return AUTO_CONFIG_VALUE unless config_key
+      fetch_config_value(config_key)
+    end
+
     def named(new_name)
       self.name = new_name
     end
 
-    def executes
-      @executes << Proc.new
+    def configure_with(new_config_name)
+      self.config_name = new_config_name
+    end
+
+    def executes &block
+      @executes << block if block_given?
+    end
+
+    def conflicts_with_prepend &block
+      @prepend_conflicts << block if block_given?
+    end
+
+    def use_prepend?
+      prepend_configured? || (auto_configured? && !prepend_conflicts?)
+    end
+
+    def prepend_conflicts?
+      @prepend_conflicts.any? do |conflict|
+        begin
+          conflict.call
+        rescue => err
+          NewRelic::Agent.logger.error( "Error while checking prepend conflicts #{self.name}:", err )
+          false # assumes no conflicts exist since `prepend` is preferred method of instrumenting
+        end
+      end
     end
   end
 end

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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   # The EnvironmentReport is responsible for analyzing the application's
@@ -69,9 +69,7 @@ module NewRelic
     report_on('Arch'              ) { ::NewRelic::Agent::SystemInfo.processor_arch         }
     report_on('OS version'        ) { ::NewRelic::Agent::SystemInfo.os_version             }
     report_on('OS'                ) { ::NewRelic::Agent::SystemInfo.ruby_os_identifier     }
-    report_on('Database adapter'  ) do
-      ActiveRecord::Base.configurations[NewRelic::Control.instance.env]['adapter']
-    end
+    report_on('Database adapter'  ) { ::NewRelic::Agent::DatabaseAdapter.value }
     report_on('Framework'       ) { Agent.config[:framework].to_s  }
     report_on('Dispatcher'      ) { Agent.config[:dispatcher].to_s }
     report_on('Environment'     ) { NewRelic::Control.instance.env }

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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/language_support'
 

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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module LanguageSupport

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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module LatestChanges
@@ -9,7 +9,7 @@ module NewRelic
     end
 
     FOOTER = <<'EOS'
-    See https://github.com/newrelic/rpm/blob/master/CHANGELOG.md for a full list of
+    See https://github.com/newrelic/newrelic-ruby-agent/blob/main/CHANGELOG.md for a full list of
     changes.
 EOS
 
@@ -26,7 +26,7 @@ EOS
     # * This is a patch item (3.7.1.188)
     def self.read_patch(patch_level, changelog=default_changelog)
       latest = extract_latest_changes(File.read(changelog))
-      changes = ["## v#{patch_level} ##", ""]
+      changes = ["## v#{patch_level}", ""]
 
       current_item = nil
       latest.each do |line|
@@ -52,7 +52,7 @@ EOS
       changes = []
       version_count = 0
       contents.each_line do |line|
-        if line.match(/##\s+v[\d.]+\s+##/)
+        if line.match(/##\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/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'set'
 require 'new_relic/version'

data/lib/new_relic/metric_data.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/coerce'
 

data/lib/new_relic/metric_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 # this struct uniquely defines a metric, optionally inside
 # the call scope of another metric

data/lib/new_relic/noticed_error.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/helper'
 require 'new_relic/agent/attribute_filter'
@@ -17,11 +18,22 @@ class NewRelic::NoticedError
 
   attr_reader   :exception_id, :is_internal
 
-  STRIPPED_EXCEPTION_REPLACEMENT_MESSAGE = "Message removed by New Relic 'strip_exception_messages' setting".freeze
-  UNKNOWN_ERROR_CLASS_NAME = 'Error'.freeze
-  NIL_ERROR_MESSAGE = '<no message>'.freeze
+  STRIPPED_EXCEPTION_REPLACEMENT_MESSAGE = "Message removed by New Relic 'strip_exception_messages' setting"
+  UNKNOWN_ERROR_CLASS_NAME = 'Error'
+  NIL_ERROR_MESSAGE = '<no message>'
 
-  def initialize(path, exception, timestamp = Time.now)
+  USER_ATTRIBUTES = "userAttributes"
+  AGENT_ATTRIBUTES = "agentAttributes"
+  INTRINSIC_ATTRIBUTES = "intrinsics"
+
+  DESTINATION = NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
+
+  ERROR_PREFIX_KEY   = 'error'
+  ERROR_MESSAGE_KEY  = "#{ERROR_PREFIX_KEY}.message"
+  ERROR_CLASS_KEY    = "#{ERROR_PREFIX_KEY}.class"
+  ERROR_EXPECTED_KEY = "#{ERROR_PREFIX_KEY}.expected"
+
+  def initialize(path, exception, timestamp = Time.now, expected = false)
     @exception_id = exception.object_id
     @path = path
 
@@ -39,14 +51,14 @@ class NewRelic::NoticedError
 
     # replace error message if enabled
     if NewRelic::Agent.config[:'strip_exception_messages.enabled'] &&
-       !self.class.passes_message_whitelist(exception.class)
+       !self.class.passes_message_allowlist(exception.class)
       @message = STRIPPED_EXCEPTION_REPLACEMENT_MESSAGE
     end
 
     @attributes_from_notice_error = nil
     @attributes = nil
     @timestamp = timestamp
-    @expected = false
+    @expected = expected
   end
 
   def ==(other)
@@ -57,8 +69,8 @@ class NewRelic::NoticedError
     end
   end
 
-  def self.passes_message_whitelist(exception_class)
-    NewRelic::Agent.config[:'strip_exception_messages.whitelist'].any? do |klass|
+  def self.passes_message_allowlist(exception_class)
+    NewRelic::Agent.config[:'strip_exception_messages.allowed_classes'].any? do |klass|
       exception_class <= klass
     end
   end
@@ -73,21 +85,13 @@ class NewRelic::NoticedError
       processed_attributes ]
   end
 
-  USER_ATTRIBUTES = "userAttributes".freeze
-  AGENT_ATTRIBUTES = "agentAttributes".freeze
-  INTRINSIC_ATTRIBUTES = "intrinsics".freeze
-
-  EMPTY_HASH = {}.freeze
-
-  DESTINATION = NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
-
   # Note that we process attributes lazily and store the result. This is because
   # there is a possibility that a noticed error will be discarded and not sent back
   # as a traced error or TransactionError.
   def processed_attributes
     @processed_attributes ||= begin
       attributes = base_parameters
-      merged_attributes = NewRelic::Agent::Transaction::Attributes.new(NewRelic::Agent.instance.attribute_filter)
+      merged_attributes = NewRelic::Agent::Attributes.new(NewRelic::Agent.instance.attribute_filter)
       append_attributes(attributes, USER_ATTRIBUTES, merged_custom_attributes(merged_attributes))
       append_attributes(attributes, AGENT_ATTRIBUTES, build_agent_attributes(merged_attributes))
       append_attributes(attributes, INTRINSIC_ATTRIBUTES, build_intrinsic_attributes)
@@ -100,7 +104,7 @@ class NewRelic::NoticedError
     params[:file_name]        = file_name   if file_name
     params[:line_number]      = line_number if line_number
     params[:stack_trace]      = stack_trace if stack_trace
-    params[:'error.expected'] = expected
+    params[ERROR_EXPECTED_KEY.to_sym] = expected
     params
   end
 
@@ -129,11 +133,21 @@ class NewRelic::NoticedError
     end
   end
 
+  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_EXPECTED_KEY] = true if expected
+  end
+
   def build_agent_attributes(merged_attributes)
     agent_attributes = if @attributes
       @attributes.agent_attributes_for(DESTINATION)
     else
-      EMPTY_HASH
+      NewRelic::EMPTY_HASH
     end
 
     # It's possible to override the request_uri from the transaction attributes
@@ -151,7 +165,7 @@ class NewRelic::NoticedError
     if @attributes
       @attributes.intrinsic_attributes_for(DESTINATION)
     else
-      EMPTY_HASH
+      NewRelic::EMPTY_HASH
     end
   end
 
@@ -175,6 +189,9 @@ class NewRelic::NoticedError
     if exception.nil?
       @exception_class_name = UNKNOWN_ERROR_CLASS_NAME
       @message = NIL_ERROR_MESSAGE
+    elsif exception.is_a? NewRelic::Agent::NoticibleError
+      @exception_class_name = exception.class_name
+      @message = exception.message
     else
       if defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR < 5 && exception.respond_to?(:original_exception)
         exception = exception.original_exception || exception