Briefly, this error occurs when there is an attempt to upgrade a component template in Elasticsearch from one version to another, but the version details are not specified or are incorrect. To resolve this issue, ensure that the correct version numbers are provided during the upgrade process. Also, verify that the component template exists and is compatible with the version you are upgrading to. Lastly, check for any syntax errors in your upgrade command.
This guide will help you check for common problems that cause the log ” upgrading component template [{}] for [{}] from version [{}] to version [{}] ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: template, plugin, version.
If you want to learn more about Elasticsearch templates, check out this guide.
Overview
A template in Elasticsearch falls into one of the two following categories and is indexed inside Elasticsearch using its dedicated endpoint:
- Index templates, which are a way to define a set of rules including index settings, mappings and an index pattern. The template is applied automatically whenever a new index is created with the matching pattern. Templates are also used to dynamically apply custom mapping for the fields which are not predefined inside existing mapping.
- Search templates, which help in defining templates for search queries using mustache scripting language. These templates act as a placeholder for variables defined inside the search queries.
Examples
Create a dynamic index template
PUT /_template/template_1?pretty { "index_patterns": [ "logs*", "api*" ], "settings": { "number_of_shards": 2 }, "mappings": { "dynamic_templates": [ { "strings": { "match_mapping_type": "string", "mapping": { "type": "keyword" } } } ], "properties": { "host_name": { "type": "keyword" }, "created_at": { "type": "date" } } } }
Create a search template
POST /_scripts/search_template_1?pretty { "script": { "lang": "mustache", "source": { "query": { "match": { "description": "{{query_string}}" } } } } }
Executing a search query using search template
GET /_search/template?pretty { "id": "search_template_1", "params": { "query_string": "hello world" } }
The search request will be executed by default on all the indices available in the cluster and can be limited to particular indices using an index parameter.
Notes
- A dynamic index template is always useful when you do not know the field names in advance and want to control their mapping as per the business use case.
Overview
A version corresponds to the Elasticsearch built-in tracking system that tracks the changes in each document’s update. When a document is indexed for the first time, it is assigned a version 1 using _version key. When the same document gets a subsequent update, the _version is incremented by 1 with every index, update or delete API call.
What it is used for
A version is used to handle the concurrency issues in Elasticsearch which come into play during simultaneous accessing of an index by multiple users. Elasticsearch handles this issue with an optimistic locking concept using the _version parameter to avoid letting multiple users edit the same document at the same time and protects users from generating incorrect data.
Notes
You cannot see the history of the document using _version. That means Elasticsearch does not use _version to keep a track of original changes that had been performed on the document. For example, if a document has been updated 10 times, it’s _version would be marked by Elasticsearch as 11, but you cannot go back and see what version 5 of the document looked like. This has to be implemented independently.
Common problems
If optimistic locking is not implemented while making updates to a document, Elasticsearch may return a conflict error with the 409 status code, which means that multiple users are trying to update the same version of the document at the same time.
POST /ratings/123?version=50 { "name": "Joker", "rating": 50 }
Log Context
Log “upgrading component template [{}] for [{}] from version [{}] to version [{}]” classname is IndexTemplateRegistry.java.
We extracted the following from Elasticsearch source code for those seeking an in-depth context :
logger.debug("adding component template [{}] for [{}]; because it doesn't exist"; templateName; getOrigin()); putComponentTemplate(newTemplate; creationCheck); } else if (Objects.isNull(currentTemplate.version()) || newTemplate.getVersion() > currentTemplate.version()) { // IndexTemplateConfig now enforces templates contain a `version` property; so if the template doesn't have one we can // safely assume it's an old version of the template. logger.info("upgrading component template [{}] for [{}] from version [{}] to version [{}]"; templateName; getOrigin(); currentTemplate.version(); newTemplate.getVersion()); putComponentTemplate(newTemplate; creationCheck); } else { creationCheck.set(false); logger.trace("not adding component template [{}] for [{}]; because it already exists at version [{}]";