Before you begin reading this guide, we recommend you try running the Elasticsearch Error Check-Up which analyzes 2 JSON files to detect many configuration 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.
This guide will help you check for common problems that cause the log ” Failed to execute cluster state update ” + source + ” ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: repositories, source, blobstore and 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.
Overview
When a document is sent for indexing, Elasticsearch indexes all the fields in the format of an inverted index, but it also keeps the original JSON document in a special field called _source.
Examples
Disabling source field in the index:
PUT /api-logs?pretty
{
"mappings": {
"_source": {
"enabled": false
}
}
}Store only selected fields as a part of _source field:
PUT api-logs
{
"mappings": {
"_source": {
"includes": [
"*.count",
"error_info.*"
],
"excludes": [
"error_info.traceback_message"
]
}
}
}Including only selected fields using source filtering:
GET api-logs/_search
{
"query": {
"match_all": {}
},
"_source": {
"includes": ["api_name","status_code", "*id"]
}
}Notes
The source field brings an overhead of extra storage space but serves special purposes such as:
- Return as a part of the response when a search query is executed.
- Used for reindexing purpose, update and update_by_query operations.
- Used for highlighting, if the field is not stored, it means the field is not set as “store to true” inside the mapping.
- Allows selection of fields to be returned.
The only concern with source field is the extra storage usage on disk. But this storage space used by source field can be optimized by changing compression level to best_compression. This setting is done using index.codec parameter.
Log Context
Log “Failed to execute cluster state update [” + source + “]”classname is BlobStoreRepository.java We extracted the following from Elasticsearch source code for those seeking an in-depth context :
}
@Override
public void onFailure(String source; Exception e) {
listener.onFailure(
new RepositoryException(metadata.name(); "Failed to execute cluster state update [" + source + "]"; e));
}
@Override
public void clusterStateProcessed(String source; ClusterState oldState; ClusterState newState) {
setPendingStep.onResponse(newGen);
See how you can use AutoOps to resolve issues
