newrelic_rpm 8.10.1 → 8.11.0

data/lib/new_relic/agent/agent.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
@@ -60,43 +59,50 @@ module NewRelic
       include NewRelic::Agent::Shutdown
 
       def initialize
+        init_basics
+        init_components
+        init_event_handlers
+        setup_attribute_filter
+      end
+
+      private
+
+      def init_basics
         @started = false
         @event_loop = nil
         @worker_thread = nil
+        @connect_state = :pending
+        @connect_attempts = 0
+        @waited_on_connect = nil
+        @connected_pid = nil
+        @wait_on_connect_mutex = Mutex.new
+        @after_fork_lock = Mutex.new
+        @wait_on_connect_condition = ConditionVariable.new
+      end
 
+      def init_components
         @service = NewRelicService.new
-
         @events = EventListener.new
         @stats_engine = StatsEngine.new
         @transaction_sampler = TransactionSampler.new
         @sql_sampler = SqlSampler.new
-        @agent_command_router = Commands::AgentCommandRouter.new(@events)
-        @monitors = Monitors.new(@events)
-        @error_collector = ErrorCollector.new(@events)
         @transaction_rules = RulesEngine.new
-        @harvest_samplers = SamplerCollection.new(@events)
         @monotonic_gc_profiler = VM::MonotonicGCProfiler.new
-        @javascript_instrumentor = JavascriptInstrumentor.new(@events)
         @adaptive_sampler = AdaptiveSampler.new(Agent.config[:sampling_target],
           Agent.config[:sampling_target_period_in_seconds])
+      end
 
+      def init_event_handlers
+        @agent_command_router = Commands::AgentCommandRouter.new(@events)
+        @monitors = Monitors.new(@events)
+        @error_collector = ErrorCollector.new(@events)
+        @harvest_samplers = SamplerCollection.new(@events)
+        @javascript_instrumentor = JavaScriptInstrumentor.new(@events)
         @harvester = Harvester.new(@events)
-        @after_fork_lock = Mutex.new
-
         @transaction_event_recorder = TransactionEventRecorder.new(@events)
         @custom_event_aggregator = CustomEventAggregator.new(@events)
         @span_event_aggregator = SpanEventAggregator.new(@events)
         @log_event_aggregator = LogEventAggregator.new(@events)
-
-        @connect_state = :pending
-        @connect_attempts = 0
-        @waited_on_connect = nil
-        @connected_pid = nil
-
-        @wait_on_connect_mutex = Mutex.new
-        @wait_on_connect_condition = ConditionVariable.new
-
-        setup_attribute_filter
       end
 
       def setup_attribute_filter
@@ -107,6 +113,8 @@ module NewRelic
         end
       end
 
+      public
+
       def refresh_attribute_filter
         @attribute_filter = AttributeFilter.new(Agent.config)
       end
@@ -154,7 +162,7 @@ module NewRelic
         # collector on connect.  The former are applied during txns,
         # the latter during harvest.
         attr_accessor :transaction_rules
-        # Responsbile for restarting the harvest thread
+        # Responsible for restarting the harvest thread
         attr_reader :harvester
         # GC::Profiler.total_time is not monotonic so we wrap it.
         attr_reader :monotonic_gc_profiler
@@ -182,7 +190,7 @@ module NewRelic
         # It assumes the parent process initialized the agent, but does
         # not assume the agent started.
         #
-        # The call is idempotent, but not re-entrant.
+        # The call is idempotent, but not reentrant.
         #
         # * It clears any metrics carried over from the parent process
         # * Restarts the sampler thread if necessary
@@ -198,17 +206,7 @@ module NewRelic
         #   connection, this tells me to only try it once so this method returns
         #   quickly if there is some kind of latency with the server.
         def after_fork(options = {})
-          needs_restart = false
-          @after_fork_lock.synchronize do
-            needs_restart = @harvester.needs_restart?
-            @harvester.mark_started
-          end
-
-          return if !needs_restart ||
-            !Agent.config[:agent_enabled] ||
-            !Agent.config[:monitor_mode] ||
-            disconnected? ||
-            !control.security_settings_valid?
+          return unless needs_after_fork_work?
 
           ::NewRelic::Agent.logger.debug("Starting the worker thread in #{Process.pid} (parent #{Process.ppid}) after forking.")
 
