Briefly, this error occurs when Elasticsearch is unable to perform cleanup operations on a repository due to issues like insufficient permissions, network connectivity problems, or the repository being in use by another process. To resolve this, you can check and adjust the permissions of the repository, ensure the network connection is stable, or stop any processes that may be using the repository. Additionally, check the Elasticsearch logs for more detailed error information.
This guide will help you check for common problems that cause the log ” Failed to run repository cleanup operations on [{}][{}] ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: admin, repositories, repository, cluster.
Overview
An Elasticsearch snapshot provides a backup mechanism that takes the current state and data in the cluster and saves it to a repository (read snapshot for more information). The backup process requires a repository to be created first. The repository needs to be registered using the _snapshot endpoint, and multiple repositories can be created per cluster. The following repository types are supported:
Repository types
| Repository type | Configuration type |
|---|---|
| Shared file system | Type: “fs” |
| S3 | Type : “s3” |
| HDFS | Type :“hdfs” |
| Azure | Type: “azure” |
| Google Cloud Storage | Type : “gcs” |
Examples
To register an “fs” repository:
PUT _snapshot/my_repo_01
{
"type": "fs",
"settings": {
"location": "/mnt/my_repo_dir"
}
}Notes and good things to know
- S3, HDFS, Azure and Google Cloud require a relevant plugin to be installed before it can be used for a snapshot.
- The setting, path.repo: /mnt/my_repo_dir needs to be added to elasticsearch.yml on all the nodes if you are planning to use the repo type of file system. Otherwise, it will fail.
- When using remote repositories, the network bandwidth and repository storage throughput should be high enough to complete the snapshot operations normally, otherwise you will end up with partial snapshots.
Log Context
Log “Failed to run repository cleanup operations on [{}][{}]” classname is TransportCleanupRepositoryAction.java.
We extracted the following from Elasticsearch source code for those seeking an in-depth context :
if (failure == null) {
logger.info("Done with repository cleanup on [{}][{}] with result [{}]";
repositoryName; repositoryStateId; result);
listener.onResponse(result);
} else {
logger.warn(() -> new ParameterizedMessage("Failed to run repository cleanup operations on [{}][{}]";
repositoryName; repositoryStateId); failure);
listener.onFailure(failure);
}
}
});
