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

Class HttpProbe

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.HttpProbe

All Implemented Interfaces:

MonitorKeys

public class HttpProbe
extends DefaultProbe

A probe that checks whether a successful HTTP response code can be obtained from a container. A well-formed URL must be provided. The URL is intended to contain a token ${THIS_HOST} that will be replaced by the IP of the container. This probe also performs the checks of the DefaultProbe. Additional configurable properties include: url - required URL for HTTP connection, e.g. http://${THIS_HOST}:8080 timeout - connection timeout (default 1000) min.success - minimum response code considered successful (default 200) max.success - maximum response code considered successful (default 299)

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
HttpProbe(String url, int timeout, int min, int max, Map<String,String> props)

Method Summary

Modifier and Type	Method	Description
static HttpProbe	create(Map<String,String> props)
ProbeStatus	ping(ComponentInstance instance)	Ping the endpoint.

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

HttpProbe

public HttpProbe(String url,
 int timeout,
 int min,
 int max,
 Map<String,String> props)

Method Details

create

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

Throws:

IOException

ping

public ProbeStatus ping(ComponentInstance instance)

Description copied from class: Probe

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

Overrides:

ping in class DefaultProbe

Parameters:

instance - instance to ping

Returns:

the status