flink-core/src/main/java/org/apache/flink/configuration/AkkaOptions.java

/*
 * 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;

/**
 * Akka configuration options.
 */
@PublicEvolving
public class AkkaOptions {

	/**
	 * Timeout for akka ask calls.
	 */
	public static final ConfigOption<String> ASK_TIMEOUT = ConfigOptions
		.key("akka.ask.timeout")
		.defaultValue("10 s")
		.withDescription("Timeout used for all futures and blocking Akka calls. If Flink fails due to timeouts then you" +
			" should try to increase this value. Timeouts can be caused by slow machines or a congested network. The" +
			" timeout value requires a time-unit specifier (ms/s/min/h/d).");

	/**
	 * The Akka death watch heartbeat interval.
	 */
	public static final ConfigOption<String> WATCH_HEARTBEAT_INTERVAL = ConfigOptions
		.key("akka.watch.heartbeat.interval")
		.defaultValue(ASK_TIMEOUT.defaultValue())
		.withDescription("Heartbeat interval for Akka’s DeathWatch mechanism to detect dead TaskManagers. If" +
			" TaskManagers are wrongly marked dead because of lost or delayed heartbeat messages, then you should" +
			" decrease this value or increase akka.watch.heartbeat.pause. A thorough description of Akka’s DeathWatch" +
			" can be found <a href=\"http://doc.akka.io/docs/akka/snapshot/scala/remoting.html#failure-detector\">here</a>.");

	/**
	 * The maximum acceptable Akka death watch heartbeat pause.
	 */
	public static final ConfigOption<String> WATCH_HEARTBEAT_PAUSE = ConfigOptions
		.key("akka.watch.heartbeat.pause")
		.defaultValue("60 s")
		.withDescription("Acceptable heartbeat pause for Akka’s DeathWatch mechanism. A low value does not allow an" +
			" irregular heartbeat. If TaskManagers are wrongly marked dead because of lost or delayed heartbeat messages," +
			" then you should increase this value or decrease akka.watch.heartbeat.interval. Higher value increases the" +
			" time to detect a dead TaskManager. A thorough description of Akka’s DeathWatch can be found" +
			" <a href=\"http://doc.akka.io/docs/akka/snapshot/scala/remoting.html#failure-detector\">here</a>.");
	/**
	 * The Akka tcp connection timeout.
	 */
	public static final ConfigOption<String> TCP_TIMEOUT = ConfigOptions
		.key("akka.tcp.timeout")
		.defaultValue("20 s")
		.withDescription("Timeout for all outbound connections. If you should experience problems with connecting to a" +
			" TaskManager due to a slow network, you should increase this value.");

	/**
	 * Timeout for the startup of the actor system.
	 */
	public static final ConfigOption<String> STARTUP_TIMEOUT = ConfigOptions
		.key("akka.startup-timeout")
		.noDefaultValue()
		.withDescription("Timeout after which the startup of a remote component is considered being failed.");

	/**
	 * Heartbeat interval of the transport failure detector.
	 */
	public static final ConfigOption<String> TRANSPORT_HEARTBEAT_INTERVAL = ConfigOptions
		.key("akka.transport.heartbeat.interval")
		.defaultValue("1000 s")
		.withDescription("Heartbeat interval for Akka’s transport failure detector. Since Flink uses TCP, the detector" +
			" is not necessary. Therefore, the detector is disabled by setting the interval to a very high value. In" +
			" case you should need the transport failure detector, set the interval to some reasonable value. The" +
			" interval value requires a time-unit specifier (ms/s/min/h/d).");

	/**
	 * Allowed heartbeat pause for the transport failure detector.
	 */
	public static final ConfigOption<String> TRANSPORT_HEARTBEAT_PAUSE = ConfigOptions
		.key("akka.transport.heartbeat.pause")
		.defaultValue("6000 s")
		.withDescription("Acceptable heartbeat pause for Akka’s transport failure detector. Since Flink uses TCP, the" +
			" detector is not necessary. Therefore, the detector is disabled by setting the pause to a very high value." +
			" In case you should need the transport failure detector, set the pause to some reasonable value." +
			" The pause value requires a time-unit specifier (ms/s/min/h/d).");

	/**
	 * Detection threshold of transport failure detector.
	 */
	public static final ConfigOption<Double> TRANSPORT_THRESHOLD = ConfigOptions
		.key("akka.transport.threshold")
		.defaultValue(300.0)
		.withDescription("Threshold for the transport failure detector. Since Flink uses TCP, the detector is not" +
			" necessary and, thus, the threshold is set to a high value.");

	/**
	 * Detection threshold for the phi accrual watch failure detector.
	 */
	public static final ConfigOption<Integer> WATCH_THRESHOLD = ConfigOptions
		.key("akka.watch.threshold")
		.defaultValue(12)
		.withDescription("Threshold for the DeathWatch failure detector. A low value is prone to false positives whereas" +
			" a high value increases the time to detect a dead TaskManager. A thorough description of Akka’s DeathWatch" +
			" can be found <a href=\"http://doc.akka.io/docs/akka/snapshot/scala/remoting.html#failure-detector\">here</a>.");

	/**
	 * Override SSL support for the Akka transport.
	 */
	public static final ConfigOption<Boolean> SSL_ENABLED = ConfigOptions
		.key("akka.ssl.enabled")
		.defaultValue(true)
		.withDescription("Turns on SSL for Akka’s remote communication. This is applicable only when the global ssl flag" +
			" security.ssl.enabled is set to true.");

	/**
	 * Maximum framesize of akka messages.
	 */
	public static final ConfigOption<String> FRAMESIZE = ConfigOptions
		.key("akka.framesize")
		.defaultValue("10485760b")
		.withDescription("Maximum size of messages which are sent between the JobManager and the TaskManagers. If Flink" +
			" fails because messages exceed this limit, then you should increase it. The message size requires a" +
			" size-unit specifier.");

	/**
	 * Maximum number of messages until another actor is executed by the same thread.
	 */
	public static final ConfigOption<Integer> DISPATCHER_THROUGHPUT = ConfigOptions
		.key("akka.throughput")
		.defaultValue(15)
		.withDescription("Number of messages that are processed in a batch before returning the thread to the pool. Low" +
			" values denote a fair scheduling whereas high values can increase the performance at the cost of unfairness.");

	/**
	 * Log lifecycle events.
	 */
	public static final ConfigOption<Boolean> LOG_LIFECYCLE_EVENTS = ConfigOptions
		.key("akka.log.lifecycle.events")
		.defaultValue(false)
		.withDescription("Turns on the Akka’s remote logging of events. Set this value to ‘true’ in case of debugging.");

	/**
	 * Timeout for all blocking calls that look up remote actors.
	 */
	public static final ConfigOption<String> LOOKUP_TIMEOUT = ConfigOptions
		.key("akka.lookup.timeout")
		.defaultValue("10 s")
		.withDescription("Timeout used for the lookup of the JobManager. The timeout value has to contain a time-unit" +
			" specifier (ms/s/min/h/d).");

	/**
	 * Timeout for all blocking calls on the client side.
	 */
	public static final ConfigOption<String> CLIENT_TIMEOUT = ConfigOptions
		.key("akka.client.timeout")
		.defaultValue("60 s")
		.withDescription("Timeout for all blocking calls on the client side.");

	/**
	 * Exit JVM on fatal Akka errors.
	 */
	public static final ConfigOption<Boolean> JVM_EXIT_ON_FATAL_ERROR = ConfigOptions
		.key("akka.jvm-exit-on-fatal-error")
		.defaultValue(true)
		.withDescription("Exit JVM on fatal Akka errors.");

	/**
	 * Milliseconds a gate should be closed for after a remote connection was disconnected.
	 */
	public static final ConfigOption<Long> RETRY_GATE_CLOSED_FOR = ConfigOptions
		.key("akka.retry-gate-closed-for")
		.defaultValue(50L)
		.withDescription("Milliseconds a gate should be closed for after a remote connection was disconnected.");
}