Adds documentation for new OSB flags #6403
Conversation
Signed-off-by: Peter Alfonsi <[email protected]>
peteralfonsi
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower and
dlvenable
as code owners
|
@Naarcha-AWS - @IanHoang mentioned you would be a good person to tag for reviewing this PR |
| <!-- vale on --> | ||
|
|
||
| Enables randomization of values in range queries, where the values are drawn from standard value functions registered with `register_standard_value_source` in the workload's workload.py. Default is `False`. |
There was a problem hiding this comment.
Nit: For folks who are not familiar, it would be good to add a small blurb defining "standard value functions".
There was a problem hiding this comment.
@IanHoang: Do you have a good working definition for "standard value functions"?
There was a problem hiding this comment.
What happens if there is no such function registered? Please indicate that an error is raised if that is the case.
There was a problem hiding this comment.
standard value functions can be defined as:
It's a function you call to generate a random pair of values for a certain field.
Source: opensearch-project/opensearch-benchmark#455 (comment)
@peteralfonsi feel free to add more insight if needed. Govind has a good point, we should also address what happens if no function is registered.
There was a problem hiding this comment.
Yes, I will add a definition and the case when nothing is registered.
Naarcha-AWS
added
4 - Doc review
Signed-off-by: Naarcha-AWS <[email protected]>
| <!-- vale on --> | ||
|
|
||
| Specifies a list of latency percentiles to report after the workload runs. Default is `50,90,99,99.9,99.99,100`. |
There was a problem hiding this comment.
Does this need to be specified as a number or does median, min or max work as well? This should be documented, since the throughput documentation mentions these terms.
There was a problem hiding this comment.
I believe latency percentiles and throughput percentiles only takes in numbers and not median, min, and max. To do median, min, and max, we'd have to specify 0,50,100. Is this correct @peteralfonsi ?
There was a problem hiding this comment.
That's right, it only takes numeric percentiles. I will add a sentence about that.
| <!-- vale on --> | ||
|
|
||
| Specifies a list of throughput percentiles to report after the workload runs, in addition to mean/median/max/min. Default is `None`. |
There was a problem hiding this comment.
Is this to be specified as floating point numbers? Please elaborate here.
There was a problem hiding this comment.
It can be taken as an int, float, or str. Based on the code here that Peter added, it converts the user inputs to floats.
| <!-- vale on --> | ||
|
|
||
| Enables randomization of values in range queries, where the values are drawn from standard value functions registered with `register_standard_value_source` in the workload's workload.py. Default is `False`. |
There was a problem hiding this comment.
What happens if there is no such function registered? Please indicate that an error is raised if that is the case.
Signed-off-by: Peter Alfonsi <[email protected]>
|
Apologies for getting back to this PR so late. I've addressed your comments. Let me know if I should change anything else. |
Signed-off-by: Naarcha-AWS <[email protected]>
* Adds documentation for new OSB flags Signed-off-by: Peter Alfonsi <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Addressed comments Signed-off-by: Peter Alfonsi <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Peter Alfonsi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Peter Alfonsi <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit e1fed49) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Adds documentation for new OSB flags * Apply suggestions from code review * Addressed comments * Apply suggestions from code review --------- (cherry picked from commit e1fed49) Signed-off-by: Peter Alfonsi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Peter Alfonsi <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
* Adds documentation for new OSB flags Signed-off-by: Peter Alfonsi <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Addressed comments Signed-off-by: Peter Alfonsi <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Peter Alfonsi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Peter Alfonsi <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
Description
Adds documentation for new arguments added to OpenSearch Benchmark in these PRs:
opensearch-project/opensearch-benchmark#441
opensearch-project/opensearch-benchmark#449
opensearch-project/opensearch-benchmark#455
Issues Resolved
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.