newrelic_rpm 9.1.0 → 9.21.0

data/lib/new_relic/agent/event_loop.rb

@@ -156,7 +156,7 @@ module NewRelic
         end
 
         if !errors.empty?
-          ::NewRelic::Agent.logger.error("#{errors.size} error(s) running task for event '#{event}' in Agent Event Loop:", *errors)
+          ::NewRelic::Agent.logger.error("#{errors.size} error(s) running task for event '#{event}' in agent event loop:", *errors)
         end
       end
 

data/lib/new_relic/agent/external.rb

@@ -29,6 +29,7 @@ module NewRelic
       #
       # @param request_metadata [String] received obfuscated request metadata
       #
+      # @!scope class
       # @api public
       #
       def process_request_metadata(request_metadata)
@@ -74,6 +75,7 @@ module NewRelic
       #
       # @return [String] obfuscated response metadata to send
       #
+      # @!scope class
       # @api public
       #
       def get_response_metadata

data/lib/new_relic/agent/harvester.rb

@@ -38,7 +38,7 @@ module NewRelic
       end
 
       def harvest_thread_enabled?
-        !NewRelic::Agent.config[:disable_harvest_thread]
+        !NewRelic::Agent.config[:disable_harvest_thread] && !NewRelic::Agent.config[:'serverless_mode.enabled']
       end
 
       def restart_harvest_thread

data/lib/new_relic/agent/health_check.rb

@@ -0,0 +1,136 @@
+# 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 Agent
+    class HealthCheck
+      def initialize
+        @start_time = nano_time
+        @continue = true
+        @status = HEALTHY
+        # the following assignments may set @continue = false if they are invalid
+        set_enabled
+        set_delivery_location
+        set_frequency
+      end
+
+      HEALTHY = {healthy: true, last_error: 'NR-APM-000', message: 'Healthy'}.freeze
+      INVALID_LICENSE_KEY = {healthy: false, last_error: 'NR-APM-001', message: 'Invalid license key (HTTP status code 401)'}.freeze
+      MISSING_LICENSE_KEY = {healthy: false, last_error: 'NR-APM-002', message: 'License key missing in configuration'}.freeze
+      FORCED_DISCONNECT = {healthy: false, last_error: 'NR-APM-003', message: 'Forced disconnect received from New Relic (HTTP status code 410)'}.freeze
+      HTTP_ERROR = {healthy: false, last_error: 'NR-APM-004', message: 'HTTP error response code [%s] recevied from New Relic while sending data type [%s]'}.freeze
+      MISSING_APP_NAME = {healthy: false, last_error: 'NR-APM-005', message: 'Missing application name in agent configuration'}.freeze
+      APP_NAME_EXCEEDED = {healthy: false, last_error: 'NR-APM-006', message: 'The maximum number of configured app names (3) exceeded'}.freeze
+      PROXY_CONFIG_ERROR = {healthy: false, last_error: 'NR-APM-007', message: 'HTTP Proxy configuration error; response code [%s]'}.freeze
+      AGENT_DISABLED = {healthy: false, last_error: 'NR-APM-008', message: 'Agent is disabled via configuration'}.freeze
+      FAILED_TO_CONNECT = {healthy: false, last_error: 'NR-APM-009', message: 'Failed to connect to New Relic data collector'}.freeze
+      FAILED_TO_PARSE_CONFIG = {healthy: false, last_error: 'NR-APM-010', message: 'Agent config file is not able to be parsed'}.freeze
+      SHUTDOWN = {healthy: true, last_error: 'NR-APM-099', message: 'Agent has shutdown'}.freeze
+
+      def create_and_run_health_check_loop
+        return unless health_checks_enabled? && @continue
+
+        NewRelic::Agent.logger.debug('Agent Control health check conditions met. Starting health checks.')
+        NewRelic::Agent.record_metric('Supportability/AgentControl/Health/enabled', 1)
+
+        Thread.new do
+          while @continue
+            begin
+              sleep @frequency
+              write_file
+              @continue = false if @status == SHUTDOWN
+            rescue StandardError => e
+              NewRelic::Agent.logger.error("Aborting Agent Control health check. Error raised: #{e}")
+              @continue = false
+            end
+          end
+        end
+      end
+
+      def update_status(status, options = [])
+        return unless @continue
+
+        @status = status.dup
+        update_message(options) unless options.empty?
+      end
+
+      def healthy?
+        @status == HEALTHY
+      end
+
+      private
+
+      def set_enabled
+        @enabled = if ENV['NEW_RELIC_AGENT_CONTROL_ENABLED'] == 'true'
+          true
+        else
+          NewRelic::Agent.logger.debug('NEW_RELIC_AGENT_CONTROL_ENABLED not true, disabling health checks')
+          @continue = false
+          false
+        end
+      end
+
+      def set_delivery_location
+        @delivery_location = if ENV['NEW_RELIC_AGENT_CONTROL_HEALTH_DELIVERY_LOCATION']
+          # The spec states file paths for the delivery location will begin with file://
+          # This does not create a valid path in Ruby, so remove the prefix when present
+          ENV['NEW_RELIC_AGENT_CONTROL_HEALTH_DELIVERY_LOCATION']&.gsub('file://', '')
+        else
+          # The spec default is 'file:///newrelic/apm/health', but since we're just going to remove it anyway...
+          '/newrelic/apm/health'
+        end
+      end
+
+      def set_frequency
+        @frequency = ENV['NEW_RELIC_AGENT_CONTROL_HEALTH_FREQUENCY'] ? ENV['NEW_RELIC_AGENT_CONTROL_HEALTH_FREQUENCY'].to_i : 5
+
+        if @frequency <= 0
+          NewRelic::Agent.logger.debug('NEW_RELIC_AGENT_CONTROL_HEALTH_FREQUENCY zero or less, disabling health checks')
+          @continue = false
+        end
+      end
+
+      def contents
+        <<~CONTENTS
+          healthy: #{@status[:healthy]}
+          status: #{@status[:message]}#{last_error}
+          start_time_unix_nano: #{@start_time}
+          status_time_unix_nano: #{nano_time}
+        CONTENTS
+      end
+
+      def last_error
+        @status[:healthy] ? '' : "\nlast_error: #{@status[:last_error]}"
+      end
+
+      def nano_time
+        Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
+      end
+
+      def file_name
+        "health-#{NewRelic::Agent::GuidGenerator.generate_guid(32)}.yml"
+      end
+
+      def write_file
+        @file ||= "#{@delivery_location}/#{file_name}"
+
+        File.write(@file, contents)
+      rescue StandardError => e
+        NewRelic::Agent.logger.error("Agent Control health check raised an error while writing a file: #{e}")
+        @continue = false
+      end
+
+      def health_checks_enabled?
+        @enabled && @delivery_location && @frequency > 0
+      end
+
+      def update_message(options)
+        @status[:message] = sprintf(@status[:message], *options)
+      rescue StandardError => e
+        NewRelic::Agent.logger.debug("Error raised while updating Agent Control health check message: #{e}." \
+          "options = #{options}, @status[:message] = #{@status[:message]}")
+      end
+    end
+  end
+end

