Deleting weighted routing metadata from the cluster state – How to solve this OpenSearch error

Overview

The shard is selected based on the following formula:

shard = hash(_routing) % number_of_primary_shards

Where the default value of _routing is _id.
It is important to know which shard the document is routed to because OpenSearch will need to determine where to find that document later on for document retrieval requests. 

Examples

In twitter index with 2 primary shards, the document with _id equal to “440” gets routed to the shard number:   

shard = hash( 440 ) % 2
PUT twitter/_doc/440
{
...
}

Notes and good things to know

• In order to improve search speed, you can create custom routing. For example, you can enable custom routing that will ensure that only a single shard will be queried (the shard that contains your data).
• To create custom routing in OpenSearch, you will need to configure and define that not all routing will be completed by default settings. ( v <= 5.0)

PUT my_index/customer/_mapping
{
   "order":{
      "_routing":{
         "required":true
      }
   }
}

•  This will ensure that every document in the “customer” type must specify a custom routing. 

Overview

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.