- All Implemented Interfaces:
Closeable,AutoCloseable,ClusterStateApplier,LifecycleComponent,Releasable
org.elasticsearch.snapshots for details.
See SnapshotShardsService for the data node snapshotting steps.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IndexVersionstatic final IndexVersionSetting that specifies the maximum number of allowed concurrent snapshot create and delete operations in the cluster state.static final Stringstatic final IndexVersionstatic final Stringstatic final IndexVersionstatic final Stringstatic final TransportVersionstatic final IndexVersionFields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
lifecycle -
Constructor Summary
ConstructorsConstructorDescriptionSnapshotsService(Settings settings, ClusterService clusterService, RerouteService rerouteService, IndexNameExpressionResolver indexNameExpressionResolver, RepositoriesService repositoriesService, TransportService transportService, ActionFilters actionFilters, SystemIndices systemIndices) -
Method Summary
Modifier and TypeMethodDescriptionvoidCalled when a new cluster state (ClusterChangedEvent.state()needs to be applied.booleanAssert that no in-memory state for any running snapshot-create or -delete operation exists in this instance.voidcloneSnapshot(CloneSnapshotRequest request, ActionListener<Void> listener) voidcreateSnapshot(CreateSnapshotRequest request, ActionListener<Snapshot> listener) Initializes the snapshotting process.static List<SnapshotsInProgress.Entry> currentSnapshots(SnapshotsInProgress snapshotsInProgress, String repository, List<String> snapshots) Returns status of the currently running snapshotsvoiddeleteSnapshots(DeleteSnapshotRequest request, ActionListener<Void> listener) Deletes snapshots from the repository.protected voiddoClose()Close this component.protected voiddoStart()Start this component.protected voiddoStop()Stop this component.static voidensureRepositoryExists(String repoName, ClusterState state) ThrowsRepositoryMissingExceptionif no repository by the given name is found in the given cluster state.voidexecuteSnapshot(CreateSnapshotRequest request, ActionListener<SnapshotInfo> listener) Same ascreateSnapshot(CreateSnapshotRequest, ActionListener)but invokes its callback on completion of the snapshot.static booleanincludeFileInfoWriterUUID(IndexVersion repositoryMetaVersion) static booleanincludesUUIDs(IndexVersion repositoryMetaVersion) Checks whether the metadata version supports writing the cluster- and repository-uuid to the repository.static IndexVersionminCompatibleVersion(IndexVersion minNodeVersion, RepositoryData repositoryData, Collection<SnapshotId> excluded) Determines the minimumIndexVersionthat the snapshot repository must be compatible with from the current nodes in the cluster and the contents of the repository.snapshottingDataStreams(ClusterState currentState, Set<String> dataStreamsToCheck) Returns the data streams that are currently being snapshotted (with partial == false) and that are contained in the indices-to-check set.snapshottingIndices(ClusterState currentState, Set<Index> indicesToCheck) Returns the indices that are currently being snapshotted (with partial == false) and that are contained in the indices-to-check set.static ClusterStatestateWithoutSnapshot(ClusterState state, Snapshot snapshot, ShardGenerations shardGenerations) Computes the cluster state resulting from removing a given snapshot create operation from the given state.static ClusterStateupdateWithSnapshots(ClusterState state, SnapshotsInProgress snapshotsInProgress, SnapshotDeletionsInProgress snapshotDeletionsInProgress) Shortcut to build newClusterStatefrom the current state and updated values ofSnapshotsInProgressandSnapshotDeletionsInProgress.static booleanuseIndexGenerations(IndexVersion repositoryMetaVersion) Checks whether the metadata version supports writingShardGenerationsto the repository.static booleanuseShardGenerations(IndexVersion repositoryMetaVersion) Checks whether the metadata version supports writingShardGenerationsto the repository.Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, start, stop
-
Field Details
-
SHARD_GEN_IN_REPO_DATA_VERSION
-
INDEX_GEN_IN_REPO_DATA_VERSION
-
UUIDS_IN_REPO_DATA_VERSION
-
UUIDS_IN_REPO_DATA_TRANSPORT_VERSION
-
FILE_INFO_WRITER_UUIDS_IN_SHARD_DATA_VERSION
-
OLD_SNAPSHOT_FORMAT
-
POLICY_ID_METADATA_FIELD
- See Also:
-
UPDATE_SNAPSHOT_STATUS_ACTION_NAME
- See Also:
-
NO_FEATURE_STATES_VALUE
- See Also:
-
MAX_CONCURRENT_SNAPSHOT_OPERATIONS_SETTING
Setting that specifies the maximum number of allowed concurrent snapshot create and delete operations in the cluster state. The number of concurrent operations in a cluster state is defined as the sum ofSnapshotsInProgress.count()and the size ofSnapshotDeletionsInProgress.getEntries().
-
-
Constructor Details
-
SnapshotsService
public SnapshotsService(Settings settings, ClusterService clusterService, RerouteService rerouteService, IndexNameExpressionResolver indexNameExpressionResolver, RepositoriesService repositoriesService, TransportService transportService, ActionFilters actionFilters, SystemIndices systemIndices)
-
-
Method Details
-
executeSnapshot
Same ascreateSnapshot(CreateSnapshotRequest, ActionListener)but invokes its callback on completion of the snapshot.- Parameters:
request- snapshot requestlistener- snapshot completion listener
-
createSnapshot
Initializes the snapshotting process.This method is used by clients to start snapshot. It makes sure that there is no snapshots are currently running and creates a snapshot record in cluster state metadata.
- Parameters:
request- snapshot requestlistener- snapshot creation listener
-
cloneSnapshot
-
ensureRepositoryExists
ThrowsRepositoryMissingExceptionif no repository by the given name is found in the given cluster state. -
currentSnapshots
public static List<SnapshotsInProgress.Entry> currentSnapshots(@Nullable SnapshotsInProgress snapshotsInProgress, String repository, List<String> snapshots) Returns status of the currently running snapshotsThis method is executed on master node
- Parameters:
snapshotsInProgress- snapshots in progress in the cluster staterepository- repository idsnapshots- list of snapshots that will be used as a filter, empty list means no snapshots are filtered- Returns:
- list of metadata for currently running snapshots
-
applyClusterState
Description copied from interface:ClusterStateApplierCalled when a new cluster state (ClusterChangedEvent.state()needs to be applied. The cluster state to be applied is already committed when this method is called, so an applier must therefore be prepared to deal with any state it receives without throwing an exception. Throwing an exception from an applier is very bad because it will stop the application of this state before it has reached all the other appliers, and will likely result in another attempt to apply the same (or very similar) cluster state which might continue until this node is removed from the cluster.Cluster states are applied one-by-one which means they can be a performance bottleneck. Implementations of this method should therefore be fast, so please consider forking work into the background rather than doing everything inline.
- Specified by:
applyClusterStatein interfaceClusterStateApplier
-
stateWithoutSnapshot
public static ClusterState stateWithoutSnapshot(ClusterState state, Snapshot snapshot, ShardGenerations shardGenerations) Computes the cluster state resulting from removing a given snapshot create operation from the given state. This method will update the shard generations of snapshots that the given snapshot depended on so that finalizing them will not cause rolling back to an outdated shard generation.For example, shard snapshot X can be taken, but not finalized yet. Shard snapshot Y can then depend upon shard snapshot X. Then shard snapshot Y may finalize before shard snapshot X, but including X. However, X does not include Y. Therefore we update X to use Y's shard generation file (list of snapshots and dependencies) to avoid overwriting with X's file that is missing Y.
- Parameters:
state- current cluster statesnapshot- snapshot for which to remove the snapshot operation- Returns:
- updated cluster state
-
deleteSnapshots
Deletes snapshots from the repository. In-progress snapshots matched by the delete will be aborted before deleting them. Whenwait_for_completionis set to true, the passed action listener will only complete when all matching snapshots are deleted, when it is false it will complete as soon as the deletes are scheduled- Parameters:
request- delete snapshot requestlistener- listener a listener which will be resolved according to the wait_for_completion parameter
-
minCompatibleVersion
public static IndexVersion minCompatibleVersion(IndexVersion minNodeVersion, RepositoryData repositoryData, @Nullable Collection<SnapshotId> excluded) Determines the minimumIndexVersionthat the snapshot repository must be compatible with from the current nodes in the cluster and the contents of the repository. The minimum version is determined as the lowest version found across all snapshots in the repository and all nodes in the cluster.- Parameters:
minNodeVersion- minimum node version in the clusterrepositoryData- currentRepositoryDataof that repositoryexcluded- snapshot id to ignore when computing the minimum version (used to use newer metadata version after a snapshot delete)- Returns:
- minimum node version that must still be able to read the repository metadata
-
useShardGenerations
Checks whether the metadata version supports writingShardGenerationsto the repository.- Parameters:
repositoryMetaVersion- version to check- Returns:
- true if version supports
ShardGenerations
-
useIndexGenerations
Checks whether the metadata version supports writingShardGenerationsto the repository.- Parameters:
repositoryMetaVersion- version to check- Returns:
- true if version supports
ShardGenerations
-
includesUUIDs
Checks whether the metadata version supports writing the cluster- and repository-uuid to the repository.- Parameters:
repositoryMetaVersion- version to check- Returns:
- true if version supports writing cluster- and repository-uuid to the repository
-
includeFileInfoWriterUUID
-
updateWithSnapshots
public static ClusterState updateWithSnapshots(ClusterState state, @Nullable SnapshotsInProgress snapshotsInProgress, @Nullable SnapshotDeletionsInProgress snapshotDeletionsInProgress) Shortcut to build newClusterStatefrom the current state and updated values ofSnapshotsInProgressandSnapshotDeletionsInProgress.- Parameters:
state- current cluster statesnapshotsInProgress- new value forSnapshotsInProgressornullif it's unchangedsnapshotDeletionsInProgress- new value forSnapshotDeletionsInProgressornullif it's unchanged- Returns:
- updated cluster state
-
snapshottingDataStreams
public static Set<String> snapshottingDataStreams(ClusterState currentState, Set<String> dataStreamsToCheck) Returns the data streams that are currently being snapshotted (with partial == false) and that are contained in the indices-to-check set. -
snapshottingIndices
Returns the indices that are currently being snapshotted (with partial == false) and that are contained in the indices-to-check set. -
doStart
protected void doStart()Description copied from class:AbstractLifecycleComponentStart this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.
This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.- Specified by:
doStartin classAbstractLifecycleComponent
-
doStop
protected void doStop()Description copied from class:AbstractLifecycleComponentStop this component. Typically that means doing the reverse of whateverAbstractLifecycleComponent.doStart()does.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after callingAbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.- Specified by:
doStopin classAbstractLifecycleComponent
-
doClose
protected void doClose()Description copied from class:AbstractLifecycleComponentClose this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.- Specified by:
doClosein classAbstractLifecycleComponent
-
assertAllListenersResolved
public boolean assertAllListenersResolved()Assert that no in-memory state for any running snapshot-create or -delete operation exists in this instance.
-