org.apache.flink.runtime.webmonitor

Class WebMonitorEndpoint<T extends RestfulGateway>

java.lang.Object

org.apache.flink.runtime.rest.RestServerEndpoint

org.apache.flink.runtime.webmonitor.WebMonitorEndpoint<T>

Type Parameters:

T - type of the leader gateway

All Implemented Interfaces:

AutoCloseable, LeaderContender, JsonArchivist, org.apache.flink.util.AutoCloseableAsync

Direct Known Subclasses:

DispatcherRestEndpoint, MiniDispatcherRestEndpoint

public class WebMonitorEndpoint<T extends RestfulGateway>
extends RestServerEndpoint
implements LeaderContender, JsonArchivist

Rest endpoint which serves the web frontend REST calls.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.RestServerEndpoint

RestServerEndpoint.RestHandlerUrlComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.flink.configuration.Configuration	clusterConfiguration
protected ExecutorService	executor
protected GatewayRetriever<? extends T>	leaderRetriever
protected RestHandlerConfiguration	restConfiguration

Fields inherited from class org.apache.flink.runtime.rest.RestServerEndpoint

log, responseHeaders, uploadDir

Constructor Summary

Constructors

Constructor and Description

WebMonitorEndpoint(RestServerEndpointConfiguration endpointConfiguration, GatewayRetriever<? extends T> leaderRetriever, org.apache.flink.configuration.Configuration clusterConfiguration, RestHandlerConfiguration restConfiguration, GatewayRetriever<ResourceManagerGateway> resourceManagerRetriever, TransientBlobService transientBlobService, ExecutorService executor, MetricFetcher metricFetcher, LeaderElectionService leaderElectionService, FatalErrorHandler fatalErrorHandler)

Method Summary

Modifier and Type	Method and Description
Collection<ArchivedJson>	archiveJsonWithPath(AccessExecutionGraph graph) Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
static ExecutorService	createExecutorService(int numThreads, int threadPriority, String componentName)
String	getDescription() Returns the description of the LeaderContender for logging purposes.
void	grantLeadership(UUID leaderSessionID) Callback method which is called by the LeaderElectionService upon selecting this instance as the new leader.
void	handleError(Exception exception) Callback method which is called by LeaderElectionService in case of an error in the service thread.
protected List<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	initializeHandlers(CompletableFuture<String> localAddressFuture) This method is called at the beginning of RestServerEndpoint.start() to setup all handlers that the REST server endpoint implementation requires.
void	revokeLeadership() Callback method which is called by the LeaderElectionService upon revoking the leadership of a former leader.
protected CompletableFuture<Void>	shutDownInternal() Stops this REST server endpoint.
void	startInternal() Hook to start sub class specific services.

Methods inherited from class org.apache.flink.runtime.rest.RestServerEndpoint

closeAsync, getRestBaseUrl, getServerAddress, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Field Detail

leaderRetriever

protected final GatewayRetriever<? extends T extends RestfulGateway> leaderRetriever

clusterConfiguration

protected final org.apache.flink.configuration.Configuration clusterConfiguration

restConfiguration

protected final RestHandlerConfiguration restConfiguration

executor

protected final ExecutorService executor

Constructor Detail

WebMonitorEndpoint

public WebMonitorEndpoint(RestServerEndpointConfiguration endpointConfiguration,
                          GatewayRetriever<? extends T> leaderRetriever,
                          org.apache.flink.configuration.Configuration clusterConfiguration,
                          RestHandlerConfiguration restConfiguration,
                          GatewayRetriever<ResourceManagerGateway> resourceManagerRetriever,
                          TransientBlobService transientBlobService,
                          ExecutorService executor,
                          MetricFetcher metricFetcher,
                          LeaderElectionService leaderElectionService,
                          FatalErrorHandler fatalErrorHandler)
                   throws IOException

Throws:

IOException

Method Detail

initializeHandlers

protected List<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> initializeHandlers(CompletableFuture<String> localAddressFuture)

Description copied from class: RestServerEndpoint

This method is called at the beginning of RestServerEndpoint.start() to setup all handlers that the REST server endpoint implementation requires.

Specified by:

initializeHandlers in class RestServerEndpoint

Parameters:

localAddressFuture - future rest address of the RestServerEndpoint

Returns:

Collection of AbstractRestHandler which are added to the server endpoint

startInternal

public void startInternal()
                   throws Exception

Description copied from class: RestServerEndpoint

Hook to start sub class specific services.

Specified by:

startInternal in class RestServerEndpoint

Throws:

Exception - if an error occurred

shutDownInternal

protected CompletableFuture<Void> shutDownInternal()

Description copied from class: RestServerEndpoint

Stops this REST server endpoint.

Overrides:

shutDownInternal in class RestServerEndpoint

Returns:

Future which is completed once the shut down has been finished.

grantLeadership

public void grantLeadership(UUID leaderSessionID)

Description copied from interface: LeaderContender

Callback method which is called by the LeaderElectionService upon selecting this instance as the new leader. The method is called with the new leader session ID.

Specified by:

grantLeadership in interface LeaderContender

Parameters:

leaderSessionID - New leader session ID

revokeLeadership

public void revokeLeadership()

Description copied from interface: LeaderContender

Callback method which is called by the LeaderElectionService upon revoking the leadership of a former leader. This might happen in case that multiple contenders have been granted leadership.

Specified by:

revokeLeadership in interface LeaderContender

getDescription

public String getDescription()

Description copied from interface: LeaderContender

Returns the description of the LeaderContender for logging purposes.

Specified by:

getDescription in interface LeaderContender

Returns:

Description of this contender.

handleError

public void handleError(Exception exception)

Description copied from interface: LeaderContender

Callback method which is called by LeaderElectionService in case of an error in the service thread.

Specified by:

handleError in interface LeaderContender

Parameters:

exception - Caught exception

archiveJsonWithPath

public Collection<ArchivedJson> archiveJsonWithPath(AccessExecutionGraph graph)
                                             throws IOException

Description copied from interface: JsonArchivist

Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.

The collection should contain one entry for every response that could be generated for the given job, for example one entry for each task. The REST URLs should be unique and must not contain placeholders.

Specified by:

archiveJsonWithPath in interface JsonArchivist

Parameters:

graph - AccessExecutionGraph for which the responses should be generated

Returns:

Collection containing an ArchivedJson for every response that could be generated for the given job

Throws:

IOException - thrown if the JSON generation fails

createExecutorService

public static ExecutorService createExecutorService(int numThreads,
                                                    int threadPriority,
                                                    String componentName)