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

Jump to bottom

opensearch-benchmark execute_test -> execute-test #8366

Merged
merged 1 commit into from
Sep 24, 2024
Merged

opensearch-benchmark execute_test -> execute-test #8366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions _benchmark/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ You can now run your first benchmark. The following benchmark uses the [percolat

Benchmarks are run using the [`execute-test`]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) command with the following command flags:

For additional `execute_test` command flags, see the [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) reference. Some commonly used options are `--workload-params`, `--exclude-tasks`, and `--include-tasks`.
For additional `execute-test` command flags, see the [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) reference. Some commonly used options are `--workload-params`, `--exclude-tasks`, and `--include-tasks`.
{: .tip}

* `--pipeline=benchmark-only` : Informs OSB that users wants to provide their own OpenSearch cluster.
Expand All @@ -136,7 +136,7 @@ opensearch-benchmark execute-test --pipeline=benchmark-only --workload=percolato
```
{% include copy.html %}

When the `execute_test` command runs, all tasks and operations in the `percolator` workload run sequentially.
When the `execute-test` command runs, all tasks and operations in the `percolator` workload run sequentially.

### Validating the test

Expand Down
4 changes: 2 additions & 2 deletions _benchmark/user-guide/creating-custom-workloads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@
Use the `opensearch-benchmark execute-test` command to invoke your new workload and run a benchmark test against your OpenSearch cluster, as shown in the following example. Replace `--workload-path` with the path to your custom workload, `--target-host` with the `host:port` pairs for your cluster, and `--client-options` with any authorization options required to access the cluster.

```
opensearch-benchmark execute_test \
opensearch-benchmark execute-test \

Check failure on line 266 in _benchmark/user-guide/creating-custom-workloads.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.

Raw Output:
{"message": "[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.", "location": {"path": "_benchmark/user-guide/creating-custom-workloads.md", "range": {"start": {"line": 266, "column": 1}}}, "severity": "ERROR"}
--pipeline="benchmark-only" \
--workload-path="<PATH OUTPUTTED IN THE OUTPUT OF THE CREATE-WORKLOAD COMMAND>" \
--target-host="<CLUSTER ENDPOINT>" \
Expand All @@ -289,7 +289,7 @@
Then, run `opensearch-benchmark execute-test` with the option `--test-mode`. Test mode runs a quick version of the workload test.

```
opensearch-benchmark execute_test \
opensearch-benchmark execute-test \

Check failure on line 292 in _benchmark/user-guide/creating-custom-workloads.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.

Raw Output:
{"message": "[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.", "location": {"path": "_benchmark/user-guide/creating-custom-workloads.md", "range": {"start": {"line": 292, "column": 1}}}, "severity": "ERROR"}
--pipeline="benchmark-only" \
--workload-path="<PATH OUTPUTTED IN THE OUTPUT OF THE CREATE-WORKLOAD COMMAND>" \
--target-host="<CLUSTER ENDPOINT>" \
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/user-guide/distributed-load.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ With OpenSearch Benchmark running on all three nodes and the worker nodes set to
On **Node 1**, run a benchmark test with the `worker-ips` set to the IP addresses for your worker nodes, as shown in the following example:

```
opensearch-benchmark execute_test --pipeline=benchmark-only --workload=eventdata --worker-ips=198.52.100.0,198.53.100.0 --target-hosts=<DOMAIN_ENDPOINT> --client-options=<STANDARD_CLIENT_OPTIONS> --kill-running-processes
opensearch-benchmark execute-test --pipeline=benchmark-only --workload=eventdata --worker-ips=198.52.100.0,198.53.100.0 --target-hosts=<DOMAIN_ENDPOINT> --client-options=<STANDARD_CLIENT_OPTIONS> --kill-running-processes
```

After the test completes, the logs generated by the test appear on your worker nodes.
Expand Down
Loading