org.apache.flink.runtime.dispatcher

Class Dispatcher

java.lang.Object

org.apache.flink.runtime.rpc.RpcEndpoint

org.apache.flink.runtime.rpc.FencedRpcEndpoint<F>

org.apache.flink.runtime.rpc.PermanentlyFencedRpcEndpoint<DispatcherId>

org.apache.flink.runtime.dispatcher.Dispatcher

All Implemented Interfaces:

AutoCloseable, DispatcherGateway, FencedRpcGateway<DispatcherId>, RpcGateway, RestfulGateway, AutoCloseableAsync

Direct Known Subclasses:

MiniDispatcher, StandaloneDispatcher

public abstract class Dispatcher
extends PermanentlyFencedRpcEndpoint<DispatcherId>
implements DispatcherGateway

Base class for the Dispatcher component. The Dispatcher component is responsible for receiving job submissions, persisting them, spawning JobManagers to execute the jobs and to recover them in case of a master failure. Furthermore, it knows about the state of the Flink session cluster.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.rpc.RpcEndpoint

RpcEndpoint.MainThreadExecutor

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPATCHER_NAME
protected CompletableFuture<ApplicationStatus>	shutDownFuture

Fields inherited from class org.apache.flink.runtime.rpc.RpcEndpoint

log, rpcServer

Constructor Summary

Constructors

Constructor and Description
Dispatcher(RpcService rpcService, DispatcherId fencingToken, Collection<JobGraph> recoveredJobs, DispatcherBootstrapFactory dispatcherBootstrapFactory, DispatcherServices dispatcherServices)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancelJob(JobID jobId, Time timeout) Cancel the given job.
CompletableFuture<CoordinationResponse>	deliverCoordinationRequestToCoordinator(JobID jobId, OperatorID operatorId, SerializedValue<CoordinationRequest> serializedRequest, Time timeout) Deliver a coordination request to a specified coordinator and return the response.
CompletableFuture<Acknowledge>	disposeSavepoint(String savepointPath, Time timeout) Dispose the given savepoint.
CompletableFuture<Integer>	getBlobServerPort(Time timeout) Returns the port of the blob server.
CompletableFuture<ApplicationStatus>	getShutDownFuture()
protected org.apache.flink.runtime.dispatcher.Dispatcher.CleanupJobState	jobNotFinished(JobID jobId)
protected org.apache.flink.runtime.dispatcher.Dispatcher.CleanupJobState	jobReachedGloballyTerminalState(ArchivedExecutionGraph archivedExecutionGraph)
CompletableFuture<Collection<JobID>>	listJobs(Time timeout) List the current set of submitted jobs.
protected void	onFatalError(Throwable throwable)
CompletableFuture<Void>	onRemovedJobGraph(JobID jobId)
void	onStart() User overridable callback which is called from RpcEndpoint.internalCallOnStart().
CompletableFuture<Void>	onStop() User overridable callback which is called from RpcEndpoint.internalCallOnStop().
CompletableFuture<ClusterOverview>	requestClusterOverview(Time timeout) Requests the cluster status overview.
CompletableFuture<ArchivedExecutionGraph>	requestJob(JobID jobId, Time timeout) Requests the ArchivedExecutionGraph for the given jobId.
CompletableFuture<JobResult>	requestJobResult(JobID jobId, Time timeout) Requests the JobResult of a job specified by the given jobId.
CompletableFuture<JobStatus>	requestJobStatus(JobID jobId, Time timeout) Request the JobStatus of the given job.
CompletableFuture<Collection<String>>	requestMetricQueryServiceAddresses(Time timeout) Requests the addresses of the MetricQueryService to query.
CompletableFuture<MultipleJobsDetails>	requestMultipleJobDetails(Time timeout) Requests job details currently being executed on the Flink cluster.
CompletableFuture<OperatorBackPressureStatsResponse>	requestOperatorBackPressureStats(JobID jobId, JobVertexID jobVertexId) Requests the statistics on operator back pressure.
CompletableFuture<Collection<Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServiceAddresses(Time timeout) Requests the addresses for the TaskManagers' MetricQueryService to query.
CompletableFuture<Acknowledge>	shutDownCluster()
CompletableFuture<Acknowledge>	shutDownCluster(ApplicationStatus applicationStatus)
CompletableFuture<String>	stopWithSavepoint(JobID jobId, String targetDirectory, boolean terminate, Time timeout) Stops the job with a savepoint.
CompletableFuture<Acknowledge>	submitJob(JobGraph jobGraph, Time timeout) Submit a job to the dispatcher.
CompletableFuture<String>	triggerSavepoint(JobID jobId, String targetDirectory, boolean cancelJob, Time timeout) Triggers a savepoint with the given savepoint directory as a target.

Methods inherited from class org.apache.flink.runtime.rpc.PermanentlyFencedRpcEndpoint

setFencingToken

Methods inherited from class org.apache.flink.runtime.rpc.FencedRpcEndpoint

callAsyncWithoutFencing, getFencingToken, getMainThreadExecutor, getUnfencedMainThreadExecutor, runAsyncWithoutFencing