data/lib/new_relic/agent/http_clients/abstract.rb

@@ -14,6 +14,10 @@ module NewRelic
       #
       # @api public
       class AbstractRequest
+        LHOST = 'host'
+        UHOST = 'Host'
+        COLON = ':'
+
         %i[[] []= type host_from_header host method headers uri].each do |name|
           define_method(name) do
             not_implemented(name)

data/lib/new_relic/agent/http_clients/async_http_wrappers.rb

@@ -0,0 +1,80 @@
+# 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 'abstract'
+require 'resolv'
+
+module NewRelic
+  module Agent
+    module HTTPClients
+      class AsyncHTTPResponse < AbstractResponse
+        def get_status_code
+          get_status_code_using(:status)
+        end
+
+        def [](key)
+          to_hash[key.downcase]&.first
+        end
+
+        def to_hash
+          @wrapped_response.headers.to_h
+        end
+      end
+
+      class AsyncHTTPRequest < AbstractRequest
+        def initialize(connection, method, url, headers)
+          @connection = connection
+          @method = method
+          @url = ::NewRelic::Agent::HTTPClients::URIUtil.parse_and_normalize_url(url)
+          @headers = headers
+        end
+
+        ASYNC_HTTP = 'Async::HTTP'
+
+        def type
+          ASYNC_HTTP
+        end
+
+        def host_from_header
+          if hostname = (self[LHOST] || self[UHOST])
+            hostname.split(COLON).first
+          end
+        end
+
+        def host
+          host_from_header || uri.host.to_s
+        end
+
+        def [](key)
+          return headers[key] unless headers.is_a?(Array)
+
+          headers.each do |header|
+            return header[1] if header[0].casecmp?(key)
+          end
+          nil
+        end
+
+        def []=(key, value)
+          if headers.is_a?(Array)
+            headers << [key, value]
+          else
+            headers[key] = value
+          end
+        end
+
+        def uri
+          @url
+        end
+
+        def headers
+          @headers
+        end
+
+        def method
+          @method
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/http_clients/curb_wrappers.rb

