org.apache.flink.configuration.CheckpointingOptions Maven / Gradle / Ivy
/*
* 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;
/**
* A collection of all configuration options that relate to checkpoints
* and savepoints.
*/
public class CheckpointingOptions {
// ------------------------------------------------------------------------
// general checkpoint and state backend options
// ------------------------------------------------------------------------
/** The state backend to be used to store and checkpoint state. */
public static final ConfigOption STATE_BACKEND = ConfigOptions
.key("state.backend")
.noDefaultValue()
.withDescription("The state backend to be used to store and checkpoint state. " +
"Supported values are 'jobmanager' for MemoryStateBackend, 'filesystem' for FsStateBackend, and 'rocksdb' for RocksDBStateBackend.");
/** The maximum number of completed checkpoints to retain.*/
public static final ConfigOption MAX_RETAINED_CHECKPOINTS = ConfigOptions
.key("state.checkpoints.num-retained")
.defaultValue(1)
.withDescription("The maximum number of completed checkpoints to retain.");
/** Option whether the state backend should use an asynchronous snapshot method where
* possible and configurable.
*
* Some state backends may not support asynchronous snapshots, or only support
* asynchronous snapshots, and ignore this option. */
public static final ConfigOption ASYNC_SNAPSHOTS = ConfigOptions
.key("state.backend.async")
.defaultValue(true)
.withDescription("Option whether the state backend should use an asynchronous snapshot method where" +
" possible and configurable. Some state backends may not support asynchronous snapshots, or only support" +
" asynchronous snapshots, and ignore this option.");
/** Option whether the state backend should create incremental checkpoints,
* if possible. For an incremental checkpoint, only a diff from the previous
* checkpoint is stored, rather than the complete checkpoint state.
*
* Some state backends may not support incremental checkpoints and ignore
* this option.*/
public static final ConfigOption INCREMENTAL_CHECKPOINTS = ConfigOptions
.key("state.backend.incremental")
.defaultValue(false)
.withDescription("Option whether the state backend should create incremental checkpoints, if possible. For" +
" an incremental checkpoint, only a diff from the previous checkpoint is stored, rather than the" +
" complete checkpoint state. Some state backends may not support incremental checkpoints and ignore" +
" this option.");
/**
* The config parameter defining the working directories for file-based state backend.
*/
public static final ConfigOption WORKING_DIRS = ConfigOptions
.key("state.backend.working-dirs")
.noDefaultValue()
.withDescription("The working directories for file-based state backend.");
/**
* This option configures local recovery for this state backend. By default, local recovery is deactivated.
*/
public static final ConfigOption LOCAL_RECOVERY = ConfigOptions
.key("state.backend.local-recovery")
.defaultValue(false);
/**
* The config parameter defining the root directories for storing file-based state for local recovery.
*/
public static final ConfigOption LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS = ConfigOptions
.key("taskmanager.state.local.root-dirs")
.noDefaultValue();
/**
* The option configures the number of concurrent checkpoints could run within state backend.
*/
public static final ConfigOption CHECKPOINTS_MAX_CONCURRENT_NUM = ConfigOptions
.key("state.backend.checkpoints.concurrent-num")
.defaultValue(1)
.withDescription("The max concurrent number of checkpoints could run within state backend. " +
"If set less than 0, means no limit.");
// ------------------------------------------------------------------------
// Options specific to the file-system-based state backends
// ------------------------------------------------------------------------
/** The default directory for savepoints. Used by the state backends that write
* savepoints to file systems (MemoryStateBackend, FsStateBackend, RocksDBStateBackend). */
public static final ConfigOption SAVEPOINT_DIRECTORY = ConfigOptions
.key("state.savepoints.dir")
.noDefaultValue()
.withDeprecatedKeys("savepoints.state.backend.fs.dir")
.withDescription("The default directory for savepoints. Used by the state backends that write savepoints to" +
" file systems (MemoryStateBackend, FsStateBackend, RocksDBStateBackend).");
/** The default directory used for storing the data files and meta data of checkpoints in a Flink supported filesystem.
* The storage path must be accessible from all participating processes/nodes(i.e. all TaskManagers and JobManagers).*/
public static final ConfigOption CHECKPOINTS_DIRECTORY = ConfigOptions
.key("state.checkpoints.dir")
.noDefaultValue()
.withDeprecatedKeys("state.backend.fs.checkpointdir")
.withDescription("The default directory used for storing the data files and meta data of checkpoints " +
"in a Flink supported filesystem. The storage path must be accessible from all participating processes/nodes" +
"(i.e. all TaskManagers and JobManagers).");
/** Whether to create sub-directories with specific jobId to store the data files and meta data of checkpoints. */
public static final ConfigOption CHCKPOINTS_CREATE_SUBDIRS = ConfigOptions
.key("state.checkpoints.create-subdirs")
.defaultValue(true)
.withDescription("Whether to create sub-directories with specific jobId to store the data files and meta data of checkpoints. " +
"The default value is true to enable user could run several jobs with the same checkpoint directory simultaneously, " +
"if this value is set to false, pay attention to not run several jobs with the same directory simultaneously.");
/** The minimum size of state data files. All state chunks smaller than that
* are stored inline in the root checkpoint metadata file. */
public static final ConfigOption FS_SMALL_FILE_THRESHOLD = ConfigOptions
.key("state.backend.fs.memory-threshold")
.defaultValue(1024)
.withDescription("The minimum size of state data files. All state chunks smaller than that are stored" +
" inline in the root checkpoint metadata file.");
/**
* The default write buffer size for file checkpoint output stream created by FsCheckpointStreamFactory.
*/
public static final ConfigOption FS_BUFFER_SIZE = ConfigOptions
.key("state.backend.fs.buffer-size")
.defaultValue(1024 * 1024)
.withDescription(String.format("The default write buffer size for file checkpoint output stream created by FsCheckpointStreamFactory. " +
"And the final actual write buffer size would consider the maximum of values of this option and option '%s'.", FS_SMALL_FILE_THRESHOLD.key()));
}