Methods inherited from class org.apache.flink.runtime.rpc.RpcEndpoint

callAsync, closeAsync, getAddress, getEndpointId, getHostname, getRpcService, getSelfGateway, getTerminationFuture, internalCallOnStart, internalCallOnStop, isRunning, runAsync, scheduleRunAsync, scheduleRunAsync, start, stop, validateRunsInMainThread

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.runtime.rpc.FencedRpcGateway

getFencingToken

Methods inherited from interface org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

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

close

Field Detail

DISPATCHER_NAME

public static final String DISPATCHER_NAME

See Also:

Constant Field Values

shutDownFuture

protected final CompletableFuture<ApplicationStatus> shutDownFuture

Constructor Detail

Dispatcher

public Dispatcher(RpcService rpcService,
                  DispatcherId fencingToken,
                  Collection<JobGraph> recoveredJobs,
                  DispatcherBootstrapFactory dispatcherBootstrapFactory,
                  DispatcherServices dispatcherServices)
           throws Exception

Throws:

Exception

Method Detail

getShutDownFuture

public CompletableFuture<ApplicationStatus> getShutDownFuture()

onStart

public void onStart()
             throws Exception

Description copied from class: RpcEndpoint

User overridable callback which is called from RpcEndpoint.internalCallOnStart().

This method is called when the RpcEndpoint is being started. The method is guaranteed to be executed in the main thread context and can be used to start the rpc endpoint in the context of the rpc endpoint's main thread.

IMPORTANT: This method should never be called directly by the user.

Overrides:

onStart in class RpcEndpoint

Throws:

Exception - indicating that the rpc endpoint could not be started. If an exception occurs, then the rpc endpoint will automatically terminate.

onStop

public CompletableFuture<Void> onStop()

Description copied from class: RpcEndpoint

User overridable callback which is called from RpcEndpoint.internalCallOnStop().

This method is called when the RpcEndpoint is being shut down. The method is guaranteed to be executed in the main thread context and can be used to clean up internal state.

IMPORTANT: This method should never be called directly by the user.

Overrides:

onStop in class RpcEndpoint

Returns:

Future which is completed once all post stop actions are completed. If an error occurs this future is completed exceptionally

submitJob

public CompletableFuture<Acknowledge> submitJob(JobGraph jobGraph,
                                                Time timeout)

Description copied from interface: DispatcherGateway

Submit a job to the dispatcher.

Specified by:

submitJob in interface DispatcherGateway

Parameters:

jobGraph - JobGraph to submit

timeout - RPC timeout

Returns:

A future acknowledge if the submission succeeded

listJobs

public CompletableFuture<Collection<JobID>> listJobs(Time timeout)

Description copied from interface: DispatcherGateway

List the current set of submitted jobs.

Specified by:

listJobs in interface DispatcherGateway

Parameters:

timeout - RPC timeout

Returns:

A future collection of currently submitted jobs

disposeSavepoint

public CompletableFuture<Acknowledge> disposeSavepoint(String savepointPath,
                                                       Time timeout)

Description copied from interface: RestfulGateway

Dispose the given savepoint.

Specified by:

disposeSavepoint in interface RestfulGateway

Parameters:

savepointPath - identifying the savepoint to dispose

timeout - RPC timeout

Returns:

A future acknowledge if the disposal succeeded

cancelJob

public CompletableFuture<Acknowledge> cancelJob(JobID jobId,
                                                Time timeout)

Description copied from interface: RestfulGateway

Cancel the given job.

Specified by:

cancelJob in interface RestfulGateway

Parameters:

jobId - identifying the job to cancel

timeout - of the operation

Returns:

A future acknowledge if the cancellation succeeded

requestClusterOverview

public CompletableFuture<ClusterOverview> requestClusterOverview(Time timeout)

Description copied from interface: RestfulGateway

Requests the cluster status overview.

Specified by:

requestClusterOverview in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the status overview

requestMultipleJobDetails

public CompletableFuture<MultipleJobsDetails> requestMultipleJobDetails(Time timeout)

Description copied from interface: RestfulGateway

Requests job details currently being executed on the Flink cluster.

Specified by:

requestMultipleJobDetails in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the job details

requestJobStatus

public CompletableFuture<JobStatus> requestJobStatus(JobID jobId,
                                                     Time timeout)

Description copied from interface: RestfulGateway

Request the JobStatus of the given job.

Specified by:

requestJobStatus in interface RestfulGateway

Parameters:

jobId - identifying the job for which to retrieve the JobStatus

timeout - for the asynchronous operation

Returns:

A future to the JobStatus of the given job

requestOperatorBackPressureStats

public CompletableFuture<OperatorBackPressureStatsResponse> requestOperatorBackPressureStats(JobID jobId,
                                                                                             JobVertexID jobVertexId)

Description copied from interface: RestfulGateway

Requests the statistics on operator back pressure.

Specified by:

requestOperatorBackPressureStats in interface RestfulGateway

Parameters:

jobId - Job for which the stats are requested.

jobVertexId - JobVertex for which the stats are requested.

Returns:

A Future to the OperatorBackPressureStatsResponse.

