Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 38 additions & 7 deletions _benchmark/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,30 @@ permalink: /benchmark/
redirect_from:
- /benchmark/index/
- /benchmark/tutorials/index/
tutorial_cards:
- heading: "Get started with OpenSearch Benchmark"
description: "Run your first OpenSearch Benchmark workload and receive performance metrics"
link: "/benchmark/quickstart/"
- heading: "Choosing a workload"
description: "Choose a benchmark workload based on your cluster's use case"
link: "/benchmark/user-guide/understanding-workloads/choosing-a-workload/"
more_cards:
- heading: "User guide"
description: "Learn how to benchmark the performance of your cluster"
link: "/benchmark/user-guide/index/"
- heading: "Reference"
description: "Learn about OpenSearch Benchmark commands and options"
link: "/benchmark/reference/index/"
items:
- heading: "Install and configure OpenSearch Benchmark"
description: "Install OpenSearch Benchmark and configure your experience"
link: "/benchmark/user-guide/install-and-configure/installing-benchmark/"
- heading: "Run a workload"
description: "Run a workload and receive performance metrics."
link: "/benchmark/user-guide/working-with-workloads/running-workloads/"
- heading: "Analyze performance metrics"
description: "View your benchmark report and analyze your metrics"
link: "/benchmark/user-guide/understanding-results/summary-reports/"
---

# OpenSearch Benchmark
Expand All @@ -19,18 +43,25 @@ OpenSearch Benchmark is a macrobenchmark utility provided by the [OpenSearch Pro
- 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.

## Get started

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]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/) for more information.
{: .info }

{% include cards.html cards=page.tutorial_cards %}

{% include list.html list_items=page.items%}

<span class="centering-container">
[Get started]({{site.url}}{{site.baseurl}}/benchmark/quickstart/){: .btn-dark-blue}
</span>

## Customize your benchmarks

The following diagram visualizes how OpenSearch Benchmark works when run against a local host:
{% include cards.html cards=page.more_cards %}

![Benchmark workflow]({{site.url}}{{site.baseurl}}/images/benchmark/osb-workflow.jpg).

The OpenSearch Benchmark documentation is split into four sections:

- [Quickstart]({{site.url}}{{site.baseurl}}/benchmark/quickstart/): Learn how to quickly run and install OpenSearch Benchmark.
- [User guide]({{site.url}}{{site.baseurl}}/benchmark/user-guide/index/): Dive deep into how OpenSearch Benchmark can help you track the performance of your cluster.
- [Tutorials]({{site.url}}{{site.baseurl}}/benchmark/tutorials/index/): Use step-by-step guides for more advanced benchmarking configurations and functionality.
- [Reference]({{site.url}}{{site.baseurl}}/benchmark/reference/index/): A detailed reference of metrics, commands, telemetry devices, and workloads.



Expand Down
27 changes: 27 additions & 0 deletions _benchmark/user-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,35 @@ layout: default
title: User guide
nav_order: 5
has_children: true
user_cards:
- heading: "Concepts"
description: "Learn core OpenSearch Benchmark concepts"
link: "/benchmark/user-guide/concepts/"
- heading: "Install and configure OpenSearch Benchmark"
description: "Install OpenSearch Benchmark and configure your experience"
link: "/benchmark/user-guide/install-and-configure/index/"
- heading: "Understanding workloads"
description: "Dive deep into each workload component and choose a workload
link: "/benchmark/user-guide/understanding-workloads/index/"
- heading: "Run and customize your workload"
description: "Run and customize your OpenSearch workload to get the most accurate results"
link: "/benchmark/user-guide/working-with-workloads/index/"
- heading: "Understanding your results"
description: "Analyze and store your benchmark results"
link: "/benchmark/user-guide/understanding-results/index/"
- heading: "Optimizing benchmarks"
description: "Optimize your benchmark experience through randomization and best practices"
link: "/benchmark/user-guide/optimizing-benchmarks/index/"
---

# OpenSearch Benchmark User Guide

The OpenSearch Benchmark User Guide includes core [concepts]({{site.url}}{{site.baseurl}}/benchmark/user-guide/concepts/), [installation]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/) instructions, and [configuration options]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) to help you get the most out of OpenSearch Benchmark.

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

![Benchmark workflow]({{site.url}}{{site.baseurl}}/images/benchmark/osb-workflow.jpg).

## Sections

{% include cards.html cards=page.user_cards %}
20 changes: 19 additions & 1 deletion _benchmark/user-guide/optimizing-benchmarks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,26 @@ title: Optimizing benchmarks
nav_order: 25
parent: User guide
has_children: true
more_cards:
- heading: "Running distributed loads"
description: "Configure multiple load generator machines to run large-scale benchmarks"
link: "/benchmark/user-guide/optimizing-benchmarks/distributed-load/"
- heading: "Expanding a workload's data corpus"
description: "Increase dataset size and complexity for more realistic benchmark scenarios"
link: "/benchmark/user-guide/optimizing-benchmarks/expand-data-corpus/"
- heading: "Target throughput"
description: "Set specific throughput targets to match your production workload patterns"
link: "/benchmark/user-guide/optimizing-benchmarks/target-throughput/"
- heading: "Performance testing best practices"
description: "Follow these best practices to achieve more meaningful benchmark results"
link: "/benchmark/user-guide/optimizing-benchmarks/performance-testing-best-practices/"
- heading: "Randomizing queries"
description: "Generate varied search patterns to simulate real-world queries"
link: "/benchmark/user-guide/optimizing-benchmarks/randomizing-queries/"
---

# Optimizing benchmarks

This section details different ways you can optimize the benchmark tools for your cluster.
This section provides information about optimizing the benchmark tools for your cluster.

{% include cards.html cards=page.more_cards %}
12 changes: 11 additions & 1 deletion _benchmark/user-guide/understanding-workloads/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,21 @@ title: Understanding workloads
nav_order: 10
parent: User guide
has_children: true
items:
- heading: "Anatomy of a workload"
description: "Understand each component of a workload"
link: "/benchmark/user-guide/understanding-workloads/anatomy-of-a-workload/"
- heading: "Choosing a workload"
description: "Determine which workload best matches your dataset"
link: "/benchmark/user-guide/understanding-workloads/choosing-a-workload/"
- heading: "Common operations"
description: "Familiarize yourself with common operations"
link: "/benchmark/user-guide/understanding-workloads/common-operations/"
---

# Understanding workloads

OpenSearch Benchmark includes a set of [workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads) that you can use to benchmark data from your cluster. Workloads contain descriptions of one or more benchmarking scenarios that use a specific document corpus to perform a benchmark against your cluster. The document corpus contains any indexes, data files, and operations invoked when the workflow runs.


{% include list.html list_items=page.items%}

Loading