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

Class PortProbe

java.lang.Object

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

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

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

All Implemented Interfaces:

MonitorKeys

public class PortProbe
extends DefaultProbe

A probe that checks whether a container has a specified port open. This probe also performs the checks of the DefaultProbe. Additional configurable properties include: port - required port for socket connection timeout - connection timeout (default 1000)

Field Summary

Fields

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

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

Constructor	Description
PortProbe(int port, int timeout, Map<String,String> props)

Method Summary

Modifier and Type	Method	Description
static PortProbe	create(Map<String,String> props)
ProbeStatus	ping(ComponentInstance instance)	Try to connect to the (host,port); a failure to connect within the specified timeout is a failure.

Methods inherited from class org.apache.hadoop.yarn.service.monitor.probe.DefaultProbe

create, isDnsCheckEnabled

Methods inherited from class org.apache.hadoop.yarn.service.monitor.probe.Probe

getName, getProperty, getPropertyBool, getPropertyInt, init, setName, toString

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final org.slf4j.Logger log

Constructor Details

PortProbe

public PortProbe(int port,
 int timeout,
 Map<String,String> props)

Method Details

create

public static PortProbe create(Map<String,String> props)
                        throws IOException

Throws:

IOException

ping

public ProbeStatus ping(ComponentInstance instance)

Try to connect to the (host,port); a failure to connect within the specified timeout is a failure.

Overrides:

ping in class DefaultProbe

Parameters:

instance - role instance

Returns:

the outcome