org.apache.flink.configuration.WebOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-core Show documentation
There is a newer version: 1.5.1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.configuration;

import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.annotation.docs.Documentation;

import static org.apache.flink.configuration.ConfigOptions.key;

/**
 * Configuration options for the WebRuntimeMonitor.
 */
@PublicEvolving
public class WebOptions {

	/**
	 * Config parameter defining the runtime monitor web-frontend server address.
	 */
	public static final ConfigOption ADDRESS =
		key("web.address")
			.noDefaultValue()
			.withDeprecatedKeys("jobmanager.web.address");

	/**
	 * The port for the runtime monitor web-frontend server.
	 *
	 * @deprecated Use {@link RestOptions#PORT} instead
	 */
	@Deprecated
	public static final ConfigOption PORT =
		key("web.port")
			.defaultValue(8081)
			.withDeprecatedKeys("jobmanager.web.port");

	/**
	 * The config parameter defining the Access-Control-Allow-Origin header for all
	 * responses from the web-frontend.
	 */
	public static final ConfigOption ACCESS_CONTROL_ALLOW_ORIGIN =
		key("web.access-control-allow-origin")
			.defaultValue("*")
			.withDeprecatedKeys("jobmanager.web.access-control-allow-origin");

	/**
	 * The config parameter defining the refresh interval for the web-frontend.
	 */
	public static final ConfigOption REFRESH_INTERVAL =
		key("web.refresh-interval")
			.defaultValue(3000L)
			.withDeprecatedKeys("jobmanager.web.refresh-interval");

	/**
	 * Config parameter to override SSL support for the JobManager Web UI.
	 */
	public static final ConfigOption SSL_ENABLED =
		key("web.ssl.enabled")
			.defaultValue(true)
			.withDeprecatedKeys("jobmanager.web.ssl.enabled");

	/**
	 * The config parameter defining the flink web directory to be used by the webmonitor.
	 */
	@Documentation.OverrideDefault("System.getProperty(\"java.io.tmpdir\")")
	public static final ConfigOption TMP_DIR =
		key("web.tmpdir")
			.defaultValue(System.getProperty("java.io.tmpdir"))
			.withDeprecatedKeys("jobmanager.web.tmpdir");

	/**
	 * The config parameter defining the directory for uploading the job jars. If not specified a dynamic directory
	 * will be used under the directory specified by JOB_MANAGER_WEB_TMPDIR_KEY.
	 */
	public static final ConfigOption UPLOAD_DIR =
		key("web.upload.dir")
			.noDefaultValue()
			.withDeprecatedKeys("jobmanager.web.upload.dir");

	/**
	 * The config parameter defining the number of archived jobs for the jobmanager.
	 */
	public static final ConfigOption ARCHIVE_COUNT =
		key("web.history")
			.defaultValue(5)
			.withDeprecatedKeys("jobmanager.web.history");

	/**
	 * The log file location (may be in /log for standalone but under log directory when using YARN).
	 */
	public static final ConfigOption LOG_PATH =
		key("web.log.path")
			.noDefaultValue()
			.withDeprecatedKeys("jobmanager.web.log.path");

	/**
	 * Config parameter indicating whether jobs can be uploaded and run from the web-frontend.
	 */
	public static final ConfigOption SUBMIT_ENABLE =
		key("web.submit.enable")
			.defaultValue(true)
			.withDeprecatedKeys("jobmanager.web.submit.enable");

	/**
	 * Config parameter defining the number of checkpoints to remember for recent history.
	 */
	public static final ConfigOption CHECKPOINTS_HISTORY_SIZE =
		key("web.checkpoints.history")
			.defaultValue(10)
			.withDeprecatedKeys("jobmanager.web.checkpoints.history");

	/**
	 * Time after which cached stats are cleaned up if not accessed.
	 */
	public static final ConfigOption BACKPRESSURE_CLEANUP_INTERVAL =
		key("web.backpressure.cleanup-interval")
			.defaultValue(10 * 60 * 1000)
			.withDeprecatedKeys("jobmanager.web.backpressure.cleanup-interval");

	/**
	 * Time after which available stats are deprecated and need to be refreshed (by resampling).
	 */
	public static final ConfigOption BACKPRESSURE_REFRESH_INTERVAL =
		key("web.backpressure.refresh-interval")
			.defaultValue(60 * 1000)
			.withDeprecatedKeys("jobmanager.web.backpressure.refresh-interval");

	/**
	 * Number of stack trace samples to take to determine back pressure.
	 */
	public static final ConfigOption BACKPRESSURE_NUM_SAMPLES =
		key("web.backpressure.num-samples")
			.defaultValue(100)
			.withDeprecatedKeys("jobmanager.web.backpressure.num-samples");

	/**
	 * Delay between stack trace samples to determine back pressure.
	 */
	public static final ConfigOption BACKPRESSURE_DELAY =
		key("web.backpressure.delay-between-samples")
			.defaultValue(50)
			.withDeprecatedKeys("jobmanager.web.backpressure.delay-between-samples");

	/**
	 * Timeout for asynchronous operations by the WebRuntimeMonitor in milliseconds.
	 */
	public static final ConfigOption TIMEOUT =
		key("web.timeout")
		.defaultValue(10L * 1000L);

	// ------------------------------------------------------------------------

	/** Not meant to be instantiated. */
	private WebOptions() {}
}