Elasticsearch OpenSearch Routing

By Opster Team

Updated: Aug 29, 2023

| 1 min read

Before you dig into the details of this technical guide, have you tried asking OpsGPT?

You'll receive concise answers that will help streamline your Elasticsearch/OpenSearch operations.


Try OpsGPT now for step-by-step guidance and tailored insights into your Elasticsearch/ OpenSearch operation.

Before you dig into the details of this guide, have you tried asking OpsGPT? You’ll receive concise answers that will help streamline your OpenSearch/Elasticsearch operation.

Try OpsGPT now for step-by-step guidance and tailored insights into your search operation.

To easily resolve issues in your deployment and locate their root cause, try AutoOps for OpenSearch. It diagnoses problems by analyzing hundreds of metrics collected by a lightweight agent and offers guidance for resolving them. Try AutoOps for free.

Overview

What is OpenSearch routing?

In OpenSearch, routing refers to document routing. When you index a document, OpenSearch will determine which shard the document should be routed to for indexing.

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. 

How helpful was this guide?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?


Related log errors to this OS concept


Command missing the index parameter
Command missing the shard parameter
Command missing the from node parameter
Command missing the to node parameter
Command missing the node parameter
Failed to parse weighted routing metadata expected object
Source shard routingEntry is not an active primary
Empty request body
Failed to generate source
Failed to parse delete weighted routing request body
Failed to parse weighted routing request object
Failed to parse weighted routing request attribute

< Page: 2 of 6 >

Get expert answers on Elasticsearch/OpenSearch