How To Solve Issues Related to Log – Templates were partially upgraded to version

Get an Elasticsearch Check-Up

Check if your ES issues are caused from misconfigured settings
(Free 2 min process)

Check-Up

Last update: Jan-20

Elasticsearch Error Guide In Page Navigation (click to jump) :

Troubleshooting Background – start here to get the full picture       
Related Issues – selected resources on related issues  
Log Context – usefull for experts
About Opster – offering a diffrent approach to troubleshoot Elasticsearch

Check Your Elasticsearch Settings for Painfull Mistakes 


Troubleshooting background

To troubleshoot Elasticsearch log “Templates were partially upgraded to version” it’s important to know common problems related to Elasticsearch concepts: cluster, metadata, template, upgrade, version. See below-detailed explanations complete with common problems, examples and useful tips.

Cluster in Elasticsearch

What is it

In Elasticsearch a cluster is a collection of one or more nodes (servers / VMs). A cluster can consist of an unlimited number of nodes. The cluster provides interface for indexing and storing data and search capability across all of the data which is stored in the data nodes

Each cluster has a single master node that is elected by the master eligible nodes. In cases where the master is not available the other connected master eligible nodes elect a new master. Clusters are identified by a unique name, which defaults to “Elasticsearch”.

Metadata in Elasticsearch

What it is

Metadata is information about the data. In Elasticsearch, each document has associated metadata such as _id and _index meta fields.

Examples
  • Routing meta field:
    • _routing, a routing value that places a document in a particular shard.
  • Other meta field
    • _meta, not used by Elasticsearch but can be used to store application-specific metadata.
PUT index_01
{
  "mappings": {
    "_meta": { 
      "class": "App01::User01",
      "version": "01"
    }
  }
}

  • Identity meta fields: 
    _id , the id of the document, for example querying based on _id field
PUT index01/_doc/1
{
  "text": "Document with ID 1"
}
 
PUT index01/_doc/2
{
  "text": "Document with ID 2"
}
 
GET index01/_search
{
  "query": {
    "terms": {
      "_id": [ "1", "2" ] 
    }
  }
}

Template in Elasticsearch

What it is

A template in Elasticsearch falls into  one of the two following categories and is  indexed inside Elasticsearch using its dedicated endpoint: 

  1. 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.
  1. 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.


To help troubleshoot related issues we have gathered selected Q&A from the community and issues from Github , please review the following for further information :

1. Partial update to an index template – Stats : ♥ 0.95 K  Ι √ 1

2. Elasticsearch update index template – Stats : ♥ 10.13 K  Ι √    4


Log Context

Log ”Templates were partially upgraded to version” classname is TemplateUpgradeService.java
We have extracted the following from Elasticsearch source code to get an in-depth context :

         assert upgradesInProgress.get() > 0;
        if (upgradesInProgress.decrementAndGet() == 1) {
            try {
                // this is the last upgrade; the templates should now be in the desired state
                if (anyUpgradeFailed.get()) {
                    logger.info("Templates were partially upgraded to version {}"; Version.CURRENT);
                } else {
                    logger.info("Templates were upgraded successfully to version {}"; Version.CURRENT);
                }
                // Check upgraders are satisfied after the update completed. If they still
                // report that changes are required; this might indicate a bug or that something






About Opster

Incorporating deep knowledge and broad history of Elasticsearch issues. Opster’s solution identifies and predicts root causes of Elasticsearch problems, provides recommendations and can automatically perform various actions to manage, troubleshoot and prevent issues

Learn more: Glossary | Blog| Troubleshooting guides | Error Repository

Need help with any Elasticsearch issue ? Contact Opster

Did this page help you?