org.apache.flink.runtime.dispatcher

Class Dispatcher

java.lang.Object

org.apache.flink.runtime.rpc.RpcEndpoint

org.apache.flink.runtime.rpc.FencedRpcEndpoint<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 FencedRpcEndpoint<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

Modifier and Type	Class and Description
protected static class	Dispatcher.ExecutionType Enum to distinguish between initial job submission and re-submission for recovery.

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

RpcEndpoint.MainThreadExecutor

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<java.time.Duration>	CLIENT_ALIVENESS_CHECK_DURATION
static String	DISPATCHER_NAME
protected CompletableFuture<ApplicationStatus>	shutDownFuture

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

log, rpcServer

Constructor Summary

Constructors

Modifier	Constructor and Description
	Dispatcher(RpcService rpcService, DispatcherId fencingToken, Collection<JobGraph> recoveredJobs, Collection<JobResult> recoveredDirtyJobs, DispatcherBootstrapFactory dispatcherBootstrapFactory, DispatcherServices dispatcherServices)
protected	Dispatcher(RpcService rpcService, DispatcherId fencingToken, Collection<JobGraph> recoveredJobs, Collection<JobResult> recoveredDirtyJobs, DispatcherBootstrapFactory dispatcherBootstrapFactory, DispatcherServices dispatcherServices, JobManagerRunnerRegistry jobManagerRunnerRegistry, ResourceCleanerFactory resourceCleanerFactory)

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()
CompletableFuture<OperationResult<Long>>	getTriggeredCheckpointStatus(AsynchronousJobOperationKey operationKey) Get the status of a checkpoint triggered under the specified operation key.
CompletableFuture<OperationResult<String>>	getTriggeredSavepointStatus(AsynchronousJobOperationKey operationKey) Get the status of a savepoint triggered under the specified operation key.
protected CompletableFuture<org.apache.flink.runtime.dispatcher.Dispatcher.CleanupJobState>	jobReachedTerminalState(ExecutionGraphInfo executionGraphInfo)
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<Void>	reportJobClientHeartbeat(JobID jobId, long expiredTimestamp, Time timeout) The client reports the heartbeat to the dispatcher for aliveness.
CompletableFuture<ClusterOverview>	requestClusterOverview(Time timeout) Requests the cluster status overview.
CompletableFuture<ExecutionGraphInfo>	requestExecutionGraphInfo(JobID jobId, Time timeout) Requests the ExecutionGraphInfo containing additional information besides the ArchivedExecutionGraph.
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<Collection<Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServiceAddresses(Time timeout) Requests the addresses for the TaskManagers' MetricQueryService to query.
CompletableFuture<ThreadDumpInfo>	requestThreadDump(Time timeout) Requests the thread dump from the JobManager.
protected void	runPostJobGloballyTerminated(JobID jobId, JobStatus jobStatus)
CompletableFuture<Acknowledge>	shutDownCluster()
CompletableFuture<Acknowledge>	shutDownCluster(ApplicationStatus applicationStatus)
CompletableFuture<Acknowledge>	stopWithSavepoint(AsynchronousJobOperationKey operationKey, String targetDirectory, SavepointFormatType formatType, TriggerSavepointMode savepointMode, Time timeout) Stops the job with a savepoint, returning a future that completes when the operation is started.
CompletableFuture<String>	stopWithSavepointAndGetLocation(JobID jobId, String targetDirectory, SavepointFormatType formatType, TriggerSavepointMode savepointMode, Time timeout) Stops the job with a savepoint, returning a future that completes with the savepoint location when the savepoint is completed.
CompletableFuture<Acknowledge>	submitFailedJob(JobID jobId, String jobName, Throwable exception)
CompletableFuture<Acknowledge>	submitJob(JobGraph jobGraph, Time timeout) Submit a job to the dispatcher.
CompletableFuture<Acknowledge>	triggerCheckpoint(AsynchronousJobOperationKey operationKey, CheckpointType checkpointType, Time timeout) Triggers a checkpoint with the given savepoint directory as a target.
CompletableFuture<String>	triggerCheckpoint(JobID jobID, Time timeout)
CompletableFuture<Acknowledge>	triggerSavepoint(AsynchronousJobOperationKey operationKey, String targetDirectory, SavepointFormatType formatType, TriggerSavepointMode savepointMode, Time timeout) Triggers a savepoint with the given savepoint directory as a target, returning a future that completes when the operation is started.
CompletableFuture<String>	triggerSavepointAndGetLocation(JobID jobId, String targetDirectory, SavepointFormatType formatType, TriggerSavepointMode savepointMode, Time timeout) Triggers a savepoint with the given savepoint directory as a target, returning a future that completes with the savepoint location when it is complete.

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

