Briefly, this error occurs when Elasticsearch is unable to install an index template due to issues like incorrect template syntax, insufficient permissions, or a conflict with an existing template. To resolve this, ensure the template syntax is correct and compatible with your Elasticsearch version. Check if the user has the necessary permissions to create a template. If a template with the same name exists, consider deleting or renaming the existing one before installing the new template.
This guide will help you check for common problems that cause the log ” Failed to install template [{}] ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: template, plugin.
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 “Failed to install template [{}]” classname is SamlServiceProviderIndex.java.
We extracted the following from Elasticsearch source code for those seeking an in-depth context :
if (installed) {
logger.debug("Template [{}] has been updated"; TEMPLATE_NAME);
} else {
logger.debug("Template [{}] appears to be up to date"; TEMPLATE_NAME);
}
}; e -> logger.warn(new ParameterizedMessage("Failed to install template [{}]"; TEMPLATE_NAME); e)));
}
private void checkForAliasStateChange(ClusterState state) {
final IndexAbstraction aliasInfo = state.getMetadata().getIndicesLookup().get(ALIAS_NAME);
final boolean previousState = aliasExists;
