org.apache.flink.runtime.webmonitor

类 WebMonitorEndpoint<T extends RestfulGateway>

java.lang.Object

org.apache.flink.runtime.rest.RestServerEndpoint

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

类型参数:

T - type of the leader gateway

所有已实现的接口:

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

直接已知子类:

DispatcherRestEndpoint, MiniDispatcherRestEndpoint

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

Rest endpoint which serves the web frontend REST calls.

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.runtime.rest.RestServerEndpoint

RestServerEndpoint.RestHandlerUrlComparator

字段概要

字段

限定符和类型	字段和说明
protected org.apache.flink.configuration.Configuration	clusterConfiguration
protected ScheduledExecutorService	executor
protected GatewayRetriever<? extends T>	leaderRetriever
protected RestHandlerConfiguration	restConfiguration

从类继承的字段 org.apache.flink.runtime.rest.RestServerEndpoint

log, responseHeaders, uploadDir

构造器概要

构造器

构造器和说明

WebMonitorEndpoint(GatewayRetriever<? extends T> leaderRetriever, org.apache.flink.configuration.Configuration clusterConfiguration, RestHandlerConfiguration restConfiguration, GatewayRetriever<ResourceManagerGateway> resourceManagerRetriever, TransientBlobService transientBlobService, ScheduledExecutorService executor, MetricFetcher metricFetcher, LeaderElectionService leaderElectionService, ExecutionGraphCache executionGraphCache, org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler)

方法概要

限定符和类型	方法和说明
Collection<ArchivedJson>	archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo) Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
static ScheduledExecutorService	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.
protected Collection<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	initializeWebSubmissionHandlers(CompletableFuture<String> localAddressFuture)
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.

从类继承的方法 org.apache.flink.runtime.rest.RestServerEndpoint

closeAsync, getRestBaseUrl, getRestPort, getServerAddress, start

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.util.AutoCloseableAsync

close

字段详细资料

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 ScheduledExecutorService executor

构造器详细资料

WebMonitorEndpoint

public WebMonitorEndpoint(GatewayRetriever<? extends T> leaderRetriever,
                          org.apache.flink.configuration.Configuration clusterConfiguration,
                          RestHandlerConfiguration restConfiguration,
                          GatewayRetriever<ResourceManagerGateway> resourceManagerRetriever,
                          TransientBlobService transientBlobService,
                          ScheduledExecutorService executor,
                          MetricFetcher metricFetcher,
                          LeaderElectionService leaderElectionService,
                          ExecutionGraphCache executionGraphCache,
                          org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler)
                   throws IOException,
                          org.apache.flink.util.ConfigurationException

抛出:

IOException

org.apache.flink.util.ConfigurationException

方法详细资料

initializeHandlers

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

从类复制的说明: RestServerEndpoint

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

指定者:

initializeHandlers 在类中 RestServerEndpoint

参数:

localAddressFuture - future rest address of the RestServerEndpoint

返回:

Collection of AbstractRestHandler which are added to the server endpoint

initializeWebSubmissionHandlers

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

startInternal

public void startInternal()
                   throws Exception

从类复制的说明: RestServerEndpoint

Hook to start sub class specific services.

指定者:

startInternal 在类中 RestServerEndpoint

抛出:

Exception - if an error occurred

shutDownInternal

protected CompletableFuture<Void> shutDownInternal()

从类复制的说明: RestServerEndpoint

Stops this REST server endpoint.

覆盖:

shutDownInternal 在类中 RestServerEndpoint

返回:

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

grantLeadership

public void grantLeadership(UUID leaderSessionID)

从接口复制的说明: 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.

指定者:

grantLeadership 在接口中 LeaderContender

参数:

leaderSessionID - New leader session ID

revokeLeadership

public void revokeLeadership()

从接口复制的说明: 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.

指定者:

revokeLeadership 在接口中 LeaderContender

getDescription

public String getDescription()

从接口复制的说明: LeaderContender

Returns the description of the LeaderContender for logging purposes.

指定者:

getDescription 在接口中 LeaderContender

返回:

Description of this contender.

handleError

public void handleError(Exception exception)

从接口复制的说明: LeaderContender

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

指定者:

handleError 在接口中 LeaderContender

参数:

exception - Caught exception

archiveJsonWithPath

public Collection<ArchivedJson> archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo)
                                             throws IOException

从接口复制的说明: 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.

指定者:

archiveJsonWithPath 在接口中 JsonArchivist

参数:

executionGraphInfo - AccessExecutionGraph-related information for which the responses should be generated

返回:

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

抛出:

IOException - thrown if the JSON generation fails

createExecutorService

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