Package org.apache.hadoop.yarn.service.monitor.probe

Class Probe

java.lang.Object

org.apache.hadoop.yarn.service.monitor.probe.Probe

All Implemented Interfaces:

MonitorKeys

Direct Known Subclasses:

DefaultProbe

public abstract class Probe
extends Object
implements MonitorKeys

Base class of all probes.

Field Summary

Fields inherited from interface org.apache.hadoop.yarn.service.monitor.probe.MonitorKeys

DEFAULT_PROBE_DNS_ADDRESS, DEFAULT_PROBE_DNS_CHECK_ENABLED, DEFAULT_PROBE_DNS_CHECK_ENABLED_DEFAULT, PORT_PROBE_CONNECT_TIMEOUT, PORT_PROBE_CONNECT_TIMEOUT_DEFAULT, PORT_PROBE_PORT, WEB_PROBE_CONNECT_TIMEOUT, WEB_PROBE_CONNECT_TIMEOUT_DEFAULT, WEB_PROBE_MAX_SUCCESS, WEB_PROBE_MAX_SUCCESS_DEFAULT, WEB_PROBE_MIN_SUCCESS, WEB_PROBE_MIN_SUCCESS_DEFAULT, WEB_PROBE_URL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Probe()
	Probe(String name)	Create a probe of a specific name

Method Summary

Modifier and Type	Method	Description
String	getName()
static String	getProperty(Map<String,String> props, String name, String defaultValue)
static boolean	getPropertyBool(Map<String,String> props, String name, boolean defaultValue)
static int	getPropertyInt(Map<String,String> props, String name, Integer defaultValue)
void	init()	perform any prelaunch initialization
abstract ProbeStatus	ping(ComponentInstance instance)	Ping the endpoint.
protected void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Probe

protected Probe()

Probe

public Probe(String name)

Create a probe of a specific name

Parameters:

name - probe name

Method Details

setName

protected void setName(String name)

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Object

getProperty

public static String getProperty(Map<String,String> props,
 String name,
 String defaultValue)
                          throws IOException

Throws:

IOException

getPropertyInt

public static int getPropertyInt(Map<String,String> props,
 String name,
 Integer defaultValue)
                          throws IOException

Throws:

IOException

getPropertyBool

public static boolean getPropertyBool(Map<String,String> props,
 String name,
 boolean defaultValue)

init

public void init()
          throws IOException

perform any prelaunch initialization

Throws:

IOException

ping

public abstract ProbeStatus ping(ComponentInstance instance)

Ping the endpoint. All exceptions must be caught and included in the (failure) status.

Parameters:

instance - instance to ping

Returns:

the status