Before you dig into reading this guide, have you tried asking OpsGPT what this log means? You’ll receive a customized analysis of your log.
Try OpsGPT now for step-by-step guidance and tailored insights into your OpenSearch operation.
Briefly, this error occurs when OpenSearch is unable to create a snapshot repository due to issues like incorrect repository settings, insufficient permissions, or connectivity problems with the storage location. To resolve this, ensure that the repository settings are correct, the OpenSearch cluster has the necessary permissions to access the repository, and the storage location is accessible. Also, check if the repository plugin is properly installed and enabled. If the issue persists, consider checking the OpenSearch logs for more detailed error information.
For a complete solution to your to your search operation, try for free AutoOps for Elasticsearch & OpenSearch . With AutoOps and Opster’s proactive support, you don’t have to worry about your search operation – we take charge of it. Get improved performance & stability with less hardware.
This guide will help you check for common problems that cause the log ” put repository [{}] ” to appear. To understand the issues related to this log, read the explanation below about the following OpenSearch concepts: repository, repositories.
Quick links
Overview
An OpenSearch 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 opensearch.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 “put repository [{}]” classname is RepositoriesService.java.
We extracted the following from OpenSearch source code for those seeking an in-depth context :
ensureRepositoryNotInUse(currentState; request.name());
Metadata metadata = currentState.metadata();
Metadata.Builder mdBuilder = Metadata.builder(currentState.metadata());
RepositoriesMetadata repositories = metadata.custom(RepositoriesMetadata.TYPE);
if (repositories == null) {
logger.info("put repository [{}]"; request.name());
repositories = new RepositoriesMetadata(
Collections.singletonList(new RepositoryMetadata(request.name(); request.type(); request.settings()))
);
} else {
boolean found = false;
