generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 618
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
Merged
Merged
Add Benchmark glossary #8190
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
fb59274
Add Benchmark glossary
Naarcha-AWS b7b9df6
Add text
Naarcha-AWS 14b4dcd
Apply suggestions from code review
Naarcha-AWS aa9831e
Apply suggestions from code review
Naarcha-AWS 1d9a3f1
Apply suggestions from code review
Naarcha-AWS e606ba2
Apply suggestions from code review
Naarcha-AWS 95f9450
Apply suggestions from code review
Naarcha-AWS 735660f
Apply suggestions from code review
Naarcha-AWS c5c0827
Merge branch 'main' into glossary-benchmark
Naarcha-AWS File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
layout: default | ||
title: Glossary | ||
nav_order: 10 | ||
--- | ||
|
||
# OpenSearch Benchmark glossary | ||
|
||
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)`, then latency is equal 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 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 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 a cluster. The document corpus contains any indexes, data files, or operations invoked when the workload runs. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.