@@ -222,6 +220,22 @@ module NewRelic
           setup_and_start_agent(options)
         end
 
+        def needs_after_fork_work?
+          needs_restart = false
+          @after_fork_lock.synchronize do
+            needs_restart = @harvester.needs_restart?
+            @harvester.mark_started
+          end
+
+          return false if !needs_restart ||
+            !Agent.config[:agent_enabled] ||
+            !Agent.config[:monitor_mode] ||
+            disconnected? ||
+            !control.security_settings_valid?
+
+          true
+        end
+
         def install_pipe_service(channel_id)
           @service = PipeService.new(channel_id)
           if connected?
@@ -296,12 +310,7 @@ module NewRelic
 
         def flush_pipe_data
           if connected? && @service.is_a?(PipeService)
-            transmit_data
-            transmit_analytic_event_data
-            transmit_custom_event_data
-            transmit_error_event_data
-            transmit_span_event_data
-            transmit_log_event_data
+            transmit_data_types
           end
         end
 
@@ -516,12 +525,7 @@ module NewRelic
         #   forking off from a parent process.
         #
         def connect(options = {})
-          defaults = {
-            :keep_retrying => Agent.config[:keep_retrying],
-            :force_reconnect => Agent.config[:force_reconnect]
-          }
-          opts = defaults.merge(options)
-
+          opts = connect_options(options)
           return unless should_connect?(opts[:force_reconnect])
 
           ::NewRelic::Agent.logger.debug("Connecting Process to New Relic: #$0")
@@ -536,21 +540,32 @@ module NewRelic
         rescue NewRelic::Agent::UnrecoverableAgentException => e
           handle_unrecoverable_agent_error(e)
         rescue StandardError, Timeout::Error, NewRelic::Agent::ServerConnectionException => e
+          retry if retry_from_error?(e, opts)
+        rescue Exception => e
+          ::NewRelic::Agent.logger.error("Exception of unexpected type during Agent#connect():", e)
+
+          raise
+        end
+
+        def connect_options(options)
+          {
+            keep_retrying: Agent.config[:keep_retrying],
+            force_reconnect: Agent.config[:force_reconnect]
+          }.merge(options)
+        end
+
+        def retry_from_error?(e, opts)
           # Allow a killed (aborting) thread to continue exiting during shutdown.
           # See: https://github.com/newrelic/newrelic-ruby-agent/issues/340
           raise if Thread.current.status == 'aborting'
 
           log_error(e)
-          if opts[:keep_retrying]
-            note_connect_failure
-            ::NewRelic::Agent.logger.info("Will re-attempt in #{connect_retry_period} seconds")
-            sleep(connect_retry_period)
-            retry
-          end
-        rescue Exception => e
-          ::NewRelic::Agent.logger.error("Exception of unexpected type during Agent#connect():", e)
+          return false unless opts[:keep_retrying]
 
-          raise
+          note_connect_failure
+          ::NewRelic::Agent.logger.info("Will re-attempt in #{connect_retry_period} seconds")
+          sleep(connect_retry_period)
+          true
         end
 
         # Delegates to the control class to determine the root
@@ -735,13 +750,7 @@ module NewRelic
 
           @events.notify(:before_harvest)
           @service.session do # use http keep-alive
-            harvest_and_send_errors
-            harvest_and_send_error_event_data
-            harvest_and_send_transaction_traces
-            harvest_and_send_slowest_sql
-            harvest_and_send_timeslice_data
-            harvest_and_send_span_event_data
-            harvest_and_send_log_event_data
+            harvest_and_send_data_types
 
             check_for_and_handle_agent_commands
             harvest_and_send_for_agent_commands
@@ -765,19 +774,9 @@ module NewRelic
               @service.request_timeout = 10
 
               @events.notify(:before_shutdown)
