Briefly, this error occurs when Elasticsearch’s Snapshot Lifecycle Management (SLM) tries to clean up old snapshots but encounters an issue. This could be due to insufficient permissions, network issues, or problems with the snapshot repository. To resolve this, you can check the Elasticsearch logs for more details about the error. Ensure that the Elasticsearch cluster has the necessary permissions to delete snapshots. Also, verify the health and connectivity of the snapshot repository. If the repository is on a remote server, ensure it’s accessible and has enough space.
This guide will help you check for common problems that cause the log ” SLM retention snapshot cleanup task completed with error ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: plugin, task, snapshot.
Overview
A task is an Elasticsearch operation, which can be any request performed on an Elasticsearch cluster, such as a delete by query request, a search request and so on. Elasticsearch provides a dedicated Task API for the task management which includes various actions, from retrieving the status of current running tasks to canceling any long running task.
Examples
Get all currently running tasks on all nodes of the cluster
Apart from other information, the response of the below request contains task IDs of all the tasks which can be used to get detailed information about the particular task in question.
GET _tasks
Get detailed information of a particular task
Where clQFAL_VRrmnlRyPsu_p8A:1132678759 is the ID of the task in below request
GET _tasks/clQFAL_VRrmnlRyPsu_p8A:1132678759
Get all the current tasks running on particular nodes
GET _tasks?nodes=nodeId1,nodeId2
Cancel a task
Where clQFAL_VRrmnlRyPsu_p8A:1132678759 is the ID of the task in the below request
POST /_tasks/clQFAL_VRrmnlRyPsu_p8A:1132678759/_cancel?pretty
Notes
- The Task API will be most useful when you want to investigate the spike of resource utilization in the cluster or want to cancel an operation.
Log Context
Log “SLM retention snapshot cleanup task completed with error” classname is SnapshotRetentionTask.java.
We extracted the following from Elasticsearch source code for those seeking an in-depth context :
try {
logger.error("error during snapshot retention task"; e);
slmStats.retentionFailed();
updateStateWithStats(slmStats);
} finally {
logger.info("SLM retention snapshot cleanup task completed with error");
}
};
try {
logger.info("starting SLM retention snapshot cleanup task");
