OpenSearch Basics

< Back to all guides
Cross-Cluster Search in Elasticsearch & OpenSearch

Cross-cluster search enables users to execute a query across multiple Elasticsearch or OpenSearch clusters. To perform cross cluster search...

How to Install OpenSearch on EC2 Using Terraform

To install OpenSearch on EC2, you will need a route-53 resource that connects to your VPC. The Terraform module will deploy 3 EBS, 5 EC2...

How to Install OpenSearch on Kubernetes (Using HELM charts)

Helm is the best way to find, share, and use software built for Kubernetes. To install OpenSearch using Helm charts, you need to first...

How to Migrate from Elasticsearch to OpenSearch

OpenSearch supports migration to Elasticsearch using rolling upgrades. There're 4 methods to migrate data from Elasticsearch to OpenSearch...

How to migrate from Elasticsearch to OpenSearch for versions after 7.10

If you’re using Elasticsearch version 7.11 or later, you cannot use rolling upgrades to migrate to OpenSearch. Instead, you can use these...

How to Set Up & Operate OpenSearch on Kubernetes Using the Open-Source Operator

Installation instructions, advantages of using the Operator for OpenSearch management, tips and benefits of...

How to Set Up Alerting in OpenSearch

There are 3 types of OpenSearch alerts: system, logs, & business specific. Before creating an alert you need to set a channel. An example...

OpenSearch _source

OpenSearch keeps the original JSON document in a field called _source. The source field serves special purposes such as...

OpenSearch Aggregations

The aggregations framework is a tool built in every OpenSearch deployment. The different aggregation types: Bucket, Metric & Pipeline...

OpenSearch Alias

An OpenSearch alias is a secondary name to refer to one or more indices. Aliases can be created and deleted dynamically using...

OpenSearch Bulk

OpenSearch bulk makes it possible to perform many write operations in a single API call, which increases indexing speed. Using bulk API...

OpenSearch Cache: Node Request, Shard Data & Field Data Cache

OpenSearch uses 3 types of caches to improve the efficiency of operation: node requests, shards and field data cache. To clear...

OpenSearch Circuit Breaker Exceptions: How to Handle Circuit Breakers

Circuit breaker exceptions are thrown to alert us that something needs to be fixed in OpenSearch in order to reduce memory usage. To fix...

OpenSearch Circuit Breakers

OpenSearch has circuit breakers to deal with OutOfMemory errors that cause nodes to crash. To size a circuit breaker...

OpenSearch Client

Official OpenSearch clients are available for java, Perl, PHP, python, ruby and .NET. The official clients follow a similar structure and...

OpenSearch Cluster

An OpenSearch cluster is a group of servers (nodes) working together to store data & respond to requests. The key elements of clustering...

OpenSearch Dashboards vs Kibana: A Comprehensive Comparison

This article will compare OpenSearch Dashboards and Kibana, highlighting their similarities, differences, and...

OpenSearch DELETE

DELETE is an OpenSearch API that removes a document from a specific index. It requires an index name & _id document to delete the document. 

OpenSearch Delete By Query

OpenSearch delete by query is an API, which provides functionality to delete all documents based on the matching query. If you don't...

OpenSearch Deprecation

To find out which functions have been deprecated in OpenSearch, you can use deprecation logs, deprecation API, read breaking pages...

OpenSearch Discovery

OpenSearch discovery occurs when a node starts, restarts or loses contact with the master node. The discovery.seed_hosts...

OpenSearch Disk Threshold

OpenSearch uses several parameters to enable it to manage hard disk storage across the cluster, such as...

OpenSearch Docker - How to Spin Up a Cluster Using Docker

The easiest way to start testing OpenSearch is running the available docker image. To spin up an OpenSearch cluster using docker, you need...

OpenSearch Document

Each OpenSearch document is a JSON structure, which is ultimately considered to be a series of key:value pairs. An example for creating...

OpenSearch Fielddata

In OpenSearch the term Fielddata is relevant when performing sorting and aggregations on text field. To set fielddata=true, you...

OpenSearch Filter

An OpenSearch filter applies conditions inside the query to narrow down the matching results. A filter clause can be used used in...

OpenSearch Flush, Translog and Refresh

In OpenSearch, flush is the process of permanently storing data onto the disk for all of the operations that have been stored in memory.

OpenSearch Heap Size Usage and JVM Garbage Collection

The OpenSearch heap size is the amount of RAM allocated to the JVM of a node. When JVM performance is not optimal...

OpenSearch High CPU

High CPU in OpenSearch is often a symptom of other underlying issues. It should be fixed since a distressed node will slow query response...

OpenSearch Index

An OpenSearch index contains a schema and can have one or more shards and replicas. Here's how to create, delete, list, and query an index.

