-
Notifications
You must be signed in to change notification settings - Fork 617
Add Benchmark glossary #8190
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Benchmark glossary #8190
Changes from 5 commits
fb59274
b7b9df6
14b4dcd
aa9831e
1d9a3f1
e606ba2
95f9450
735660f
c5c0827
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
layout: default | ||
title: Glossary | ||
nav_order: 10 | ||
--- | ||
|
||
# OpenSearch Benchmark glossary | ||
Check failure on line 7 in _benchmark/glossary.md
|
||
|
||
The following terms are commonly used in OpenSearch Benchmark: | ||
|
||
- **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. | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- **Metric keys**: The metrics that OpenSearch Benchmark stores, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-records/). | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- **Operations**: In workloads, a list of API operations performed by a workload. | ||
- **Pipeline**: A series of steps occurring before and after a workload is run that determines benchmark results. | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- **Schedule**: In workloads, a list of operations in a specific order. | ||
|
||
- **Service time**: The amount of time that it takes for `opensearch-py`, the primary client for OpenSearch Benchmark, to send a request and receive a response from the OpenSearch cluster. It includes the amount of time that it takes for the server to process a request and also network latency, load balancer overhead, and deserialization/serialization. | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- **Summary report**: A report output at the end a test based on the metric keys defined in the workload. | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- **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 tests 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. | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Uh oh!
There was an error while loading. Please reload this page.