@@ -7,10 +7,8 @@ require_relative 'abstract'
 module NewRelic
   module Agent
     module HTTPClients
-      class CurbRequest
+      class CurbRequest < AbstractRequest
         CURB = 'Curb'
-        LHOST = 'host'
-        UHOST = 'Host'
 
         def initialize(curlobj)
           @curlobj = curlobj

data/lib/new_relic/agent/http_clients/ethon_wrappers.rb

@@ -0,0 +1,109 @@
+# 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 'uri'
+require_relative 'abstract'
+
+module NewRelic
+  module Agent
+    module HTTPClients
+      class EthonHTTPResponse < AbstractResponse
+        def initialize(easy)
+          @easy = easy
+        end
+
+        def status_code
+          @easy.response_code
+        end
+
+        def [](key)
+          headers[format_key(key)]
+        end
+
+        def headers
+          # Ethon::Easy#response_headers will return '' if headers are unset
+          @easy.response_headers.scan(/\n([^:]+?): ([^:\n]+?)\r/).each_with_object({}) do |pair, hash|
+            hash[format_key(pair[0])] = pair[1]
+          end
+        end
+        alias to_hash headers
+
+        private
+
+        def format_key(key)
+          key.tr('-', '_').downcase
+        end
+      end
+
+      class EthonHTTPRequest < AbstractRequest
+        attr_reader :uri
+
+        DEFAULT_ACTION = 'GET'
+        DEFAULT_HOST = 'UNKNOWN_HOST'
+        ETHON = 'Ethon'
+
+        def initialize(easy)
+          @easy = easy
+          @uri = uri_from_easy
+        end
+
+        def type
+          ETHON
+        end
+
+        def host_from_header
+          self[LHOST] || self[UHOST]
+        end
+
+        def uri_from_easy
+          # anticipate `Ethon::Easy#url` being `example.com` without a protocol
+          # defined and use an 'http' protocol prefix for `URI.parse` to work
+          # with the URL as desired
+          url_str = @easy.url.match?(':') ? @easy.url : "http://#{@easy.url}"
+          begin
+            URI.parse(url_str)
+          rescue URI::InvalidURIError => e
+            NewRelic::Agent.logger.debug("Failed to parse URI '#{url_str}': #{e.class} - #{e.message}")
+            URI.parse(NewRelic::EMPTY_STR)
+          end
+        end
+
+        def host
+          host_from_header || uri.host&.downcase || DEFAULT_HOST
+        end
+
+        def method
+          return DEFAULT_ACTION unless @easy.instance_variable_defined?(action_instance_var)
+
+          @easy.instance_variable_get(action_instance_var)
+        end
+
+        def action_instance_var
+          NewRelic::Agent::Instrumentation::Ethon::Easy::ACTION_INSTANCE_VAR
+        end
+
+        def []=(key, value)
+          headers[key] = value
+          @easy.headers = headers
+        end
+
+        def headers
+          @headers ||= if @easy.instance_variable_defined?(headers_instance_var)
+            @easy.instance_variable_get(headers_instance_var)
+          else
+            {}
+          end
+        end
+
+        def headers_instance_var
+          NewRelic::Agent::Instrumentation::Ethon::Easy::HEADERS_INSTANCE_VAR
+        end
+
+        def [](key)
+          headers[key]
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/http_clients/excon_wrappers.rb

@@ -47,9 +47,6 @@ module NewRelic
         attr_reader :method
 
         EXCON = 'Excon'
-        LHOST = 'host'
-        UHOST = 'Host'
-        COLON = ':'
 
         def initialize(datum)
           @datum = datum

data/lib/new_relic/agent/http_clients/http_rb_wrappers.rb

@@ -20,8 +20,6 @@ module NewRelic
 
       class HTTPRequest < AbstractRequest
         HTTP_RB = 'http.rb'
-        HOST = 'host'
-        COLON = ':'
 
         def initialize(wrapped_request)
           @wrapped_request = wrapped_request
@@ -36,7 +34,7 @@ module NewRelic
         end
 
         def host_from_header
-          if hostname = self[HOST]
+          if hostname = self[LHOST]
             hostname.split(COLON).first
           end
         end

data/lib/new_relic/agent/http_clients/httpclient_wrappers.rb

@@ -26,9 +26,6 @@ module NewRelic
         attr_reader :request
 
         HTTP_CLIENT = 'HTTPClient'.freeze
