def stop_agent_service(self, quiet):
"""Stops the agent service using the platform-specific method.
This method must return only after the agent service has terminated.
@param quiet: True if only error messages should be printed to stdout, stderr.
@type quiet: bool
"""
try:
if not quiet:
print("Sending control signal to stop agent service.")
win32serviceutil.StopService(_SCALYR_AGENT_SERVICE_)
if not quiet:
print("Agent service has stopped.")
except win32api.error as e:
if e[0] == winerror.ERROR_SERVICE_NOT_ACTIVE:
raise AgentNotRunning(
"The operating system indicates the Scalyr Agent Service is not running."
)
elif e[0] == winerror.ERROR_SERVICE_DOES_NOT_EXIST:
raise AgentNotRunning(
"The operating system indicates the Scalyr Agent Service is not installed. "
"This indicates a failed installation. Try reinstalling the agent."
)
else:
raise e
def is_agent_running(self,
fail_if_running=False,
fail_if_not_running=False):
"""Returns true if the agent service is running, as determined by this platform implementation.
This will optionally raise an Exception with an appropriate error message if the agent is running or not
runnning.
@param fail_if_running: True if the method should raise an Exception with a platform-specific error message
explaining how it determined the agent is running.
@param fail_if_not_running: True if the method should raise an Exception with a platform-specific error message
explaining how it determined the agent is not running.
@type fail_if_running: bool
@type fail_if_not_running: bool
@return: True if the agent process is already running.
@rtype: bool
@raise AgentAlreadyRunning
@raise AgentNotRunning
"""
hscm = None
hs = None
try:
hscm = win32service.OpenSCManager(None, None,
win32service.SC_MANAGER_CONNECT)
hs = win32serviceutil.SmartOpenService(
hscm, _SCALYR_AGENT_SERVICE_,
win32service.SERVICE_QUERY_STATUS)
status = win32service.QueryServiceStatusEx(hs)
state = status["CurrentState"]
is_running = state in (
win32service.SERVICE_RUNNING,
win32service.SERVICE_START_PENDING,
)
if fail_if_running and is_running:
pid = status["ProcessId"]
raise AgentAlreadyRunning(
"The operating system reports the Scalyr Agent Service is running with "
"pid=%d" % pid)
if fail_if_not_running and not is_running:
raise AgentNotRunning(
"The operating system reports the Scalyr Agent Service is not running"
)
return state in (
win32service.SERVICE_RUNNING,
win32service.SERVICE_START_PENDING,
)
finally:
if hs is not None:
win32service.CloseServiceHandle(hs)
if hscm is not None:
win32service.CloseServiceHandle(hscm)
def is_agent_running(self,
fail_if_running=False,
fail_if_not_running=False):
"""Returns true if the agent service is running, as determined by the pidfile.
This will optionally raise an Exception with an appropriate error message if the agent is not running.
@param fail_if_running: True if the method should raise an Exception with a message about where the pidfile
was read from.
@param fail_if_not_running: True if the method should raise an Exception with a message about where the pidfile
was read from.
@type fail_if_running: bool
@type fail_if_not_running: bool
@return: True if the agent process is already running.
@rtype: bool
@raise AgentAlreadyRunning
@raise AgentNotRunning
"""
pid = self.__read_pidfile()
if fail_if_running and pid is not None:
raise AgentAlreadyRunning(
'The pidfile %s exists and indicates it is running pid=%d' %
(self.__pidfile, pid))
if fail_if_not_running and pid is None:
raise AgentNotRunning(
'The pidfile %s does not exist or listed process is not running.'
% self.__pidfile)
return pid is not None
def request_agent_status(self):
"""Invoked by a process that is not the agent to request the current agent dump the current detail
status to the status file.
This is used to implement the 'scalyr-agent-2 status -v' feature.
@return: If there is an error, an errno that describes the error. errno.EPERM indicates the current does not
have permission to request the status. errno.ESRCH indicates the agent is not running.
"""
try:
win32serviceutil.ControlService(_SCALYR_AGENT_SERVICE_,
_SERVICE_CONTROL_DETAILED_REPORT_)
except win32api.error as e:
if e[0] == winerror.ERROR_SERVICE_NOT_ACTIVE:
return errno.ESRCH
elif e[0] == winerror.ERROR_SERVICE_DOES_NOT_EXIST:
raise AgentNotRunning(
"The operating system indicates the Scalyr Agent Service is not installed. "
"This indicates a failed installation. Try reinstalling the agent."
)
else:
raise e
