class NewRelic::Agent::Commands::AgentCommandRouter

Constants

ERROR_KEY
SUCCESS_RESULT

Attributes

backtrace_service[RW]
handlers[R]
thread_profiler_session[RW]

Public Class Methods

new(event_listener = nil) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 22
def initialize(event_listener = nil)
  @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 { |cmd| thread_profiler_session.handle_start_command(cmd) }
  @handlers['stop_profiler'] = proc { |cmd| thread_profiler_session.handle_stop_command(cmd) }

  # the following statement needs else branch coverage
  if event_listener # rubocop:disable Style/SafeNavigation
    event_listener.subscribe(:before_shutdown, &method(:on_before_shutdown))
  end
end

Public Instance Methods

call_handler_for(agent_command) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 128
def call_handler_for(agent_command)
  handler = select_handler(agent_command)
  handler.call(agent_command)
end
check_for_and_handle_agent_commands() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 42
def check_for_and_handle_agent_commands
  commands = get_agent_commands

  results = invoke_commands(commands)
  new_relic_service.agent_command_results(results) unless results.empty?
end
error(err) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 124
def error(err)
  {ERROR_KEY => err.message}
end
get_agent_commands() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 88
def get_agent_commands
  commands = new_relic_service.get_agent_commands
  NewRelic::Agent.logger.debug("Received get_agent_commands = #{commands.inspect}")
  commands.map { |collector_command| AgentCommand.new(collector_command) }
end
harvest!() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 55
def harvest!
  profiles = []
  profiles += harvest_from_thread_profiler_session
  log_profiles(profiles)
  profiles
end
harvest_from_thread_profiler_session() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 70
def harvest_from_thread_profiler_session
  if self.thread_profiler_session.ready_to_harvest?
    self.thread_profiler_session.stop(true)
    [self.thread_profiler_session.harvest]
  else
    []
  end
end
invoke_command(agent_command) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 107
def invoke_command(agent_command)
  begin
    call_handler_for(agent_command)
    return success
  rescue AgentCommandError => e
    NewRelic::Agent.logger.debug(e)
    error(e)
  end
end
invoke_commands(agent_commands) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 94
def invoke_commands(agent_commands)
  results = {}

  agent_commands.each do |agent_command|
    results[agent_command.id.to_s] = invoke_command(agent_command)
  end

  results
end
log_profiles(profiles) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 79
def log_profiles(profiles)
  if profiles.empty?
    ::NewRelic::Agent.logger.debug('No thread profiles with data found to send.')
  else
    profile_descriptions = profiles.map { |p| p.to_log_description }
    ::NewRelic::Agent.logger.debug("Sending thread profiles [#{profile_descriptions.join(', ')}]")
  end
end
merge!(*args) click to toggle source

We don’t currently support merging thread profiles that failed to send back into the AgentCommandRouter, so we just no-op this method. Same with reset! - we don’t support asynchronous cancellation of a running thread profile currently.

# File lib/new_relic/agent/commands/agent_command_router.rb, line 66
def merge!(*args); end
new_relic_service() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 38
def new_relic_service
  NewRelic::Agent.instance.service
end
on_before_shutdown(*args) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 49
def on_before_shutdown(*args)
  if self.thread_profiler_session.running?
    self.thread_profiler_session.stop(true)
  end
end
reset!() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 68
def reset!; end
select_handler(agent_command) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 133
def select_handler(agent_command)
  @handlers[agent_command.name]
end
success() click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 120
def success
  SUCCESS_RESULT
end
unrecognized_agent_command(agent_command) click to toggle source
# File lib/new_relic/agent/commands/agent_command_router.rb, line 137
def unrecognized_agent_command(agent_command)
  NewRelic::Agent.logger.debug("Unrecognized agent command #{agent_command.inspect}")
end