Update target-throughput.md #8248
Merged
Conversation
This file contains 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
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
3 - Tech review
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. |
IanHoang
reviewed
Sep 12, 2024
| @@ -18,12 +18,12 @@ OpenSearch Benchmark has two testing modes, both of which are related to through | |||
|
|
|||
| When you do not specify a `target-throughput`, OpenSearch Benchmark latency tests are performed in *benchmarking mode*. In this mode, the OpenSearch client sends requests to the OpenSearch cluster as fast as possible. After the cluster receives a response from the previous request, OpenSearch Benchmark immediately sends the next request to the OpenSearch client. In this testing mode, latency is identical to service time. | |||
There was a problem hiding this comment.
Can we rephrase the first part of the sentence to:
When target-throughput is set to 0, OpenSearch Benchmark tests are performed in benchmarking mode.
IanHoang
reviewed
Sep 12, 2024
| @@ -18,12 +18,12 @@ OpenSearch Benchmark has two testing modes, both of which are related to through | |||
|
|
|||
| When you do not specify a `target-throughput`, OpenSearch Benchmark latency tests are performed in *benchmarking mode*. In this mode, the OpenSearch client sends requests to the OpenSearch cluster as fast as possible. After the cluster receives a response from the previous request, OpenSearch Benchmark immediately sends the next request to the OpenSearch client. In this testing mode, latency is identical to service time. | |||
|
|
|||
| OpenSearch Benchmark issues one request at a time for a single-client thread, which is specified as `search-clients` in the workload parameters. If `target-throughput` is set to `0`, then OpenSearch Benchmark issues a request immediately after it receives the response from the previous request. If the `target-throughput` is not set to `0`, then OpenSearch Benchmark issues the next request in accordance with the `target-throughput`, assuming that responses are returned instantaneously. | |||
There was a problem hiding this comment.
On second thought, we can remove this sentence entirely since the ideas here are duplicated.
IanHoang
reviewed
Sep 12, 2024
IanHoang
reviewed
Sep 12, 2024
Signed-off-by: Naarcha-AWS <[email protected]>
|
@IanHoang: That should address your comments. Let me know if there are any other tweaks you want me to make. |
Naarcha-AWS
added
4 - Doc review
IanHoang
approved these changes
Sep 23, 2024
kolchfa-aws
reviewed
Sep 24, 2024
| When you do not specify a `target-throughput`, OpenSearch Benchmark latency tests are performed in *benchmarking mode*. In this mode, the OpenSearch client sends requests to the OpenSearch cluster as fast as possible. After the cluster receives a response from the previous request, OpenSearch Benchmark immediately sends the next request to the OpenSearch client. In this testing mode, latency is identical to service time. | ||
| When `target-throughput` is set to `0`, OpenSearch Benchmark latency tests are performed in *benchmarking mode*. In this mode, the OpenSearch client sends requests to the OpenSearch cluster as fast as possible. After the cluster receives a response from the previous request, OpenSearch Benchmark immediately sends the next request to the OpenSearch client. In this testing mode, latency is identical to service time. | ||
|
|
||
| OpenSearch Benchmark issues one request at a time for a single-client thread, which is specified as `search-clients` in the workload parameters. |
There was a problem hiding this comment.
What does "single-client" thread mean? And how does the user specify it in search-clients?
There was a problem hiding this comment.
kolchfa-aws
approved these changes
Sep 24, 2024
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
commented
Sep 25, 2024
Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 25, 2024
* Update target-throughput.md Signed-off-by: Naarcha-AWS <[email protected]> * Update target-throughput.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _benchmark/user-guide/target-throughput.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> (cherry picked from commit d8c3a74) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra
pushed a commit
to leanneeliatra/opensearch-documentation-website-forl
that referenced
this pull request
Oct 17, 2024
* Update target-throughput.md Signed-off-by: Naarcha-AWS <[email protected]> * Update target-throughput.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _benchmark/user-guide/target-throughput.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes an issue where user's were confused about target-throughput settings.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.