org.apache.flink.runtime.webmonitor

Class WebRuntimeMonitor

java.lang.Object

org.apache.flink.runtime.webmonitor.WebRuntimeMonitor

All Implemented Interfaces:

WebMonitor

public class WebRuntimeMonitor
extends Object
implements WebMonitor

The root component of the web runtime monitor. This class starts the web server and creates all request handlers for the REST API.

The web runtime monitor is based in Netty HTTP. It uses the Netty-Router library to route HTTP requests of different paths to different response handlers. In addition, it serves the static files of the web frontend, such as HTML, CSS, or JS files.

Field Summary

Fields

Modifier and Type	Field and Description
static scala.concurrent.duration.FiniteDuration	DEFAULT_REQUEST_TIMEOUT By default, all requests to the JobManager have a timeout of 10 seconds

Constructor Summary

Constructors

Constructor and Description
WebRuntimeMonitor(Configuration config, LeaderRetrievalService leaderRetrievalService, akka.actor.ActorSystem actorSystem)

Method Summary

Modifier and Type	Method and Description
int	getServerPort() Gets the port that the web server actually binds to.
void	start(String jobManagerAkkaUrl) Starts the web monitor.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REQUEST_TIMEOUT

public static final scala.concurrent.duration.FiniteDuration DEFAULT_REQUEST_TIMEOUT

By default, all requests to the JobManager have a timeout of 10 seconds

Constructor Detail

WebRuntimeMonitor

public WebRuntimeMonitor(Configuration config,
                         LeaderRetrievalService leaderRetrievalService,
                         akka.actor.ActorSystem actorSystem)
                  throws IOException,
                         InterruptedException

Throws:

IOException

InterruptedException

Method Detail

start

public void start(String jobManagerAkkaUrl)
           throws Exception

Description copied from interface: WebMonitor

Starts the web monitor.

Specified by:

start in interface WebMonitor

Throws:

Exception - This method may forward exceptions, if it cannot bring up the web monitor.

stop

public void stop()
          throws Exception

Description copied from interface: WebMonitor

Stops the web server.

Specified by:

stop in interface WebMonitor

Throws:

Exception - This method may forward exceptions, if it cannot properly stop the web monitor.

getServerPort

public int getServerPort()

Description copied from interface: WebMonitor

Gets the port that the web server actually binds to. If port 0 was given in the configuration, then a random free port will be picked. This method can be used to determine this port.

Specified by:

getServerPort in interface WebMonitor

Returns:

The port where the web server is listening, or -1, if no server is running.