-        LHOST = 'host'.freeze
-        UHOST = 'Host'.freeze
-        COLON = ':'.freeze
 
         def initialize(request)
           @request = request

data/lib/new_relic/agent/http_clients/httpx_wrappers.rb

@@ -0,0 +1,91 @@
+# 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 'abstract'
+
+module NewRelic
+  module Agent
+    module HTTPClients
+      # HTTPX returns an instance of HTTPX::ErrorResponse on error,
+      # and that instance itself yields the underlying HTTP response
+      # object via #response, but depending on the error that HTTP
+      # response object could be unset.
+      class HTTPXErrorResponse
+        def status; end
+        def headers; {}; end
+      end
+
+      class HTTPXHTTPResponse < AbstractResponse
+        def initialize(response)
+          if response.is_a?(::HTTPX::ErrorResponse)
+            @response = response.response || HTTPXErrorResponse.new
+          else
+            @response = response
+          end
+        end
+
+        def status_code
+          @response.status
+        end
+
+        def [](key)
+          headers[format_key(key)]
+        end
+
+        def headers
+          headers ||= @response.headers.to_hash.each_with_object({}) do |(k, v), h|
+            h[format_key(k)] = v
+          end
+        end
+        alias to_hash headers
+
+        private
+
+        def format_key(key)
+          key.tr('-', '_').downcase
+        end
+      end
+
+      class HTTPXHTTPRequest < AbstractRequest
+        attr_reader :uri
+
+        DEFAULT_HOST = 'UNKNOWN_HOST'
+        TYPE = 'HTTPX'
+
+        def initialize(request)
+          @request = request
+          @uri = request.uri
+        end
+
+        def type
+          TYPE
+        end
+
+        def host_from_header
+          self[LHOST] || self[UHOST]
+        end
+
+        def host
+          host_from_header || uri.host&.downcase || DEFAULT_HOST
+        end
+
+        def method
+          @request.verb
+        end
+
+        def []=(key, value)
+          @request.headers[key] = value
+        end
+
+        def headers
+          @request.headers
+        end
+
+        def [](key)
+          @request.headers[key]
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/http_clients/net_http_wrappers.rb

@@ -30,11 +30,8 @@ module NewRelic
           NET_HTTP
         end
 
-        HOST = 'host'
-        COLON = ':'
-
         def host_from_header
-          if hostname = self[HOST]
+          if hostname = self[LHOST]
             hostname.split(COLON).first
           end
         end

data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb

@@ -48,9 +48,6 @@ module NewRelic
           TYPHOEUS
         end
 
-        LHOST = 'host'.freeze
-        UHOST = 'Host'.freeze
-
         def host_from_header
           self[LHOST] || self[UHOST]
         end

data/lib/new_relic/agent/http_clients/uri_util.rb

@@ -36,7 +36,7 @@ module NewRelic
               uri = ::URI.parse(url)
             end
           end
-          uri.host&.downcase!
+          uri.host = uri.host&.downcase
           uri
         end
 

data/lib/new_relic/agent/instrumentation/action_controller_other_subscriber.rb

@@ -23,7 +23,7 @@ module NewRelic
 
         def metric_name(name, payload)
           controller_name = controller_name_for_metric(payload)
-          "Ruby/ActionController#{"/#{controller_name}" if controller_name}/#{name.gsub(/\.action_controller/, '')}"
+          "Ruby/ActionController#{"/#{controller_name}" if controller_name}/#{name.gsub('.action_controller', '')}"
         end
 
         def controller_name_for_metric(payload)

data/lib/new_relic/agent/instrumentation/action_dispatch.rb

@@ -16,7 +16,7 @@ DependencyDetection.defer do
       defined?(ActionDispatch) &&
       defined?(ActionPack) &&
       ActionPack.respond_to?(:gem_version) &&
-      ActionPack.gem_version >= Gem::Version.new('6.0.0') && # notifications for dispatch added in Rails 6
+      NewRelic::Helper.version_satisfied?(ActionPack.gem_version, '>=', '6.0.0') && # notifications for dispatch added in Rails 6
       !NewRelic::Agent::Instrumentation::ActionDispatchSubscriber.subscribed?
   end
 

data/lib/new_relic/agent/instrumentation/action_dispatch_subscriber.rb

@@ -45,7 +45,7 @@ module NewRelic
         end
 
         PATTERN = /\A([^\.]+)\.action_dispatch\z/
-        UNKNOWN = 'unknown'.freeze
+        UNKNOWN = NewRelic::UNKNOWN_LOWER
 
         METHOD_NAME_MAPPING = Hash.new do |h, k|
           if PATTERN =~ k