requestJob

public CompletableFuture<ArchivedExecutionGraph> requestJob(JobID jobId,
                                                            Time timeout)

Description copied from interface: DispatcherGateway

Requests the ArchivedExecutionGraph for the given jobId. If there is no such graph, then the future is completed with a FlinkJobNotFoundException.

Note: We enforce that the returned future contains a ArchivedExecutionGraph unlike the super interface.

Specified by:

requestJob in interface DispatcherGateway

Specified by:

requestJob in interface RestfulGateway

Parameters:

jobId - identifying the job whose AccessExecutionGraph is requested

timeout - for the asynchronous operation

Returns:

Future containing the AccessExecutionGraph for the given jobId, otherwise FlinkJobNotFoundException

requestJobResult

public CompletableFuture<JobResult> requestJobResult(JobID jobId,
                                                     Time timeout)

Description copied from interface: RestfulGateway

Requests the JobResult of a job specified by the given jobId.

Specified by:

requestJobResult in interface RestfulGateway

Parameters:

jobId - identifying the job for which to retrieve the JobResult.

timeout - for the asynchronous operation

Returns:

Future which is completed with the job's JobResult once the job has finished

requestMetricQueryServiceAddresses

public CompletableFuture<Collection<String>> requestMetricQueryServiceAddresses(Time timeout)

Description copied from interface: RestfulGateway

Requests the addresses of the MetricQueryService to query.

Specified by:

requestMetricQueryServiceAddresses in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of metric query service addresses to query

requestTaskManagerMetricQueryServiceAddresses

public CompletableFuture<Collection<Tuple2<ResourceID,String>>> requestTaskManagerMetricQueryServiceAddresses(Time timeout)

Description copied from interface: RestfulGateway

Requests the addresses for the TaskManagers' MetricQueryService to query.

Specified by:

requestTaskManagerMetricQueryServiceAddresses in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of instance ids and the corresponding metric query service address

getBlobServerPort

public CompletableFuture<Integer> getBlobServerPort(Time timeout)

Description copied from interface: DispatcherGateway

Returns the port of the blob server.

Specified by:

getBlobServerPort in interface DispatcherGateway

Parameters:

timeout - of the operation

Returns:

A future integer of the blob server port

triggerSavepoint

public CompletableFuture<String> triggerSavepoint(JobID jobId,
                                                  String targetDirectory,
                                                  boolean cancelJob,
                                                  Time timeout)

Description copied from interface: RestfulGateway

Triggers a savepoint with the given savepoint directory as a target.

Specified by:

triggerSavepoint in interface RestfulGateway

Parameters:

jobId - ID of the job for which the savepoint should be triggered.

targetDirectory - Target directory for the savepoint.

timeout - Timeout for the asynchronous operation

Returns:

A future to the external pointer of the savepoint.

stopWithSavepoint

public CompletableFuture<String> stopWithSavepoint(JobID jobId,
                                                   String targetDirectory,
                                                   boolean terminate,
                                                   Time timeout)

Description copied from interface: RestfulGateway

Stops the job with a savepoint.

Specified by:

stopWithSavepoint in interface RestfulGateway

Parameters:

jobId - ID of the job for which the savepoint should be triggered.

targetDirectory - to which to write the savepoint data or null if the default savepoint directory should be used

terminate - flag indicating if the job should terminate or just suspend

timeout - for the rpc call

Returns:

Future which is completed with the savepoint path once completed

shutDownCluster

public CompletableFuture<Acknowledge> shutDownCluster()

Specified by:

shutDownCluster in interface RestfulGateway

shutDownCluster

public CompletableFuture<Acknowledge> shutDownCluster(ApplicationStatus applicationStatus)

Specified by:

shutDownCluster in interface DispatcherGateway

deliverCoordinationRequestToCoordinator

public CompletableFuture<CoordinationResponse> deliverCoordinationRequestToCoordinator(JobID jobId,
                                                                                       OperatorID operatorId,
                                                                                       SerializedValue<CoordinationRequest> serializedRequest,
                                                                                       Time timeout)

Description copied from interface: RestfulGateway

Deliver a coordination request to a specified coordinator and return the response.

Specified by:

deliverCoordinationRequestToCoordinator in interface RestfulGateway

Parameters:

jobId - identifying the job which the coordinator belongs to

operatorId - identifying the coordinator to receive the request

serializedRequest - serialized request to deliver

timeout - RPC timeout

Returns:

A future containing the response. The response will fail with a FlinkException if the task is not running, or no operator/coordinator exists for the given ID, or the coordinator cannot handle client events.

onFatalError

protected void onFatalError(Throwable throwable)

jobReachedGloballyTerminalState

protected org.apache.flink.runtime.dispatcher.Dispatcher.CleanupJobState jobReachedGloballyTerminalState(ArchivedExecutionGraph archivedExecutionGraph)

jobNotFinished

protected org.apache.flink.runtime.dispatcher.Dispatcher.CleanupJobState jobNotFinished(JobID jobId)

onRemovedJobGraph

public CompletableFuture<Void> onRemovedJobGraph(JobID jobId)