Error during snapshot retention task – How to solve related issues

Opster Team

Feb-20, Version: 1.7-8.0

Before you begin reading this guide, we recommend you run Elasticsearch Error Check-Up which analyzes 2 JSON files to detect many errors.

To easily locate the root cause and resolve this issue try AutoOps for Elasticsearch & OpenSearch. It diagnoses problems by analyzing hundreds of metrics collected by a lightweight agent and offers guidance for resolving them. Take a self-guided product tour to see for yourself (no registration required).

This guide will help you check for common problems that cause the log ” Error during snapshot retention task ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: plugin, snapshot and task.

 
 

plugin

Overview

A plugin is used to enhance the core functionalities of Elasticsearch. Elasticsearch provides some core plugins as a part of their release installation. In addition to those core plugins, it is possible to write your own custom plugins as well. There are several community plugins available on GitHub for various use cases.

Examples

Get all of the instructions for the plugin:

sudo bin/elasticsearch-plugin -h

Installing the S3 plugin for storing Elasticsearch snapshots on S3:

sudo bin/elasticsearch-plugin install repository-s3

Removing a plugin:

sudo bin/elasticsearch-plugin remove repository-s3

Installing a plugin using the file’s path:

sudo bin/elasticsearch-plugin install file:///path/to/plugin.zip

Notes and good things to know

  • Plugins are installed and removed using the elasticsearch-plugin script, which ships as a part of the Elasticsearch installation and can be found inside the bin/ directory of the Elasticsearch installation path.
  • A plugin has to be installed on every node of the cluster and each of the nodes has to be restarted to make the plugin visible.
  • You can also download the plugin manually and then install it using the elasticsearch-plugin install command, providing the file name/path of the plugin’s source file.
  • When a plugin is removed, you will need to restart every Elasticsearch node in order to complete the removal process.

Common issues

  • Managing permission issues during and after plugin installation is the most common problem. If Elasticsearch was installed using the DEB or RPM packages then the plugin has to be installed using the root user. Otherwise you can install the plugin as the user that owns all of the Elasticsearch files.
  • In the case of DEB or RPM package installation, it is important to check the permissions of the plugins directory after you install it. You can update the permission if it has been modified using the following command:
chown -R elasticsearch:elasticsearch path_to_plugin_directory
  • If your Elasticsearch nodes are running in a private subnet without internet access, you cannot install a plugin directly. In this case, you can simply download the plugins and copy the files inside the plugins directory of the Elasticsearch installation path on every node. The node has to be restarted in this case as well.
 
 

snapshot

Overview

An Elasticsearch snapshot is a backup of an index taken from a running cluster. Snapshots are taken incrementally. This means that when Elasticsearch creates a snapshot of an index, it will not copy any data that was already backed up in an earlier snapshot of the index (unless it was changed). Therefore, it is recommended to take snapshots often.

You can restore snapshots into a running cluster via the restore API. Snapshots can only be restored to versions of Elasticsearch that can read the indices. Check the version compatibility before you restore. You can’t restore an index to a cluster that is more than one version above the index version.

The following repository types are supported:

  • File system location
  • S3 object storage 
  • HDFS
  • Azure and Google Cloud storage

Examples

An example of using S3 repository for Elasticsearch:

PUT _snapshot/backups
{
    "type": "s3",
    "settings": {
      "bucket": "elastic",
      "endpoint": "10.3.10.10:9000",
      "protocol": "http"
    }
}

You will also need to set the S3 access key and secret key in Elasticsearch key store.

bin/elasticsearch-keystore add s3.client.default.access_key
bin/elasticsearch-keystore add s3.client.default.secret_key

Taking a snapshot

Once the repo is set, taking a snapshot is just an API call.

PUT /_snapshot/backup/my_snapshot-01-10-2019

Where backup is the name of snapshot repo, and my_snapshot-01-10-2019 is the name of the snapshot. The above example will take a snapshot of all the indices. To take a snapshot of specific indices, provide the names of the indices you would like a snapshot of. 

PUT /_snapshot/backup/my_snapshot-01-10-2019
{
  "indices": "my_index_1,my_index_2"
  }
}

Restoring a snapshot

Restoring from a snapshot is also an API call:

POST /_snapshot/backup/my_snapshot-01-10-2019
/_restore
{
  "indices": "index_1,index_2"
}

This will restore index_1 and index_2 from the snapshot my_snapshot-01-10-2019 in backup repository.

Notes and good things to know

  • Snapshot repository needs to be set up before you can take a snapshot, and you will need to install the S3 repository plugin as well if you plan to use a repository with S3 as backend storage.
sudo bin/elasticsearch-plugin install repository-s3
  • You can use curator_cli tool to automate taking snapshots such as Cron, Kenkins or Kubernetes job schedule.
  • It is better to use Elasticsearch snapshots instead of disk backups/snapshots. An index must be closed in order to be restored.
  • Another option is to delete the index before restoring it. The snapshot and restore mechanism can also be used to copy data from one cluster to another cluster.
  • If you don’t have S3 storage , you can run minio with NFS backend to create an S3 equivalent for your cluster snapshots
  • When the operation is retried, it will only try to snapshot any shards that failed on the initial operation, until the snapshot succeeds.
  • It is better to have the snapshot repo on the local network with Elasticsearch or configure/design the repository for high write throughput so that you don’t have to deal with partial snapshots.
  • The snapshot operation will fail if there is a missing index. Setting the ignore_unavailable option to true will cause indices that do not exist to be ignored during snapshot operation. 
  • If you are using some open source security tool such as SearchGuard, you will need to configure the Elasticsearch snapshot restore settings on the cluster before you can restore any snapshot. 
  • In elasticsearch.yml:
searchguard.enable_snapshot_restore_privilege: true

Create data backups automatically without using snapshots

If having backups of your data is important to you and your operations, snapshots may not be ideal for you. Firstly, there are the problems mentioned above, but you also run the risk of losing any data generated in the time elapsed since the last snapshot was stored.

If, for example, you designate a snapshot and restore process to occur every 5 minutes, the data being backed up is always 5 minutes behind. If a cluster fails 4 minutes after the last snapshot was taken, 4 minutes of data will be completely lost.

Opster’s Multi-Cluster Load Balancer mirrors data to multiple clusters in real time to ensure complete data recovery, meaning there are zero time gaps and you’ll never run the risk of losing valuable data. To book a demo of the Mutli-Cluster Load Balancer, click here.

 
 

task

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 “error during snapshot retention task” classname is SnapshotRetentionTask.java.
We extracted the following from Elasticsearch source code for those seeking an in-depth context :

             final SnapshotLifecycleStats slmStats = new SnapshotLifecycleStats();

            // Defined here so it can be re-used without having to repeat it
            final Consumer failureHandler = e -> {
                try {
                    logger.error("error during snapshot retention task"; e);
                    slmStats.retentionFailed();
                    updateStateWithStats(slmStats);
                } finally {
                    running.set(false);
                }

 

"With Opster, we’ve been able to reduce our hardware costs by over $4 million."

Arpit Ghiya

Senior Lead SRE at Coupa

Read Case Study

Watch product tour

Try AutoOps to find & fix Elasticsearch problems

Analyze Your Cluster
Related Articles

Choose the Correct Number of Shards

How to Handle Recurring RED Status

How OzTam Improved Search Performance

Skip to content