data/lib/new_relic/agent/instrumentation/action_mailbox.rb

@@ -15,7 +15,7 @@ DependencyDetection.defer do
     defined?(ActiveSupport) &&
       defined?(ActionMailbox) &&
       ActionMailbox.respond_to?(:gem_version) && # 'require "action_mailbox"' doesn't require version...
-      ActionMailbox.gem_version >= Gem::Version.new('7.1.0.alpha') && # notifications added in Rails 7.1
+      NewRelic::Helper.version_satisfied?(ActionMailbox.gem_version, '>=', '7.1.0.alpha') && # notifications added in Rails 7.1
       !NewRelic::Agent::Instrumentation::ActionMailboxSubscriber.subscribed?
   end
 

data/lib/new_relic/agent/instrumentation/action_mailer.rb

@@ -15,7 +15,7 @@ DependencyDetection.defer do
     defined?(ActiveSupport) &&
       defined?(ActionMailer) &&
       ActionMailer.respond_to?(:gem_version) &&
-      ActionMailer.gem_version >= Gem::Version.new('5.0') &&
+      NewRelic::Helper.version_satisfied?(ActionMailer.gem_version, '>=', '5.0') &&
       !NewRelic::Agent::Instrumentation::ActionMailerSubscriber.subscribed?
   end
 

data/lib/new_relic/agent/instrumentation/active_job.rb

@@ -30,7 +30,7 @@ DependencyDetection.defer do
   executes do
     if defined?(ActiveSupport) &&
         ActiveJob.respond_to?(:gem_version) &&
-        ActiveJob.gem_version >= Gem::Version.new('6.0.0') &&
+        NewRelic::Helper.version_satisfied?(ActiveJob.gem_version, '>=', '6.0.0') &&
         !NewRelic::Agent.config[:disable_activejob] &&
         !NewRelic::Agent::Instrumentation::ActiveJobSubscriber.subscribed?
       NewRelic::Agent.logger.info('Installing notifications based ActiveJob instrumentation')

data/lib/new_relic/agent/instrumentation/active_job_subscriber.rb

@@ -8,7 +8,7 @@ module NewRelic
   module Agent
     module Instrumentation
       class ActiveJobSubscriber < NotificationsSubscriber
-        PAYLOAD_KEYS = %i[adapter db_runtime error job wait]
+        PAYLOAD_KEYS = %i[adapter db_runtime error job wait jobs]
 
         def add_segment_params(segment, payload)
           PAYLOAD_KEYS.each do |key|
@@ -16,8 +16,12 @@ module NewRelic
           end
         end
 
+        # NOTE: For `enqueue_all.active_job`, only the first job is used to determine the queue.
+        # Therefore, this assumes all jobs given as arguments for perform_all_later share the same queue.
         def metric_name(name, payload)
-          queue = payload[:job].queue_name
+          job = payload[:job] || payload[:jobs].first
+
+          queue = job.queue_name
           method = method_from_name(name)
           "Ruby/ActiveJob/#{queue}/#{method}"
         end

data/lib/new_relic/agent/instrumentation/active_merchant.rb

@@ -27,25 +27,12 @@ DependencyDetection.defer do
         actions = [:authorize, :purchase, :credit, :void, :capture, :recurring, :store, :unstore, :update]
         actions.each do |operation|
           if implemented_methods.include?(operation)
-            add_method_tracer operation, [-> (*) { "ActiveMerchant/gateway/#{gateway_name}/#{operation}" },
-              -> (*) { "ActiveMerchant/gateway/#{gateway_name}" },
-              -> (*) { "ActiveMerchant/operation/#{operation}" }]
+            add_method_tracer operation, [->(*) { "ActiveMerchant/gateway/#{gateway_name}/#{operation}" },
+              ->(*) { "ActiveMerchant/gateway/#{gateway_name}" },
+              ->(*) { "ActiveMerchant/operation/#{operation}" }]
           end
         end
       end
     end
   end
-
-  executes do
-    next unless Gem::Version.new(ActiveMerchant::VERSION) < Gem::Version.new('1.65.0')
-
-    deprecation_msg = 'The Ruby Agent is dropping support for ActiveMerchant versions below 1.65.0 ' \
-      'in version 9.0.0. Please upgrade your ActiveMerchant version to continue receiving full support. ' \
-
-    NewRelic::Agent.logger.log_once(
-      :warn,
-      :deprecated_active_merchant_version,
-      deprecation_msg
-    )
-  end
 end