-              transmit_data
-              transmit_analytic_event_data
-              transmit_custom_event_data
-              transmit_error_event_data
-              transmit_span_event_data
-              transmit_log_event_data
-
-              if @connected_pid == $$ && !@service.kind_of?(NewRelic::Agent::NewRelicService)
-                ::NewRelic::Agent.logger.debug("Sending New Relic service agent run shutdown message")
-                @service.shutdown
-              else
-                ::NewRelic::Agent.logger.debug("This agent connected from parent process #{@connected_pid}--not sending shutdown")
-              end
+              transmit_data_types
+              shutdown_service
+
               ::NewRelic::Agent.logger.debug("Graceful disconnect complete")
             rescue Timeout::Error, StandardError => e
               ::NewRelic::Agent.logger.debug("Error when disconnecting #{e.class.name}: #{e.message}")
@@ -788,6 +787,34 @@ module NewRelic
         end
       end
 
+      def shutdown_service
+        if @connected_pid == $$ && !@service.kind_of?(NewRelic::Agent::NewRelicService)
+          ::NewRelic::Agent.logger.debug("Sending New Relic service agent run shutdown message")
+          @service.shutdown
+        else
+          ::NewRelic::Agent.logger.debug("This agent connected from parent process #{@connected_pid}--not sending shutdown")
+        end
+      end
+
+      def transmit_data_types
+        transmit_data
+        transmit_analytic_event_data
+        transmit_custom_event_data
+        transmit_error_event_data
+        transmit_span_event_data
+        transmit_log_event_data
+      end
+
+      def harvest_and_send_data_types
+        harvest_and_send_errors
+        harvest_and_send_error_event_data
+        harvest_and_send_transaction_traces
+        harvest_and_send_slowest_sql
+        harvest_and_send_timeslice_data
+        harvest_and_send_span_event_data
+        harvest_and_send_log_event_data
+      end
+
       extend ClassMethods
       include InstanceMethods
     end

data/lib/new_relic/agent/agent_logger.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
@@ -75,7 +74,7 @@ module NewRelic
         # We've seen that often the backtrace on a SystemStackError is bunk
         # so massage the caller instead at a known depth.
         #
-        # Tests keep us honest about minmum method depth our log calls add.
+        # Tests keep us honest about minimum method depth our log calls add.
         return caller.drop(5) if e.is_a?(SystemStackError)
 
         e.backtrace
@@ -86,7 +85,7 @@ module NewRelic
         if block
           return unless @log.send("#{level}?")
 
-          msgs = Array(block.call)
+          msgs = Array(yield)
         end
 
         msgs.flatten.each do |item|
@@ -133,7 +132,7 @@ module NewRelic
       end
 
       def wants_stdout?
-        ::NewRelic::Agent.config[:log_file_path].upcase == "STDOUT"
+        ::NewRelic::Agent.config[:log_file_path].casecmp("STDOUT").zero?
       end
 
       def find_or_create_file_path(path_setting, root)
@@ -165,7 +164,7 @@ module NewRelic
       def set_log_format!
         @hostname = NewRelic::Agent::Hostname.get
         @prefix = wants_stdout? ? '** [NewRelic]' : ''
-        @log.formatter = Proc.new do |severity, timestamp, progname, msg|
+        @log.formatter = proc do |severity, timestamp, progname, msg|
           "#{@prefix}[#{timestamp.strftime("%F %H:%M:%S %z")} #{@hostname} (#{$$})] #{severity} : #{msg}\n"
         end
       end

data/lib/new_relic/agent/attribute_filter.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
@@ -77,19 +76,43 @@ module NewRelic
       attr_reader :rules
 
       def initialize(config)
-        @enabled_destinations = DST_NONE
+        prep_enabled_destinations(config)
+        prep_rules(config)
 
