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.

Sign up for GitHub

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
Merged

Add shorthand alternatives for command line options in OSB #660

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ba3a36
add short hand alternatives for commonly used command line options wh…
OVI3D0 Sep 30, 2024
e592049
add shorthand alternatives for commonly-used command line options for…
OVI3D0 Sep 30, 2024
886ca31
add shorthand for --version
OVI3D0 Oct 4, 2024
68f45dd
keep shorthand for more common flags
OVI3D0 Oct 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions osbenchmark/benchmark.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ def add_workload_source(subparser):
description=BANNER + "\n\n A benchmarking tool for OpenSearch",
epilog="Find out more about Benchmark at {}".format(console.format.link(doc_link())),
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('--version', action='version', version="%(prog)s " + version.version())
parser.add_argument('-v', '--version', action='version', version="%(prog)s " + version.version())
OVI3D0 marked this conversation as resolved.
Show resolved Hide resolved

if len(sys.argv) == 1:
parser.print_help()
Expand Down Expand Up @@ -132,13 +132,15 @@ def add_workload_source(subparser):
add_workload_source(info_parser)
info_parser.add_argument(
"--workload",
"-w",
help=f"Define the workload to use. List possible workloads with `{PROGRAM_NAME} list workloads`."
# we set the default value later on because we need to determine whether the user has provided this value.
# default="geonames"
)

info_parser.add_argument(
"--workload-params",
"-wp",
help="Define a comma-separated list of key:value pairs that are injected verbatim to the workload as variables.",
default=""
)
Expand All @@ -157,20 +159,24 @@ def add_workload_source(subparser):
create_workload_parser = subparsers.add_parser("create-workload", help="Create a Benchmark workload from existing data")
create_workload_parser.add_argument(
"--workload",
"-w",
required=True,
help="Name of the generated workload")
create_workload_parser.add_argument(
"--indices",
"-i",
type=non_empty_list,
required=True,
help="Comma-separated list of indices to include in the workload")
create_workload_parser.add_argument(
"--target-hosts",
"-t",
default="",
required=True,
help="Comma-separated list of host:port pairs which should be targeted")
create_workload_parser.add_argument(
"--client-options",
"-c",
default=opts.ClientOptions.DEFAULT_CLIENT_OPTIONS,
help=f"Comma-separated list of client options to use. (default: {opts.ClientOptions.DEFAULT_CLIENT_OPTIONS})")
create_workload_parser.add_argument(
Expand All @@ -192,10 +198,12 @@ def add_workload_source(subparser):
compare_parser = subparsers.add_parser("compare", help="Compare two test_executions")
compare_parser.add_argument(
"--baseline",
"-b",
required=True,
help=f"TestExecution ID of the baseline (see {PROGRAM_NAME} list test_executions).")
compare_parser.add_argument(
"--contender",
"-c",
required=True,
help=f"TestExecution ID of the contender (see {PROGRAM_NAME} list test_executions).")
compare_parser.add_argument(
Expand Down Expand Up @@ -225,12 +233,12 @@ def add_workload_source(subparser):
aggregate_parser = subparsers.add_parser("aggregate", help="Aggregate multiple test_executions")
aggregate_parser.add_argument(
"--test-executions",
"--t",
type=non_empty_list,
required=True,
help="Comma-separated list of TestExecution IDs to aggregate")
aggregate_parser.add_argument(
"--test-execution-id",
"-tid",
help="Define a unique id for this aggregated test_execution.",
default="")
aggregate_parser.add_argument(
Expand Down Expand Up @@ -381,6 +389,7 @@ def add_workload_source(subparser):
default="")
start_parser.add_argument(
"--test-execution-id",
"-tid",
required=True,
help="Define a unique id for this test_execution.",
default="")
Expand Down Expand Up @@ -436,6 +445,7 @@ def add_workload_source(subparser):

test_execution_parser.add_argument(
"--test-execution-id",
"-tid",
help="Define a unique id for this test_execution.",
default=str(uuid.uuid4()))
test_execution_parser.add_argument(
Expand All @@ -455,10 +465,12 @@ def add_workload_source(subparser):
add_workload_source(test_execution_parser)
test_execution_parser.add_argument(
"--workload",
"-w",
help=f"Define the workload to use. List possible workloads with `{PROGRAM_NAME} list workloads`."
)
test_execution_parser.add_argument(
"--workload-params",
"-wp",
help="Define a comma-separated list of key:value pairs that are injected verbatim to the workload as variables.",
default=""
)
Expand Down Expand Up @@ -492,6 +504,7 @@ def add_workload_source(subparser):
)
test_execution_parser.add_argument(
"--target-hosts",
"-t",
help="Define a comma-separated list of host:port pairs which should be targeted if using the pipeline 'benchmark-only' "
"(default: localhost:9200).",
default="") # actually the default is pipeline specific and it is set later
Expand All @@ -501,6 +514,7 @@ def add_workload_source(subparser):
default="localhost")
test_execution_parser.add_argument(
"--client-options",
"-c",
help=f"Define a comma-separated list of client options to use. The options will be passed to the OpenSearch "
f"Python client (default: {opts.ClientOptions.DEFAULT_CLIENT_OPTIONS}).",
default=opts.ClientOptions.DEFAULT_CLIENT_OPTIONS)
Expand Down Expand Up @@ -576,6 +590,7 @@ def add_workload_source(subparser):
action="store_true")
test_execution_parser.add_argument(
"--kill-running-processes",
"-k",
action="store_true",
default=False,
help="If any processes is running, it is going to kill them and allow Benchmark to continue to run."
Expand All @@ -599,7 +614,6 @@ def add_workload_source(subparser):
action="store_true")
test_execution_parser.add_argument(
"--randomization-repeat-frequency",
"-rf",
help=f"The repeat_frequency for query randomization. Ignored if randomization is off"
f"(default: {workload.loader.QueryRandomizerWorkloadProcessor.DEFAULT_RF}).",
default=workload.loader.QueryRandomizerWorkloadProcessor.DEFAULT_RF)
Expand Down
Loading