Before you dig into reading this guide, have you tried asking OpsGPT what this log means? You’ll receive a customized analysis of your log.
Try OpsGPT now for step-by-step guidance and tailored insights into your OpenSearch operation.
Briefly, this error occurs when OpenSearch fails to delete a specified index template. This could be due to insufficient permissions, non-existence of the template, or a network connectivity issue. To resolve this, ensure that the user has the necessary permissions to delete templates. Also, verify that the template you’re trying to delete actually exists. If the issue persists, check your network connection to the OpenSearch cluster.
For a complete solution to your to your search operation, try for free AutoOps for Elasticsearch & OpenSearch . With AutoOps and Opster’s proactive support, you don’t have to worry about your search operation – we take charge of it. Get improved performance & stability with less hardware.
This guide will help you check for common problems that cause the log ” Error deleting template [{}] ” to appear. To understand the issues related to this log, read the explanation below about the following OpenSearch concepts: cluster, template, metadata.
Overview
An OpenSearch cluster consists of a number of servers (nodes) working together as one. Clustering is a technology which enables OpenSearch to scale up to hundreds of nodes that together are able to store many terabytes of data and respond coherently to large numbers of requests at the same time.
Search or indexing requests will usually be load-balanced across the OpenSearch data nodes, and the node that receives the request will relay requests to other nodes as necessary and coordinate the response back to the user.
Notes and good things to know
The key elements to clustering are:
Cluster State – Refers to information about which indices are in the cluster, their data mappings and other information that must be shared between all the nodes to ensure that all operations across the cluster are coherent.
Master Node – Each cluster must elect a single master node responsible for coordinating the cluster and ensuring that each node contains an up-to-date copy of the cluster state.
Cluster Formation – OpenSearch requires a set of configurations to determine how the cluster is formed, which nodes can join the cluster, and how the nodes collectively elect a master node responsible for controlling the cluster state. These configurations are usually held in the opensearch.yml config file, environment variables on the node, or within the cluster state.
Node Roles – In small clusters it is common for all nodes to fill all roles; all nodes can store data, become master nodes or process ingestion pipelines. However as the cluster grows, it is common to allocate specific roles to specific nodes in order to simplify configuration and to make operation more efficient. In particular, it is common to define a limited number of dedicated master nodes.
Replication – Data may be replicated across a number of data nodes. This means that if one node goes down, data is not lost. It also means that a search request can be dealt with by more than one node.
Common problems
Many OpenSearch problems are caused by operations which place an excessive burden on the cluster because they require an excessive amount of information to be held and transmitted between the nodes as part of the cluster state. For example:
- Shards too small
- Too many fields (field explosion)
Problems may also be caused by inadequate configurations causing situations where the OpenSearch cluster is unable to safely elect a Master node. These type problems include:
- Master node not discovered
- Split brain problem
Backups
Because OpenSearch is a clustered technology, it is not sufficient to have backups of each node’s data directory. This is because the backups will have been made at different times and so there may not be complete coherency between them. As such, the only way to backup an OpenSearch cluster is through the use of snapshots, which contain the full picture of an index at any one time.
Cluster resilience
When designing an OpenSearch cluster, it is important to think about cluster resilience. In particular – what happens when a single node goes down? And for larger clusters where several nodes may share common services such as a network or power supply – what happens if that network or power supply goes down? This is where it is useful to ensure that the master eligible nodes are spread across availability zones, and to use shard allocation awareness to ensure that shards are spread across different racks or availability zones in your data center.
Overview
Metadata in OpenSearch refers to additional information stored for each document. This is achieved using the specific metadata fields available in OpenSearch. 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
- Meta fields available include: _index, _type, _id, _source, _size, and _field_name.
Log Context
Log “Error deleting template [{}]” classname is TemplateUpgradeService.java.
We extracted the following from OpenSearch source code for those seeking an in-depth context :
public void onFailure(Exception e) {
anyUpgradeFailed.set(true);
if (e instanceof IndexTemplateMissingException == false) {
// we might attempt to delete the same template from different nodes - so that's ok if template doesn't exist
// otherwise we need to warn
logger.warn(new ParameterizedMessage("Error deleting template [{}]"; template); e);
}
tryFinishUpgrade(anyUpgradeFailed);
}
});
}
