Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS and natebower committed Sep 20, 2024
1 parent e606ba2 commit 95f9450
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions _benchmark/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ nav_order: 10
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.
- **Metric keys**: The metrics that OpenSearch Benchmark stores, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-records/).
- **Latency**: If `target-throughput` is disabled (has no value or a value of `0)`, then latency is equivalent to service time. If `target-throughput` is enabled (has a value of 1 or greater), then latency is equal to the service time plus the amount of time the request waits in the queue before being sent.
- **Metric keys**: The metrics stored by OpenSearch Benchmark, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-records/).
- **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.
- **Pipeline**: A series of steps occurring both before and after running a workload that determines benchmark results.
- **Schedule**: A list of two or more operations performed in the order they appear when a workload is run.
- **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.
- **Summary report**: A report output at the end a test based on the metric keys defined in the workload.
- **Service time**: The amount of time taken 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 taken for the server to process a request as well as for network latency, load balancer overhead, and deserialization/serialization.
- **Summary report**: A report generated at the end of 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 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.
- **Workload**: A collection of one or more benchmarking tests that use a specific document corpus to perform a benchmark against a cluster. The document corpus contains any indexes, data files, or operations invoked when the workload runs.

0 comments on commit 95f9450

Please sign in to comment.