OpenSearch Cluster

Open-source ideas and community collaboration underlie the OpenSearch Cluster search engine. It makes it simple for users to search, aggregate, examine, and analyze their data, making it perfect for application searches or log analytics. A safe, excellent search and analytics package that can be expanded with new capabilities is provided by OpenSearch.

Note: OpenSearch is based on Elasticsearch 7.10.2, licensed under Apache 2.0, which means it can be used, modified, extended, monetized, and resold freely.

This guide covers:

OpenSearch Cluster Components Overview

The platform provides an OpenSearch Cluster using three certified stacks integrated into a unified auto-clustering solution:

  • OpenSearch: A community-driven, open-source search engine with distributed, multitenant full-text search capabilities.
  • OpenSearch Dashboards (optional): A visualization tool for data stored in OpenSearch nodes, derived from Kibana 7.10.2.
  • Logstash (optional): Data processing tool.
Tip: You can also install the Beats add-on for single-purpose data shippers that send data from client nodes to Logstash or OpenSearch.

In this setup, Beats Data Shippers collect data on client nodes, send it to Logstash for processing, and store it in OpenSearch. OpenSearch Dashboards serves as the visualization tool.

Save $100 in the next
5:00 minutes?

Register Here

OpenSearch

The OpenSearch stack is the core and mandatory component of the cluster. It operates in cluster mode even with a single node, facilitating easier, faster, and safer horizontal scaling.

Once created, the OpenSearch node communicates internally on port 9200 and externally on port 4848 through a shared load balancer, using HTTP basic authentication (password can be reset via the Reset Password button).

Reset Password

The OpenSearch stack includes functionality found in other certified templates, such as the dashboard file manager, Web SSH, and dashboard log viewer.

The platform’s redeploy functionality simplifies updates, allowing redeployment only to the same or newer versions, as downgrades are not permitted.

OpenSearch Dashboards

The OpenSearch node is accessible via a browser, displaying only JSON API responses necessary for API interactions.

The primary tool for visualizing data is OpenSearch Dashboards, which replaces Kibana. All interconnection configurations are handled automatically, making the solution ready to use immediately without any manual setup. You can access it with the same credentials as the OpenSearch node.

OpenSearch Log in Credentials

Once logged in, the OpenSearch Dashboards interface appears. This dashboard provides a user-friendly interface for interacting with the OpenSearch API and editing your data after creating the index pattern.

OpenSearch Dashboard

Note: OpenSearch Dashboards are integrated with OpenSearch and cannot be deployed separately. It supports only one node, as scaling offers no additional advantages.

All standard features of certified templates, such as the dashboard file manager, Web SSH, firewall, and logs, are available for this node.

Save $100 in the next
5:00 minutes?

Register Here

Logstash

Logstash is a data processor component within the OpenSearch cluster that the platform configures automatically. Below is an example of the default auto-configuration found in /etc/logstash/conf.d/logstash-sample.conf:

Default Auto configuration

The input for Beats is set on port 5044. The OpenSearch output is configured by specifying the hosts, username, and password for interconnection.

Additional input plugins can be installed using the logstash-plugin tool, and configurations can be added to the same file with a different port.

Note: Logstash is part of the OpenSearch stack and cannot be deployed separately. You can add multiple Logstash nodes as needed, with scaling in stateful mode to provide initial configurations. Each node can be reconfigured for various data transformations.

Beats Add-On

Beats is an open platform for single-purpose data shippers that send data from client nodes to Logstash or OpenSearch.

You can install the Beats add-on on any node (except alpine-based ones) created within the platform and specify credentials to connect to the OpenSearch cluster or a custom Docker with an Elasticsearch instance. Two versions of the add-on are available:

Note: For direct connection, add the following line to the OpenSearch config and restart the node:


compatibility.override_main_response_version: true
  • Latest: Ships data to OpenSearch through Logstash

Elastic Beats

During installation, provide the following information:

  • Installed Agents: Select the required Beats types:
    • Filebeat: Centralizes logs and files with presets available for many certified nodes: Apache, NGINX, HAProxy, Redis, Postgres, MySQL, MariaDB, Percona, MongoDB, and Tomcat/TomEE (requires special configurations).
    • Metricbeat: Collects metrics from systems and services.
    • Journalbeat: Forwards log data from systemd journals to OpenSearch or Logstash.
    • Packetbeat: Monitors network traffic for performance and security, acting as a lightweight network packet analyzer.
    • Heartbeat: Monitors service availability with active probing and ships the data for further analysis.
  • Beats OSS Version: Select the desired version of the agent.
  • OpenSearch Host: Enter the OpenSearch (or Elasticsearch) host.
  • Credentials: Provide user and password information for the specified OpenSearch host.
  • OpenSearch Dashboards Host: Enter the OpenSearch Dashboards host, if needed for visualization.
  • Logstash Host: Enter the Logstash host if data interconnection is through Logstash.
Note: Simultaneous data output to OpenSearch and Logstash is not supported; only one output can be used at a time. If using Logstash, specify only the Logstash host and port without needing OpenSearch host and credentials.
  • Environment Name: Choose the target environment.
  • Nodes: Select the target layer.

These settings can be edited for an already installed add-on using the Configure button.

Configure

Installing an OpenSearch Cluster

Creating an OpenSearch Cluster on the platform is a simple, automated process that you can perform using the topology wizard.

Go to the NoSQL database section and select the OpenSearch stack.

Configure OpenSearch

The auto-clustering feature ensures the stack is configured as a cluster automatically. You also have the option to add OpenSearch Dashboards and Logstash components.

Save $100 in the next
5:00 minutes?

Register Here

The OpenSearch project, which was forked from the final Elasticsearch release under the Apache 2.0 license, offers nearly identical functionality. The APIs are completely compatible.

Here, we present performance test results from two Magento environments with identical topologies:

  • Magento with Elasticsearch

Magento with Elasticsearch

  • Magento with OpenSearch

Magento with OpenSearch

Save $100 in the next
5:00 minutes?

Register Here