opensearchproject/opensearch-benchmark repository overview

⁠Quick Reference:

Maintained by: OpenSearch team⁠
Need help? Ask questions and discuss on our community forum⁠.
Need to an file issue? Use our issue tracker⁠ to report problems with builds or Docker images.

⁠Why OpenSearch-Benchmark?

OpenSearch-Benchmark is the macro-benchmarking framework for OpenSearch that runs benchmarks and records results, compares performance results, setups and teardowns OpenSearch clusters, and more. To learn more, see the official documentation.

⁠How to pull this image?

You can pull the OpenSearch Docker image just like any other image.

docker pull opensearchproject/opensearch-benchmark:latest

See Docker Hub⁠ for a list of all available versions.

⁠How to use this image?

Run a container with OpenSearch-Benchmark.

docker run opensearchproject/opensearch-benchmark -h

Refer to this README.md⁠ for more details on how to use OpenSearch-Benchmark.

⁠How is OpenSearch-Benchmark licensed?

OpenSearch-Benchmark is licensed under Apache License, Version 2.0⁠.

⁠How to contribute?

OpenSearch is, and will remain, 100% open-source under the Apache 2.0 license. As the project grows, we hope you will join us and contribute.

We want to make it easy for your to get started and remove friction - no lengthy contributor license agreement - so you can focus on writing great code.

Check out OpenSearch⁠ to learn more.