getFencingToken

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

callAsync, closeAsync, getAddress, getEndpointId, getHostname, getMainThreadExecutor, getRpcService, getSelfGateway, getTerminationFuture, internalCallOnStart, internalCallOnStop, isRunning, registerResource, runAsync, scheduleRunAsync, scheduleRunAsync, start, stop, unregisterResource, 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.webmonitor.RestfulGateway

requestJob

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

getAddress, getHostname

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

close

Field Detail

CLIENT_ALIVENESS_CHECK_DURATION

@VisibleForTesting
public static final ConfigOption<java.time.Duration> CLIENT_ALIVENESS_CHECK_DURATION

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,
                  Collection<JobResult> recoveredDirtyJobs,
                  DispatcherBootstrapFactory dispatcherBootstrapFactory,
                  DispatcherServices dispatcherServices)
           throws Exception

Throws:

Exception

Dispatcher

@VisibleForTesting
protected Dispatcher(RpcService rpcService,
                                        DispatcherId fencingToken,
                                        Collection<JobGraph> recoveredJobs,
                                        Collection<JobResult> recoveredDirtyJobs,
                                        DispatcherBootstrapFactory dispatcherBootstrapFactory,
                                        DispatcherServices dispatcherServices,
                                        JobManagerRunnerRegistry jobManagerRunnerRegistry,
                                        ResourceCleanerFactory resourceCleanerFactory)
                                 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

submitFailedJob

public CompletableFuture<Acknowledge> submitFailedJob(JobID jobId,
                                                      String jobName,
                                                      Throwable exception)

Specified by:

submitFailedJob in interface DispatcherGateway

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

requestExecutionGraphInfo

public CompletableFuture<ExecutionGraphInfo> requestExecutionGraphInfo(JobID jobId,
                                                                       Time timeout)

Description copied from interface: RestfulGateway

Requests the ExecutionGraphInfo containing additional information besides the ArchivedExecutionGraph. If there is no such graph, then the future is completed with a FlinkJobNotFoundException.

Specified by:

requestExecutionGraphInfo in interface RestfulGateway

Parameters:

jobId - identifying the job whose ExecutionGraphInfo is requested

timeout - for the asynchronous operation

Returns:

Future containing the ExecutionGraphInfo 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

requestThreadDump

public CompletableFuture<ThreadDumpInfo> requestThreadDump(Time timeout)

Description copied from interface: RestfulGateway

Requests the thread dump from the JobManager.

Specified by:

requestThreadDump in interface RestfulGateway

Parameters:

timeout - timeout of the asynchronous operation

Returns:

Future containing the thread dump information

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

triggerCheckpoint

public CompletableFuture<String> triggerCheckpoint(JobID jobID,
                                                   Time timeout)

Specified by:

triggerCheckpoint in interface DispatcherGateway

triggerCheckpoint

public CompletableFuture<Acknowledge> triggerCheckpoint(AsynchronousJobOperationKey operationKey,
                                                        CheckpointType checkpointType,
                                                        Time timeout)

Description copied from interface: RestfulGateway

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

Specified by:

triggerCheckpoint in interface RestfulGateway

Parameters:

operationKey - the key of the operation, for deduplication purposes

checkpointType - checkpoint backup type (configured / full / incremental)

timeout - Timeout for the asynchronous operation

Returns:

A future to the external pointer of the savepoint.

getTriggeredCheckpointStatus

public CompletableFuture<OperationResult<Long>> getTriggeredCheckpointStatus(AsynchronousJobOperationKey operationKey)

Description copied from interface: RestfulGateway

Get the status of a checkpoint triggered under the specified operation key.

Specified by:

getTriggeredCheckpointStatus in interface RestfulGateway

Parameters:

operationKey - key of the operation

Returns:

Future which completes immediately with the status, or fails if no operation is registered for the key

triggerSavepoint