-        @enabled_destinations |= DST_TRANSACTION_TRACER if config[:'transaction_tracer.attributes.enabled']
-        @enabled_destinations |= DST_TRANSACTION_EVENTS if config[:'transaction_events.attributes.enabled']
-        @enabled_destinations |= DST_ERROR_COLLECTOR if config[:'error_collector.attributes.enabled']
-        @enabled_destinations |= DST_BROWSER_MONITORING if config[:'browser_monitoring.attributes.enabled']
-        @enabled_destinations |= DST_SPAN_EVENTS if config[:'span_events.attributes.enabled']
-        @enabled_destinations |= DST_TRANSACTION_SEGMENTS if config[:'transaction_segments.attributes.enabled']
+        # We're ok to cache high security for fast lookup because the attribute
+        # filter is re-generated on any significant config change.
+        @high_security = config[:high_security]
+
+        setup_key_cache
+        cache_prefix_denylist
+      end
 
-        @enabled_destinations = DST_NONE unless config[:'attributes.enabled']
+      def prep_enabled_destinations(config)
+        @enabled_destinations = config[:'attributes.enabled'] ? enabled_destinations_for_attributes(config) : DST_NONE
+      end
+
+      def enabled_destinations_for_attributes(config)
+        destinations = DST_NONE
+        destinations |= DST_TRANSACTION_TRACER if config[:'transaction_tracer.attributes.enabled']
+        destinations |= DST_TRANSACTION_EVENTS if config[:'transaction_events.attributes.enabled']
+        destinations |= DST_ERROR_COLLECTOR if config[:'error_collector.attributes.enabled']
+        destinations |= DST_BROWSER_MONITORING if config[:'browser_monitoring.attributes.enabled']
+        destinations |= DST_SPAN_EVENTS if config[:'span_events.attributes.enabled']
+        destinations |= DST_TRANSACTION_SEGMENTS if config[:'transaction_segments.attributes.enabled']
+        destinations
+      end
 
+      def prep_rules(config)
         @rules = []
+        prep_attributes_exclude_rules(config)
+        prep_capture_params_rules(config)
+        prep_datastore_rules(config)
+        prep_attributes_include_rules(config)
+        build_uri_rule(config[:'attributes.exclude'])
+        @rules.sort!
+      end
 
+      def prep_attributes_exclude_rules(config)
         build_rule(config[:'attributes.exclude'], DST_ALL, false)
         build_rule(config[:'transaction_tracer.attributes.exclude'], DST_TRANSACTION_TRACER, false)
         build_rule(config[:'transaction_events.attributes.exclude'], DST_TRANSACTION_EVENTS, false)
@@ -97,14 +120,20 @@ module NewRelic
         build_rule(config[:'browser_monitoring.attributes.exclude'], DST_BROWSER_MONITORING, false)
         build_rule(config[:'span_events.attributes.exclude'], DST_SPAN_EVENTS, false)
         build_rule(config[:'transaction_segments.attributes.exclude'], DST_TRANSACTION_SEGMENTS, false)
+      end
 
+      def prep_capture_params_rules(config)
         build_rule(['request.parameters.*'], include_destinations_for_capture_params(config[:capture_params]), true)
         build_rule(['job.resque.args.*'], include_destinations_for_capture_params(config[:'resque.capture_params']), true)
         build_rule(['job.sidekiq.args.*'], include_destinations_for_capture_params(config[:'sidekiq.capture_params']), true)
+      end
 
-        build_rule(['host', 'port_path_or_id'], DST_TRANSACTION_SEGMENTS, config[:'datastore_tracer.instance_reporting.enabled'])
+      def prep_datastore_rules(config)
+        build_rule(%w[host port_path_or_id], DST_TRANSACTION_SEGMENTS, config[:'datastore_tracer.instance_reporting.enabled'])
         build_rule(['database_name'], DST_TRANSACTION_SEGMENTS, config[:'datastore_tracer.database_name_reporting.enabled'])
+      end
 
+      def prep_attributes_include_rules(config)
         build_rule(config[:'attributes.include'], DST_ALL, true)
         build_rule(config[:'transaction_tracer.attributes.include'], DST_TRANSACTION_TRACER, true)
         build_rule(config[:'transaction_events.attributes.include'], DST_TRANSACTION_EVENTS, true)
