This documentation remains in a beta state. It has content gaps and might contain bugs.
This site contains the technical documentation for OpenSearch, the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
Why use OpenSearch?
OpenSearch is well-suited to the following use cases:
- Log analytics
- Real-time application monitoring
- Clickstream analytics
- Search backend
|OpenSearch||Data store and search engine|
|OpenSearch Dashboards||Search frontend and visualizations|
|Security||Authentication and access control for your cluster|
|Alerting||Receive notifications when your data meets certain conditions|
|SQL||Use SQL or a piped processing language to query your data|
|Index State Management||Automate index operations|
|KNN||Find “nearest neighbors” in your vector data|
|Performance Analyzer||Monitor and optimize your cluster|
|Anomaly Detection||Identify atypical data and receive automatic notifications|
|Asynchronous Search||Run search requests in the background|
You can install OpenSearch plugins individually or use the all-in-one packages. Most of these OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
For specifics around the project, see the FAQ.
- Install and start Docker Desktop.
Run the following commands:
docker pull opensearchproject/opensearch:1.0.0-rc1 docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:1.0.0-rc1
In a new terminal session, run:
curl -XGET --insecure https://localhost:9200 -u admin:admin
Looking for the Javadoc?
The project welcomes GitHub issues, bug fixes, features, plugins, documentation—anything at all. To get involved, see Contributing on the OpenSearch website.