OpenSearch Index - How to create, list, query and delete indices

An OpenSearch index contains a schema and can have one or more shards and replicas. Here's how to create, delete, list & query Indices.

OpenSearch Indexing

Indexing is the process of adding or updating new documents to an OpenSearch index. To index a document...

OpenSearch Lucene

OpenSearch Lucene or Apache Lucene is an open-source Java library used as a search engine. OpenSearch is built on top of Lucene...

OpenSearch Mapping

An OpenSearch mapping contains the properties of each field in the index. A common issue is an incorrectly defined mapping. To update...

OpenSearch Max Shards Per Node Exceeded

If the max of shards per node is exceeded in OpenSearch, shards can't be allocated. To fix this, check to see whether the limit is at...

OpenSearch Metadata

OpenSearch metadata refers to additional information stored for each document using metadata fields. Metadata fields can be customized...

OpenSearch Nodes & Node Roles

There are different types of OpenSearch nodes. Each has its own role and purpose. Cluster-Manager, coordinating and data node roles differ...

OpenSearch Observability Visualizations: How to Use Notebooks and Operational Panels

Dashboards are the most useful tool to visualize data without having to code an entire framework that consumes data from the engine...

OpenSearch Persistent Settings

In OpenSearch, Persistent refers to cluster settings that persist across cluster restarts. Examples of persistent settings include...

OpenSearch Plugins

Plugins in OpenSearch are used to extend the functionality of OpenSearch. To install and uninstall an OpenSearch plugin...

OpenSearch Queue

Queues in OpenSearch exist in the context of Thread Pools. Queues are used to hold the pending requests for thread pools. For example...

OpenSearch Rebalance

Cluster rebalancing is the process by which an OpenSearch cluster distributes data across the nodes. To force rebalance manually...

OpenSearch Recovery

In OpenSearch, recovery refers to the process of recovering an index or shard when something goes wrong. The recovery API can be used by...

OpenSearch Red Status

OpenSearch red status indicates not only that the primary shard has been lost, but also that a replica has not been promoted...

OpenSearch Refresh Interval

OpenSearch requires a refresh operation to make indexed information available for search. You can set an OpenSearch refresh_interval by...

OpenSearch Reindex

OpenSearch reindex is the concept of copying existing data from a source index to a destination index. The reindex API is...

OpenSearch Replication

OpenSearch replication refers to storing a redundant copy of the data. Replicas are used to provide high availability and failover of...

OpenSearch Repository

An OpenSearch repository needs to be registered using the _snapshot endpoint. The supported repository types are: S3, HDFS, Azure...

OpenSearch Restore

In OpenSearch, restore refers to a snapshot restore mechanism. To restore a snapshot, an index, or selected indices...

OpenSearch Routing

In OpenSearch, routing refers to document routing. OpenSearch will determine which shard the document will be routed to for indexing when...

OpenSearch Scroll

The OpenSearch scroll API is useful when a search returns a large set of results. Large search results are exhaustive for the system...

OpenSearch Search

To search in OpenSearch, send a GET request to the _search endpoint in the search API. In the query phase and the fetch phase there are...

OpenSearch Search Rejected Queue

An OpenSearch cluster can start to reject search requests for several reasons. To resolve this, check the state of the thread pool and..

OpenSearch Settings

OpenSearch settings can be configured on the cluster-level, node-level and index-level. Here's how to set up and optimize your settings.

OpenSearch Shards

Each OpenSearch shard is an Apache Lucene index. The number of shards is set when an index is created, and cannot be changed without...

OpenSearch Shards Too Large

It is a best practice that OpenSearch shard size should not go above 50GB for a single shard. If you go above this limit...

OpenSearch Snapshot

An OpenSearch snapshot is a backup of an index taken from a running cluster. It's better to use snapshots instead of disk backups due...

OpenSearch Task

An OpenSearch task is equivalent to an operation. OpenSearch provides a dedicated task API for the task management, which includes actions...

OpenSearch Template

An OpenSearch template falls into one of these categories: index templates or search templates. To create a dynamic index template...

OpenSearch Threadpool

OpenSearch threadpools are used to manage how requests are processed and to optimize the use of resources. An example of...

OpenSearch Upgrade

An OpenSearch upgrade of an existing cluster can be done in 2 ways: through a rolling upgrade or a full cluster restart. To update...

OpenSearch Version

A version corresponds to the OpenSearch built-in tracking system that tracks the changes in each document. By using _version...

OpenSearch Yellow Status

An OpenSearch yellow status indicates that one or more of the replica shards on the cluster are not allocated to a node. This could occur...

g2crowd

Loved by the Community ❤️

Our products are loved by over 12,000 users from the community. Thank you to our customers from all around the world!
soc2-type2