Link Search Menu Expand Document Documentation Menu
Documentation

OpenSearch Benchmark

OpenSearch Benchmark is a macrobenchmark utility provided by the OpenSearch Project. You can use OpenSearch Benchmark to gather performance metrics from an OpenSearch cluster for a variety of purposes, including:

  • Tracking the overall performance of an OpenSearch cluster.
  • Informing decisions about when to upgrade your cluster to a new version.
  • Determining how changes to your workflow—such as modifying mappings or queries—might impact your cluster.

OpenSearch Benchmark can be installed directly on a compatible host running Linux or macOS. You can also run OpenSearch Benchmark in a Docker container. See Installing OpenSearch Benchmark for more information.

The following diagram visualizes how OpenSearch Benchmark works when run against a local host:

Benchmark workflow.

The OpenSearch Benchmark documentation is split into five sections:

  • Quickstart: Learn how to quickly run and install OpenSearch Benchmark.
  • User guide: Dive deep into how OpenSearch Benchmark can help you track the performance of your cluster.
  • Tutorials: Use step-by-step guides for more advanced benchmarking configurations and functionality.
  • Commands: A detailed reference of commands and command options supported by OpenSearch.
  • Workloads: A detailed reference of options available for both default and custom workloads.
350 characters left

Have a question? .

Want to contribute? or .