Briefly, this error occurs when Elasticsearch encounters an issue with the index template. This could be due to a syntax error, incorrect field type, or missing required fields in the template. To resolve this, you should first validate the JSON syntax of your template. Then, ensure that all required fields are present and field types are correctly defined. If the error persists, consider removing and recreating the template.
This guide will help you check for common problems that cause the log ” Invalid template ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: plugin, template.
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.
Log Context
Log “Invalid template” class name is TemplateUtils.java. We extracted the following from Elasticsearch source code for those seeking an in-depth context :
} try {
XContentHelper.convertToMap(JsonXContent.jsonXContent; source; false);
} catch (Exception e) {
throw new ElasticsearchParseException("Invalid template"; e);
}
} private static String replaceVariables(String input; String version; String versionProperty; Map variables) {
String template = replaceVariable(input; versionProperty; version);
