Module: NewRelic::Agent::Agent::InstanceMethods::StartWorkerThread

Included in:
NewRelic::Agent::Agent::InstanceMethods
Defined in:
lib/new_relic/agent/agent.rb

Overview

All of this module used to be contained in the start_worker_thread method - this is an artifact of refactoring and can be moved, renamed, etc at will

Instance Method Summary collapse

Instance Method Details

#catch_errors ⇒ Object

a wrapper method to handle all the errors that can happen in the connection and worker thread system. This guarantees a no-throw from the background thread.



566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/new_relic/agent/agent.rb', line 566

def catch_errors
  yield
rescue NewRelic::Agent::ForceRestartException => e
  handle_force_restart(e)
  retry
rescue NewRelic::Agent::ForceDisconnectException => e
  handle_force_disconnect(e)
rescue NewRelic::Agent::ServerConnectionException => e
  handle_server_connection_problem(e)
rescue => e
  handle_other_error(e)
end

#create_and_run_worker_loop ⇒ Object

Creates the worker loop and loads it with the instructions it should run every @report_period seconds



522
523
524
525
526
527
 
# File 'lib/new_relic/agent/agent.rb', line 522

def create_and_run_worker_loop
  @worker_loop = WorkerLoop.new
  @worker_loop.run(Agent.config[:data_report_period]) do
    transmit_data
  end
end

#deferred_work!(connection_options) ⇒ Object

This is the method that is run in a new thread in order to background the harvesting and sending of data during the normal operation of the agent.

Takes connection options that determine how we should connect to the server, and loops endlessly - typically we never return from this method unless we’re shutting down the agent



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/new_relic/agent/agent.rb', line 587

def deferred_work!(connection_options)
  catch_errors do
    NewRelic::Agent.disable_all_tracing do
      # We try to connect.  If this returns false that means
      # the server rejected us for a licensing reason and we should
      # just exit the thread.  If it returns nil
      # that means it didn't try to connect because we're in the master.
      connect(connection_options)
      if connected?
        log_worker_loop_start
        create_and_run_worker_loop
        # never reaches here unless there is a problem or
        # the agent is exiting
      else
        ::NewRelic::Agent.logger.debug "No connection.  Worker thread ending."
      end
    end
  end
end

#handle_force_disconnect(error) ⇒ Object

when a disconnect is requested, stop the current thread, which is the worker thread that gathers data and talks to the server.



543
544
545
546
 
# File 'lib/new_relic/agent/agent.rb', line 543

def handle_force_disconnect(error)
  ::NewRelic::Agent.logger.warn "New Relic forced this agent to disconnect (#{error.message})"
  disconnect
end

#handle_force_restart(error) ⇒ Object

Handles the case where the server tells us to restart - this clears the data, clears connection attempts, and waits a while to reconnect.



532
533
534
535
536
537
538
 
# File 'lib/new_relic/agent/agent.rb', line 532

def handle_force_restart(error)
  ::NewRelic::Agent.logger.debug error.message
  reset_stats
  @service.reset_metric_id_cache if @service
  @connect_state = :pending
  sleep 30
end

#handle_other_error(error) ⇒ Object

Handles an unknown error in the worker thread by logging it and disconnecting the agent, since we are now in an unknown state



558
559
560
561
 
# File 'lib/new_relic/agent/agent.rb', line 558

def handle_other_error(error)
  ::NewRelic::Agent.logger.error "Terminating worker loop.", error
  disconnect
end

#handle_server_connection_problem(error) ⇒ Object

there is a problem with connecting to the server, so we stop trying to connect and shut down the agent



550
551
552
553
 
# File 'lib/new_relic/agent/agent.rb', line 550

def handle_server_connection_problem(error)
  ::NewRelic::Agent.logger.error "Unable to establish connection with the server.", error
  disconnect
end

#log_worker_loop_start ⇒ Object

logs info about the worker loop so users can see when the agent actually begins running in the background



515
516
517
518
 
# File 'lib/new_relic/agent/agent.rb', line 515

def log_worker_loop_start
  ::NewRelic::Agent.logger.debug "Reporting performance data every #{Agent.config[:data_report_period]} seconds."
  ::NewRelic::Agent.logger.debug "Running worker loop"
end