@@ -112,17 +141,6 @@ module NewRelic
         build_rule(config[:'browser_monitoring.attributes.include'], DST_BROWSER_MONITORING, true)
         build_rule(config[:'span_events.attributes.include'], DST_SPAN_EVENTS, true)
         build_rule(config[:'transaction_segments.attributes.include'], DST_TRANSACTION_SEGMENTS, true)
-
-        build_uri_rule(config[:'attributes.exclude'])
-
-        @rules.sort!
-
-        # We're ok to cache high security for fast lookup because the attribute
-        # filter is re-generated on any significant config change.
-        @high_security = config[:high_security]
-
-        setup_key_cache
-        cache_prefix_denylist
       end
 
       # Note the key_cache is a global cache, accessible by multiple threads,

data/lib/new_relic/agent/attribute_processing.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
@@ -19,7 +18,7 @@ module NewRelic
         elsif prefix
           val = Coerce.scalar(object)
           if blk
-            blk.call(prefix, val)
+            yield(prefix, val)
           elsif !val.nil?
             result[prefix] = val
           end
@@ -32,7 +31,7 @@ module NewRelic
       def flatten_and_coerce_hash(hash, prefix, result, &blk)
         if hash.empty?
           if blk
-            blk.call(prefix, EMPTY_HASH_STRING_LITERAL)
+            yield(prefix, EMPTY_HASH_STRING_LITERAL)
           else
             result[prefix] = EMPTY_HASH_STRING_LITERAL
           end
@@ -47,7 +46,7 @@ module NewRelic
       def flatten_and_coerce_array(array, prefix, result, &blk)
         if array.empty?
           if blk
-            blk.call(prefix, EMPTY_ARRAY_STRING_LITERAL)
+            yield(prefix, EMPTY_ARRAY_STRING_LITERAL)
           else
             result[prefix] = EMPTY_ARRAY_STRING_LITERAL
           end

data/lib/new_relic/agent/attributes.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/agent/audit_logger.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
@@ -95,13 +94,13 @@ module NewRelic
       end
 
       def wants_stdout?
-        ::NewRelic::Agent.config[:'audit_log.path'].upcase == "STDOUT"
+        ::NewRelic::Agent.config[:'audit_log.path'].casecmp("STDOUT").zero?
       end
 
       def create_log_formatter
         @hostname = NewRelic::Agent::Hostname.get
         @prefix = wants_stdout? ? '** [NewRelic]' : ''
-        Proc.new do |severity, time, progname, msg|
+        proc do |severity, time, progname, msg|
           "#{@prefix}[#{time} #{@hostname} (#{$$})] : #{msg}\n"
         end
       end

data/lib/new_relic/agent/autostart.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/agent/chained_call.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/agent/commands/agent_command.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/agent/commands/agent_command_router.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
@@ -21,14 +20,14 @@ module NewRelic
         attr_accessor :thread_profiler_session, :backtrace_service
 
         def initialize(event_listener = nil)
-          @handlers = Hash.new { |*| Proc.new { |cmd| self.unrecognized_agent_command(cmd) } }
+          @handlers = Hash.new { |*| proc { |cmd| self.unrecognized_agent_command(cmd) } }
 
           @backtrace_service = Threading::BacktraceService.new(event_listener)
 
           @thread_profiler_session = ThreadProfilerSession.new(@backtrace_service)
 
-          @handlers['start_profiler'] = Proc.new { |cmd| thread_profiler_session.handle_start_command(cmd) }
-          @handlers['stop_profiler'] = Proc.new { |cmd| thread_profiler_session.handle_stop_command(cmd) }
+          @handlers['start_profiler'] = proc { |cmd| thread_profiler_session.handle_start_command(cmd) }
+          @handlers['stop_profiler'] = proc { |cmd| thread_profiler_session.handle_stop_command(cmd) }
 
           if event_listener
             event_listener.subscribe(:before_shutdown, &method(:on_before_shutdown))

data/lib/new_relic/agent/commands/thread_profiler_session.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