Elasticsearch Repository

Average Read Time

1 Mins

Elasticsearch Repository

Opster Team

October 2021

Average Read Time

1 Mins


In addition to reading this guide, we recommend you run the Elasticsearch Health Check-Up. It will detect issues and improve your Elasticsearch performance by analyzing your shard sizes, threadpools, memory, snapshots, disk watermarks and more.

The Elasticsearch Check-Up is free and requires no installation.

To review your snapshot operations and repository settings, you can run the Elasticsearch Health Check-Up. It will also help you detect other important configurations that can improve your performance and prevent future issues.

Run the Elasticsearch check-up to receive recommendations like this:

checklist Run Check-Up
error

The following configuration error was detected on node 123...

error-img

Description

This error can have a severe impact on your system. It's important to understand that it was caused by...

error-img

Recommendation

In order to resolve this issue and prevent it from occurring again, we recommend that you begin by changing the configuration to...

1

X-PUT curl -H "Content-Type: application/json" [customized recommendation]

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 typeConfiguration type
Shared file systemType: “fs”
S3Type : “s3”
HDFSType :“hdfs”
AzureType: “azure”
Google Cloud StorageType : “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.

Related log errors to this ES concept


Cannot parse the specified url
Failed to change repository
Failed to create repository
Internal repository already registered. this prevented the registration of
Non-internal repository already registered. this repository will block the
Put repository
The specified location doesnt start with any
Doesn't match any of the locations specified by path.repo because this setting is empty
Update repository
Failed to read commit point
Failed to verify repository
Failure updating cluster state

< Page: 1 of 7 >


Run the Check-Up to get a customized report like this:

Analyze your cluster
Synonyms:
repository-azure.S3-Repository, HDFS Repository