org.apache.flink.runtime.webmonitor

Class WebMonitorUtils

java.lang.Object

org.apache.flink.runtime.webmonitor.WebMonitorUtils

public final class WebMonitorUtils
extends Object

Utilities for the web runtime monitor. This class contains for example methods to build messages with aggregate information about the state of an execution graph, to be send to the web server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebMonitorUtils.LogFileLocation Singleton to hold the log and stdout file.

Method Summary

Modifier and Type	Method and Description
static JobDetails	createDetailsForJob(AccessExecutionGraph job)
static Map<String,String>	fromKeyValueJsonArray(String jsonString)
static JsonArchivist[]	getJsonArchivists()
static WebMonitorExtension	loadWebSubmissionExtension(GatewayRetriever<? extends DispatcherGateway> leaderRetriever, CompletableFuture<String> restAddressFuture, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, Path uploadDir, Executor executor, org.apache.flink.configuration.Configuration configuration) Loads the WebMonitorExtension which enables web submission.
static WebMonitor	startWebRuntimeMonitor(org.apache.flink.configuration.Configuration config, HighAvailabilityServices highAvailabilityServices, LeaderGatewayRetriever<JobManagerGateway> jobManagerRetriever, MetricQueryServiceRetriever queryServiceRetriever, org.apache.flink.api.common.time.Time timeout, ScheduledExecutor scheduledExecutor) Starts the web runtime monitor.
static <T extends RestfulGateway> Optional<StaticFileServerHandler<T>>	tryLoadWebContent(GatewayRetriever<? extends T> leaderRetriever, CompletableFuture<String> restAddressFuture, org.apache.flink.api.common.time.Time timeout, File tmpDir) Checks whether the flink-runtime-web dependency is available and if so returns a StaticFileServerHandler which can serve the static file contents.
static org.apache.flink.core.fs.Path	validateAndNormalizeUri(URI archiveDirUri) Checks and normalizes the given URI.

Methods inherited from class java.lang.Object

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

Method Detail

startWebRuntimeMonitor

public static WebMonitor startWebRuntimeMonitor(org.apache.flink.configuration.Configuration config,
                                                HighAvailabilityServices highAvailabilityServices,
                                                LeaderGatewayRetriever<JobManagerGateway> jobManagerRetriever,
                                                MetricQueryServiceRetriever queryServiceRetriever,
                                                org.apache.flink.api.common.time.Time timeout,
                                                ScheduledExecutor scheduledExecutor)

Starts the web runtime monitor. Because the actual implementation of the runtime monitor is in another project, we load the runtime monitor dynamically.

Because failure to start the web runtime monitor is not considered fatal, this method does not throw any exceptions, but only logs them.

Parameters:

config - The configuration for the runtime monitor.

highAvailabilityServices - HighAvailabilityServices used to start the WebRuntimeMonitor

jobManagerRetriever - which retrieves the currently leading JobManager

queryServiceRetriever - which retrieves the query service

timeout - for asynchronous operations

scheduledExecutor - to run asynchronous operations

tryLoadWebContent

public static <T extends RestfulGateway> Optional<StaticFileServerHandler<T>> tryLoadWebContent(GatewayRetriever<? extends T> leaderRetriever,
                                                                                                CompletableFuture<String> restAddressFuture,
                                                                                                org.apache.flink.api.common.time.Time timeout,
                                                                                                File tmpDir)
                                                                                         throws IOException

Checks whether the flink-runtime-web dependency is available and if so returns a StaticFileServerHandler which can serve the static file contents.

Type Parameters:

T - type of the gateway to retrieve

Parameters:

leaderRetriever - to be used by the StaticFileServerHandler

restAddressFuture - of the underlying REST server endpoint

timeout - for lookup requests

tmpDir - to be used by the StaticFileServerHandler to store temporary files

Returns:

StaticFileServerHandler if flink-runtime-web is in the classpath; Otherwise Optional.empty

Throws:

IOException - if we cannot create the StaticFileServerHandler

loadWebSubmissionExtension

public static WebMonitorExtension loadWebSubmissionExtension(GatewayRetriever<? extends DispatcherGateway> leaderRetriever,
                                                             CompletableFuture<String> restAddressFuture,
                                                             org.apache.flink.api.common.time.Time timeout,
                                                             Map<String,String> responseHeaders,
                                                             Path uploadDir,
                                                             Executor executor,
                                                             org.apache.flink.configuration.Configuration configuration)
                                                      throws org.apache.flink.util.FlinkException

Loads the WebMonitorExtension which enables web submission.

Parameters:

leaderRetriever - to retrieve the leader

restAddressFuture - of the underlying REST server endpoint

timeout - for asynchronous requests

responseHeaders - for the web submission handlers

uploadDir - where the web submission handler store uploaded jars

executor - to run asynchronous operations

configuration - used to instantiate the web submission extension

Returns:

Web submission extension

Throws:

org.apache.flink.util.FlinkException - if the web submission extension could not be loaded

getJsonArchivists

public static JsonArchivist[] getJsonArchivists()

fromKeyValueJsonArray

public static Map<String,String> fromKeyValueJsonArray(String jsonString)

createDetailsForJob

public static JobDetails createDetailsForJob(AccessExecutionGraph job)

validateAndNormalizeUri

public static org.apache.flink.core.fs.Path validateAndNormalizeUri(URI archiveDirUri)

Checks and normalizes the given URI. This method first checks the validity of the URI (scheme and path are not null) and then normalizes the URI to a path.

Parameters:

archiveDirUri - The URI to check and normalize.

Returns:

A normalized URI as a Path.

Throws:

IllegalArgumentException - Thrown, if the URI misses scheme or path.