JobManager Web Frontend

Updated on 2022-08-12 GMT+08:00

View PDF

Scenarios

When JobManager is started, the web server in the same process is also started.

You can access the web server to obtain information about the current Flink cluster, including information about JobManager, TaskManager, and running jobs in the cluster.
You can configure parameters of the web server.

Configuration Description

Configuration items include the port, temporary directory, display items, error redirection, and security-related items.

For versions earlier than MRS 3.x, see Table 1.

**Table 1** Parameters
Parameter	Mandatory	Default Value	Description
jobmanager.web.port	No	32261-32325	Web port. Value range: 32261-32325.
jobmanager.web.allow-access-address	Yes	*	Web access whitelist. IP addresses are separated by commas (,). Only IP addresses in the whitelist can access the web.

For details about configuration items of MRS 3.x or later, see Table 2.

**Table 2** Parameters
Parameter	Description	Default Value	Mandatory
flink.security.enable	When installing a Flink cluster, you are required to select security mode or normal mode. If security mode is selected, the value of flink.security.enable is automatically set to true. If normal mode is selected, the value of flink.security.enable is automatically set to false. If you want to checker whether Flink cluster is in security mode or normal mode, view the value of flink.security.enable.	The value is automatically configured based on the cluster installation mode.	No
rest.bind-port	Web port. Value range: 32261-32325.	32261-32325	No
jobmanager.web.history	Number of recent jobs to be displayed.	5	No
jobmanager.web.checkpoints.disable	Indicates whether to disable checkpoint statistics.	false	No
jobmanager.web.checkpoints.history	Number of checkpoint statistical records.	10	No
jobmanager.web.backpressure.cleanup-interval	Interval for clearing unaccessed backpressure records. The unit is millisecond.	600000	No
jobmanager.web.backpressure.refresh-interval	Interval for updating backpressure records. The unit is millisecond.	60000	No
jobmanager.web.backpressure.num-samples	Number of stack tracing records for reverse pressure calculation.	100	No
jobmanager.web.backpressure.delay-between-samples	Sampling interval for reverse pressure calculation. The unit is millisecond.	50	No
jobmanager.web.ssl.enabled	Whether SSL encryption is enabled for web transmission. This parameter is valid only when the global switch security.ssl is enabled.	false	Yes
jobmanager.web.accesslog.enable	Switch to enable or disable web operation logs. The log is stored in webaccess.log.	true	Yes
jobmanager.web.x-frame-options	Value of the HTTP security header X-Frame-Options. The value can be SAMEORIGIN, DENY, or ALLOW-FROM uri.	DENY	Yes
jobmanager.web.cache-directive	Whether the web page can be cached.	no-store	Yes
jobmanager.web.expires-time	Expiration duration of web page cache. The unit is millisecond.	0	Yes
jobmanager.web.allow-access-address	Web access whitelist. IP addresses are separated by commas (,). Only IP addresses in the whitelist can access the web.	*	Yes
jobmanager.web.access-control-allow-origin	Web page same-origin policy that prevents cross-domain attacks.	*	Yes
jobmanager.web.refresh-interval	Web page refresh interval. The unit is millisecond.	3000	Yes
jobmanager.web.logout-timer	Automatic logout interval when no operation is performed. The unit is millisecond.	600000	Yes
jobmanager.web.403-redirect-url	Web page access error 403. If 403 error occurs, the page switch to a specified page.	Automatic configuration	Yes
jobmanager.web.404-redirect-url	Web page access error 404. If 404 error occurs, the page switch to a specified page.	Automatic configuration	Yes
jobmanager.web.415-redirect-url	Web page access error 415. If 415 error occurs, the page switch to a specified page.	Automatic configuration	Yes
jobmanager.web.500-redirect-url	Web page access error 500. If 500 error occurs, the page switch to a specified page.	Automatic configuration	Yes
rest.await-leader-timeout	Time of the client waiting for the leader address. The unit is millisecond.	30000	No
rest.client.max-content-length	Maximum content length that the client handles (unit: bytes).	104857600	No
rest.connection-timeout	Maximum time for the client to establish a TCP connection (unit: ms).	15000	No
rest.idleness-timeout	Maximum time for a connection to stay idle before failing (unit: ms).	300000	No
rest.retry.delay	The time that the client waits between retries (unit: ms).	3000	No
rest.retry.max-attempts	The number of retry times if a retrievable operator fails.	20	No
rest.server.max-content-length	Maximum content length that the server handles (unit: bytes).	104857600	No
rest.server.numThreads	Maximum number of threads for the asynchronous processing of requests.	4	No
web.timeout	Timeout for web monitor (unit: ms).	10000	No