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

Prevent Your Next ELK Incident

Try our free Check Up to test if your ES issues are caused from misconfigured settings

Prevent Issue

Updated: Jan-20

In-Page Navigation (click to jump) :

Opster Offer’s World-Class Elasticsearch Expertise In One Powerful Product
Try Our Free ES Check-Up   Prevent Incident

Troubleshooting background

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

Metadata in Elasticsearch

What it is

Metadata in Elasticsearch refers to storing some additional information for each document. This is achieved using the specific metadata fields available in Elasticsearch. The default behavior of some of these metadata fields can be customized during mapping creation.

Examples

Using _meta meta-field for storing application-specific information with the mapping:

PUT /my_index?pretty
{
  "mappings": {
    "_meta": { 
      "domain": "security",
      "release_information": {
        "date": "18-01-2020",
        "version": "7.5"
      }
    }
  }
}

Notes
  • In version 2.x, Elasticsearch had a total 13 meta fields available, which are: _index, _uid, _type, _id, _source, _size, _all, _field_names, _timestamp, _ttl, _parent, _routing, _meta
  • In version 5.x, _timestamp and _ttl meta fields were removed.
  • In version 6.x, the _parent meta field was removed.
  • In version 7.x, _uid and _all meta fields were removed.

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 Github Issue Number 46224  

2Github Issue Number 41172  


Log Context

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

<pre class="wp-block-syntaxhighlighter-code">             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
                // else tinkering with the templates during the upgrade.
                final ImmutableOpenMap<String; IndexTemplateMetaData> upgradedTemplates =




</pre>


About Opster

Opster identifies and predicts root causes of Elasticsearch problems, provides recommendations and can automatically perform various actions to prevent issues, optimize performance and save resources.

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

Need help with any Elasticsearch issue ? Contact Opster