Skip to content
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 shorthand alternatives for command line options in OSB #660

Merged
merged 4 commits into from
Oct 23, 2024

Conversation

OVI3D0
Copy link
Member

@OVI3D0 OVI3D0 commented Sep 30, 2024

Description

Adds short-hand alternatives for commonly used command line options in OSB.

Now, rather than running:
opensearch-benchmark execute-test --workload=geonames --target-hosts=127.0.0.1:9200 --test-mode --kill-running-processes

one can instead run:
opensearch-benchmark execute-test -w=geonames -th=127.0.0.1:9200 --test-mode -krp

Issues Resolved

#639

Testing

Tested by using shorthand alternatives for the commands changed.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…en using execute-test

Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
… compare and create-workload

Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
@IanHoang
Copy link
Collaborator

IanHoang commented Oct 3, 2024

Could we also add one for opensearch-benchmark --version (to match how --help has -h)?

@IanHoang
Copy link
Collaborator

IanHoang commented Oct 3, 2024

This will streamline the testing experience. Thanks for doing this!

Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
@OVI3D0
Copy link
Member Author

OVI3D0 commented Oct 4, 2024

Could we also add one for opensearch-benchmark --version (to match how --help has -h)?

Done!

Copy link
Collaborator

@IanHoang IanHoang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spoke offline with @OVI3D0: Will just add short hand flags for most common commands. We also want to avoid using more than one letter flags. Updated issue to reflect most common commands: #639

osbenchmark/benchmark.py Outdated Show resolved Hide resolved
osbenchmark/benchmark.py Outdated Show resolved Hide resolved
osbenchmark/benchmark.py Show resolved Hide resolved
osbenchmark/benchmark.py Outdated Show resolved Hide resolved
Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
@IanHoang IanHoang merged commit 5b27a22 into opensearch-project:main Oct 23, 2024
10 checks passed
@OVI3D0 OVI3D0 deleted the add-shorthand branch October 28, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants