zhuzhurk commented on a change in pull request #9562: [FLINK-13898] Migrate restart stratey config constants to ConfigOptions URL: https://github.com/apache/flink/pull/9562#discussion_r319710651
########## File path: flink-core/src/main/java/org/apache/flink/configuration/RestartStrategyOptions.java ########## @@ -0,0 +1,141 @@ +/* + * 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.ConfigGroup; +import org.apache.flink.annotation.docs.ConfigGroups; +import org.apache.flink.configuration.description.Description; + +import static org.apache.flink.configuration.description.LinkElement.link; +import static org.apache.flink.configuration.description.TextElement.code; +import static org.apache.flink.configuration.description.TextElement.text; + +/** + * Config options for restart strategies. + */ +@PublicEvolving +@ConfigGroups(groups = { + @ConfigGroup(name = "FixedDelayRestartStrategy", keyPrefix = "restart-strategy.fixed-delay"), + @ConfigGroup(name = "FailureRateRestartStrategy", keyPrefix = "restart-strategy.failure-rate") +}) +public class RestartStrategyOptions { + + public static final ConfigOption<String> RESTART_STRATEGY = ConfigOptions + .key("restart-strategy") + .noDefaultValue() + .withDescription( + Description.builder() + .text("Defines the restart strategy to use in case of job failures.") + .linebreak() + .text("Accepted values are:") + .list( + text("%s, %s, %s: No restart strategy.", code("none"), code("off"), code("disable")), + text( + "%s, %s: Fixed delay restart strategy. More details can be found %s.", + code("fixeddelay"), + code("fixed-delay"), + link("../dev/task_failure_recovery.html#fixed-delay-restart-strategy", "here")), + text( + "%s, %s: Failure rate restart strategy. More details can be found %s.", + code("failurerate"), + code("failure-rate"), + link("../dev/task_failure_recovery.html#failure-rate-restart-strategy", "here")), + text( + "%s: Fully qualified name of %s factory which has has a method %s.", + code("org.foobar.MyRestartStrategyFactoryFactory"), + code("RestartStrategyFactory"), + code("RestartStrategyFactory createFactory(Configuration configuration)")) + ) + .text( + "If checkpointing is disabled, the default value is %s. " + + "If checkpointing is enabled, the default value is %s with %s restart attempts and '%s' delay.", + code("none"), + code("fixed-delay"), + code("Integer.MAX_VALUE"), + code("0 s")) + .build()); + + public static final ConfigOption<Integer> RESTART_STRATEGY_FIXED_DELAY_ATTEMPTS = ConfigOptions + .key("restart-strategy.fixed-delay.attempts") + .defaultValue(1) + .withDescription( + Description.builder() + .text( + "The number of times that Flink retries the execution before the job is declared as failed if %s has been set to %s.", + code(RESTART_STRATEGY.key()), + code("fixed-delay")) + .build()); + + public static final ConfigOption<String> RESTART_STRATEGY_FIXED_DELAY_DELAY = ConfigOptions + .key("restart-strategy.fixed-delay.delay") + .defaultValue("0 s") + .withDescription( + Description.builder() + .text( + "Delay between two consecutive restart attempts if %s has been set to %s. " + + "Delaying the retries can be helpful when the program interacts with external systems where " + + "for example connections or pending transactions should reach a timeout before re-execution " + + "is attempted. It can be specified using Scala's %s notation: \"1 min\", \"20 s\"", + code(RESTART_STRATEGY.key()), + code("fixed-delay"), + code("FiniteDuration")) + .build()); + + public static final ConfigOption<Integer> RESTART_STRATEGY_FAILURE_RATE_MAX_FAILURES_PER_INTERVAL = ConfigOptions + .key("restart-strategy.failure-rate.max-failures-per-interval") + .defaultValue(1) + .withDescription( + Description.builder() + .text( + "Maximum number of restarts in given time interval before failing a job if %s has been set to %s.", + code(RESTART_STRATEGY.key()), + code("failure-rate")) + .build()); + + public static final ConfigOption<String> RESTART_STRATEGY_FAILURE_RATE_FAILURE_RATE_INTERVAL = ConfigOptions + .key("restart-strategy.failure-rate.failure-rate-interval") + .defaultValue("1 min") + .withDescription( + Description.builder() + .text( + "Time interval for measuring failure rate if %s has been set to %s. " + + "It can be specified using Scala's %s notation: \"1 min\", \"20 s\"", + code(RESTART_STRATEGY.key()), + code("failure-rate"), + code("FiniteDuration")) + .build()); + + public static final ConfigOption<String> RESTART_STRATEGY_FAILURE_RATE_DELAY = ConfigOptions + .key("restart-strategy.failure-rate.delay") + .defaultValue(AkkaOptions.ASK_TIMEOUT.defaultValue()) Review comment: Not sure why whether it's a good choice to use AKKA ask timeout as the default value? And seems there is no logic to use this default value. I'm thinking whether we can simplify various restart delay as well. Currently AkkaOptions.WATCH_HEARTBEAT_INTERVAL(for failure rate strategy) and AkkaOptions.WATCH_HEARTBEAT_PAUSE(for deprecated configs, already simplified in this PR) are used as default delay in some cases, which also makes it hard to describe the behavior. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
