Add throughput and latency documentation #6910

Naarcha-AWS · 2024-04-05T17:00:54Z

Also adds a new concepts section the OpenSearch Benchmark user guide.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Archer <[email protected]>

Naarcha-AWS · 2024-04-05T17:08:58Z

@IanHoang: This is ready for your review.

IanHoang · 2024-04-05T17:38:12Z

_benchmark/user-guide/concepts/concepts.md

+
+## Core concepts and definitions
+
+- **Workload**: The description 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. You can list the available workloads by using `opensearch-benchmark list workloads` or view any included workloads in the [OpenSearch Benchmark Workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads/). For more information about the elements of a workload, see [Anatomy of a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-workloads/anatomy-of-a-workload/). For information about building a custom workload, see [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/creating-custom-workloads/).


"The description of" --> "A collection of"

"workflow" --> "workload"

IanHoang · 2024-04-05T18:21:49Z

_benchmark/user-guide/concepts/concepts.md

+A workload is a specification of one or more benchmarking scenarios. A workload typically includes the following:
+
+- One or more data streams that are ingested into indexes.
+- A set of queries and operations that are invoked as part of the benchmark.


This can be migrated to be under the Workload bullet point above. We can also remove the sentence "A workload is a specification of one or more benchmarking scenarios" since it' mentioned in the first sentence of the workload bullet point.

IanHoang · 2024-04-05T18:22:54Z

_benchmark/user-guide/concepts/time-latency.md


 At the end of each test, OpenSearch Benchmark produces a table that summarizes the following: 

+- [Took time](#took-time)
 - [Service time](#service-time) 
 - Throughput


Nit: Would recommend putting throughput first in this list of points

That would group the time-based metrics together and ordering the table of contents in the same order as the headers

Remove throughput on line 16

IanHoang · 2024-04-05T18:23:59Z

_benchmark/user-guide/concepts/time-latency.md

 - The error rate for each completed task or OpenSearch operation.

+The following diagram illustrates how each component of the table is measured during the life cycle of a request from an OpenSearch cluster to the OpenSearch client:


"request from an OpenSearch cluster to the OpenSearch client" --> "request involving the OpenSearch cluster, the OpenSearch client, and OpenSearch Benchmark"

images/benchmark/concepts-diagram.png

_benchmark/user-guide/concepts/time-latency.md

IanHoang

Left some comments

_benchmark/user-guide/concepts/concepts.md

Signed-off-by: Naarcha-AWS <[email protected]>

_benchmark/user-guide/concepts/time-latency.md

Signed-off-by: Naarcha-AWS <[email protected]>

_benchmark/user-guide/concepts/concepts.md

Signed-off-by: Naarcha-AWS <[email protected]>

_benchmark/user-guide/concepts.md

IanHoang

Suggested two quick changes and overall looks good

Signed-off-by: Naarcha-AWS <[email protected]>

vagimeli

Looks good overall. Please see my suggested edits and comments.

vagimeli · 2024-04-16T16:12:34Z

_benchmark/user-guide/concepts.md

@@ -11,7 +13,9 @@ Before using OpenSearch Benchmark, familiarize yourself with the following conce

 ## Core concepts and definitions

- **Workload**: The description 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. You can list the available workloads by using `opensearch-benchmark list workloads` or view any included workloads in the [OpenSearch Benchmark Workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads/). For more information about the elements of a workload, see [Anatomy of a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-workloads/anatomy-of-a-workload/). For information about building a custom workload, see [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/creating-custom-workloads/).
+- **Workload**: A collection 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 workload runs. You can list the available workloads by using `opensearch-benchmark list workloads` or view any included workloads in the [OpenSearch Benchmark Workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads/). For more information about the elements of a workload, see [Anatomy of a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-workloads/anatomy-of-a-workload/). For information about building a custom workload, see [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/creating-custom-workloads/).  A workload typically includes the following:


I suggest breaking up this paragraph for ease of readability.

_benchmark/user-guide/concepts.md