org.apache.slider.server.servicemonitor

Class ReportingLoop

java.lang.Object

org.apache.slider.server.servicemonitor.ReportingLoop

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, MonitorKeys, ProbeReportHandler

public final class ReportingLoop
extends Object
implements Runnable, ProbeReportHandler, MonitorKeys, Closeable

This is the monitor service

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Fields inherited from interface org.apache.slider.server.servicemonitor.MonitorKeys

BOOTSTRAP_TIMEOUT_DEFAULT, DEFAULT_PROBE_HOST, DEFAULT_PROBE_PORT, JT_PROBE_BOOTSTRAP_TIMEOUT, JT_PROBE_BOOTSTRAP_TIMEOUT_DEFAULT, JT_PROBE_ENABLED, LS_PROBE_BOOTSTRAP_TIMEOUT, LS_PROBE_BOOTSTRAP_TIMEOUT_DEFAULT, LS_PROBE_DEFAULT, LS_PROBE_ENABLED, LS_PROBE_PATH, MONITOR_BOOTSTRAP_TIMEOUT, MONITOR_DEPENDENCY_DFSLIVE, MONITOR_KEY_PREFIX, MONITOR_PROBE_INTERVAL, MONITOR_PROBE_TIMEOUT, MONITOR_REPORT_INTERVAL, MONITOR_REPORTER, PID_PROBE_ENABLED, PID_PROBE_PIDFILE, PORT_PROBE_BOOTSTRAP_TIMEOUT, PORT_PROBE_BOOTSTRAP_TIMEOUT_DEFAULT, PORT_PROBE_CONNECT_TIMEOUT, PORT_PROBE_CONNECT_TIMEOUT_DEFAULT, PORT_PROBE_ENABLED, PORT_PROBE_HOST, PORT_PROBE_PORT, PROBE_INTERVAL_DEFAULT, PROBE_TIMEOUT_DEFAULT, REPORT_INTERVAL_DEFAULT, WEB_PROBE_BOOTSTRAP_TIMEOUT, WEB_PROBE_BOOTSTRAP_TIMEOUT_DEFAULT, WEB_PROBE_CONNECT_TIMEOUT, WEB_PROBE_DEFAULT_CODE, WEB_PROBE_DEFAULT_URL, WEB_PROBE_ENABLED, WEB_PROBE_MAX, WEB_PROBE_MIN, WEB_PROBE_URL

Constructor Summary

Constructors

Constructor and Description
ReportingLoop(String name, ProbeReportHandler reporter, List<Probe> probes, List<Probe> dependencyProbes, int probeInterval, int reportInterval, int probeTimeout, int bootstrapTimeout)
ReportingLoop(String name, ProbeReportHandler reporter, ProbeWorker worker, int reportInterval, int probeTimeout) Create a new reporting loop -and bond the worker's ProbeReportHandler to us

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This exits the process cleanly
boolean	commence(String n, String description)
int	getBootstrapTimeout()
void	heartbeat(ProbeStatus status) A heartbeat event should be raised
void	liveProbeCycleCompleted() Event to say that the live probe cycle completed so the entire system can be considered functional.
void	probeBooted(ProbeStatus status) A probe has just booted
void	probeFailure(ProbeFailedException exception) A probe has failed
void	probeProcessStateChange(ProbePhase probePhase) The probe process has changed state.
void	probeResult(ProbePhase phase, ProbeStatus status) Report a probe outcome
void	probeTimedOut(ProbePhase currentPhase, Probe probe, ProbeStatus lastStatus, long currentTime) A probe has timed out
void	run() This can be run in a separate thread, or it can be run directly from the caller.
boolean	startReporting() Start the monitoring.
void	unregister()
ReportingLoop	withReporter(ProbeReportHandler reporter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

ReportingLoop

public ReportingLoop(String name,
             ProbeReportHandler reporter,
             List<Probe> probes,
             List<Probe> dependencyProbes,
             int probeInterval,
             int reportInterval,
             int probeTimeout,
             int bootstrapTimeout)
              throws IOException

Throws:

IOException

ReportingLoop

public ReportingLoop(String name,
             ProbeReportHandler reporter,
             ProbeWorker worker,
             int reportInterval,
             int probeTimeout)
              throws IOException

Create a new reporting loop -and bond the worker's ProbeReportHandler to us

Parameters:

name -

reporter -

worker -

reportInterval -

probeTimeout -

Throws:

IOException

Method Detail

getBootstrapTimeout

public int getBootstrapTimeout()

withReporter

public ReportingLoop withReporter(ProbeReportHandler reporter)

startReporting

public boolean startReporting()

Start the monitoring.

Returns:

false if the monitoring did not start and that the worker threads should be run up.

close

public void close()

This exits the process cleanly

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

probeFailure

public void probeFailure(ProbeFailedException exception)

Description copied from interface: ProbeReportHandler

A probe has failed

Specified by:

probeFailure in interface ProbeReportHandler

probeProcessStateChange

public void probeProcessStateChange(ProbePhase probePhase)

Description copied from interface: ProbeReportHandler

The probe process has changed state.

Specified by:

probeProcessStateChange in interface ProbeReportHandler

Parameters:

probePhase - the new process phrase

probeBooted

public void probeBooted(ProbeStatus status)

Description copied from interface: ProbeReportHandler

A probe has just booted

Specified by:

probeBooted in interface ProbeReportHandler

Parameters:

status - probe status

probeResult

public void probeResult(ProbePhase phase,
               ProbeStatus status)

Description copied from interface: ProbeReportHandler

Report a probe outcome

Specified by:

probeResult in interface ProbeReportHandler

Parameters:

phase - the current phase of probing

status - the probe status

commence

public boolean commence(String n,
               String description)

Specified by:

commence in interface ProbeReportHandler

unregister

public void unregister()

Specified by:

unregister in interface ProbeReportHandler

heartbeat

public void heartbeat(ProbeStatus status)

Description copied from interface: ProbeReportHandler

A heartbeat event should be raised

Specified by:

heartbeat in interface ProbeReportHandler

Parameters:

status - the probe status

probeTimedOut

public void probeTimedOut(ProbePhase currentPhase,
                 Probe probe,
                 ProbeStatus lastStatus,
                 long currentTime)

Description copied from interface: ProbeReportHandler

A probe has timed out

Specified by:

probeTimedOut in interface ProbeReportHandler

Parameters:

currentPhase - the current execution phase

probe - the probe that timed out

lastStatus - the last status that was successfully received -which is implicitly not the status of the timed out probe

currentTime - the current time

liveProbeCycleCompleted

public void liveProbeCycleCompleted()

Description copied from interface: ProbeReportHandler

Event to say that the live probe cycle completed so the entire system can be considered functional.

Specified by:

liveProbeCycleCompleted in interface ProbeReportHandler

run

public void run()

This can be run in a separate thread, or it can be run directly from the caller. Test runs do the latter, HAM runs multiple reporting threads.

Specified by:

run in interface Runnable