public CompletableFuture<Acknowledge> triggerSavepoint(AsynchronousJobOperationKey operationKey,
                                                       String targetDirectory,
                                                       SavepointFormatType formatType,
                                                       TriggerSavepointMode savepointMode,
                                                       Time timeout)

Description copied from interface: RestfulGateway

Triggers a savepoint with the given savepoint directory as a target, returning a future that completes when the operation is started.

Specified by:

triggerSavepoint in interface RestfulGateway

Parameters:

operationKey - the key of the operation, for deduplication purposes

targetDirectory - Target directory for the savepoint.

formatType - Binary format of the savepoint.

savepointMode - context of the savepoint operation

timeout - Timeout for the asynchronous operation

Returns:

Future which is completed once the operation is triggered successfully

triggerSavepointAndGetLocation

public CompletableFuture<String> triggerSavepointAndGetLocation(JobID jobId,
                                                                String targetDirectory,
                                                                SavepointFormatType formatType,
                                                                TriggerSavepointMode savepointMode,
                                                                Time timeout)

Description copied from interface: DispatcherGateway

Triggers a savepoint with the given savepoint directory as a target, returning a future that completes with the savepoint location when it is complete.

Specified by:

triggerSavepointAndGetLocation in interface DispatcherGateway

Parameters:

jobId - the job id

targetDirectory - Target directory for the savepoint.

formatType - Binary format of the savepoint.

savepointMode - context of the savepoint operation

timeout - Timeout for the asynchronous operation

Returns:

Future which is completed once the operation is triggered successfully

getTriggeredSavepointStatus

public CompletableFuture<OperationResult<String>> getTriggeredSavepointStatus(AsynchronousJobOperationKey operationKey)

Description copied from interface: RestfulGateway

Get the status of a savepoint triggered under the specified operation key.

Specified by:

getTriggeredSavepointStatus in interface RestfulGateway

Parameters:

operationKey - key of the operation

Returns:

Future which completes immediately with the status, or fails if no operation is registered for the key

stopWithSavepoint

public CompletableFuture<Acknowledge> stopWithSavepoint(AsynchronousJobOperationKey operationKey,
                                                        String targetDirectory,
                                                        SavepointFormatType formatType,
                                                        TriggerSavepointMode savepointMode,
                                                        Time timeout)

Description copied from interface: RestfulGateway

Stops the job with a savepoint, returning a future that completes when the operation is started.

Specified by:

stopWithSavepoint in interface RestfulGateway

Parameters:

operationKey - key of the operation, for deduplication

targetDirectory - Target directory for the savepoint.

formatType - Binary format of the savepoint.

savepointMode - context of the savepoint operation

timeout - for the rpc call

Returns:

Future which is completed once the operation is triggered successfully

stopWithSavepointAndGetLocation

public CompletableFuture<String> stopWithSavepointAndGetLocation(JobID jobId,
                                                                 String targetDirectory,
                                                                 SavepointFormatType formatType,
                                                                 TriggerSavepointMode savepointMode,
                                                                 Time timeout)

Description copied from interface: DispatcherGateway

Stops the job with a savepoint, returning a future that completes with the savepoint location when the savepoint is completed.

Specified by:

stopWithSavepointAndGetLocation in interface DispatcherGateway

Parameters:

jobId - the job id

targetDirectory - Target directory for the savepoint.

savepointMode - context of the savepoint operation

timeout - for the rpc call

Returns:

Future which is completed with the savepoint location once it is 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.

reportJobClientHeartbeat

public CompletableFuture<Void> reportJobClientHeartbeat(JobID jobId,
                                                        long expiredTimestamp,
                                                        Time timeout)

Description copied from interface: RestfulGateway

The client reports the heartbeat to the dispatcher for aliveness.

Specified by:

reportJobClientHeartbeat in interface RestfulGateway

runPostJobGloballyTerminated

protected void runPostJobGloballyTerminated(JobID jobId,
                                            JobStatus jobStatus)

onFatalError

protected void onFatalError(Throwable throwable)

jobReachedTerminalState

@VisibleForTesting
protected CompletableFuture<org.apache.flink.runtime.dispatcher.Dispatcher.CleanupJobState> jobReachedTerminalState(ExecutionGraphInfo executionGraphInfo)

onRemovedJobGraph

public CompletableFuture<Void> onRemovedJobGraph(JobID jobId)