Add Benchmark glossary #8190
Add Benchmark glossary #8190
Conversation
Signed-off-by: Archer <naarcha@amazon.com>
Naarcha-AWS
requested review from
kolchfa-aws,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
_benchmark/glossary.md
Outdated
| The following terms are commonly used in OpenSearch Benchmark: | ||
|
|
||
| - **Corpora**: A collection of documents. | ||
| - **Latency**: Based on the `target-throughput` set by the user, the total amount of time that the request waits before receiving the response, in addition to any other delays that occur before the request is sent. |
There was a problem hiding this comment.
Can we rephrase this to:
If target-throughput is disabled (i.e. has no value or a value of 0), latency is equivalent to service time. If target-throughput is enabled (i.e. has a value of 1 or greater), latency is the service time plus the time the request waits in the queue before being sent.
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
|
@IanHoang: Feel free to review again. |
Naarcha-AWS
added
backport 2.17
_benchmark/glossary.md
Outdated
| - **Corpora**: A collection of documents. | ||
| - **Latency**: If `target-throughput` is disabled (has no value or a value of `0)`, latency is equivalent to service time. If `target-throughput` is enabled (has a value of 1 or greater), latency is the service time plus the time the request waits in the queue before being sent. | ||
| - **Metric keys**: The metrics that OpenSearch Benchmark stores, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-records/). | ||
| - **Operations**: In workloads, a list of API requests performed by a workload. |
There was a problem hiding this comment.
Should we say "API operations for consistency?
_benchmark/glossary.md
Outdated
| - **Metric keys**: The metrics that OpenSearch Benchmark stores, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-records/). | ||
| - **Operations**: In workloads, a list of API requests performed by a workload. | ||
| - **Pipeline**: A series of steps occurring before and after a workload is run that determines benchmark results. | ||
| - **Schedule**: In workloads, a list of operations in a specific order. |
There was a problem hiding this comment.
So, the difference between this and operations is that operations is not necessarily in order but schedule is? Also, is the order time-based, and if so, is it execution time or the time the request was put in the queue or sent?
There was a problem hiding this comment.
Not exactly. A schedule is simply a list of two or more operations performed in the order they appear at the time the workload is run. The order the operations in a schedule isn't time-based.
I'll adjust the definition accordingly.
_benchmark/glossary.md
Outdated
| - **Summary report**: A report output at the end a test based on the metric keys defined in the workload. | ||
| - **Test**: A single invocation of the OpenSearch Benchmark binary. | ||
| - **Throughput**: The number of operations completed in a given period of time. | ||
| - **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. |
There was a problem hiding this comment.
Is a scenario the same as a test?
There was a problem hiding this comment.
Yes. Though we'll switch this one to "test" for now. In Benchmark 2.0, which has yet to be released, we are renaming "tests" --- "scenarios".
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
5 - Editorial review
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
* Add Benchmark glossary Signed-off-by: Archer <naarcha@amazon.com> * Add text Signed-off-by: Archer <naarcha@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Archer <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 7d3a3f5) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Add Benchmark glossary.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.