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 documentation for new aggregate command + auto aggregation #8521

Merged
merged 6 commits into from
Oct 17, 2024
Merged

add documentation for new aggregate command + auto aggregation #8521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
71e24c1
add documentation for new aggregate command + auto aggregation
OVI3D0 Oct 11, 2024
e602636
Update aggregate.md
Naarcha-AWS Oct 16, 2024
87aba13
Update command-flags.md
Naarcha-AWS Oct 16, 2024
75ff23b
Apply suggestions from code review
Naarcha-AWS Oct 17, 2024
d4f04b2
Update aggregate.md
Naarcha-AWS Oct 17, 2024
d5f4b9a
Merge branch 'main' into add-aggregate-documentation
Naarcha-AWS Oct 17, 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
77 changes: 77 additions & 0 deletions _benchmark/reference/commands/aggregate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
layout: default
title: aggregate
nav_order: 85
parent: Command reference
grand_parent: OpenSearch Benchmark Reference
redirect_from:
- /benchmark/commands/aggregate/
---

# aggregate

Check failure on line 11 in _benchmark/reference/commands/aggregate.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingCapitalization] 'aggregate' is a heading and should be in sentence case.

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'aggregate' is a heading and should be in sentence case.", "location": {"path": "_benchmark/reference/commands/aggregate.md", "range": {"start": {"line": 11, "column": 3}}}, "severity": "ERROR"}

The `aggregate` command combines multiple test executions into a single aggregated result, providing a more streamlined way to conduct and analyze multiple test runs. There are two methods of aggregation:

- [Auto-aggregation](#auto-aggregation)
- [Manual aggregation](#manual-aggregation)

## Auto-aggregation

The auto-aggregation method runs multiple iterations of benchmark tests and automatically aggregates the results, all within a single command. You can use the flags outlined in this with the `execute` command.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Above: It looks like there's a missing word in the second sentence. This what?

### Usage

The following example runs the `geonames` workload and aggregates the results twice:

```bash
opensearch-benchmark execute --test-iterations=2 --aggregate=true --workload=geonames --target-hosts=127.0.0.1:9200
```
{% include copy-curl.html %}

### Auto-aggregation flags

The following new flags can be used to customize the auto-aggregation method:

- `--test-iterations`: Specifies the number of times to run the workload (default is `1`).
- `--aggregate`: Determines whether to aggregate the results of multiple test executions (default is `true`).
- `--sleep-timer`: Specifies the number of seconds to sleep before starting the next test execution (default is `5`).
- `--cancel-on-error`: When set, stops executing tests if an error occurs in one of the test iterations (default is `false`).

## Manual aggregation

You can use the `aggregate` command to manually aggregate results from multiple test executions.

### Usage

To aggregate multiple test executions manually, specify the `test_execution_ids` you would like to aggregate, as shown in the following example:

Copy link
Collaborator

Choose a reason for hiding this comment

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

Above: This sentence is a rehash of the one under the preceding heading.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Let me change this one.

```bash
opensearch-benchmark aggregate --test-executions=<test_execution_id1>,<test_execution_id2>,...
```
{% include copy-curl.html %}

### Response

OpenSearch Benchmark responds with the following:

```
____ _____ __ ____ __ __
/ __ \____ ___ ____ / ___/___ ____ ___________/ /_ / __ )___ ____ _____/ /_ ____ ___ ____ ______/ /__
/ / / / __ \/ _ \/ __ \\__ \/ _ \/ __ `/ ___/ ___/ __ \ / __ / _ \/ __ \/ ___/ __ \/ __ `__ \/ __ `/ ___/ //_/
/ /_/ / /_/ / __/ / / /__/ / __/ /_/ / / / /__/ / / / / /_/ / __/ / / / /__/ / / / / / / / / /_/ / / / ,<
\____/ .___/\___/_/ /_/____/\___/\__,_/_/ \___/_/ /_/ /_____/\___/_/ /_/\___/_/ /_/_/ /_/ /_/\__,_/_/ /_/|_|
/_/

Aggregate test execution ID: aggregate_results_geonames_9aafcfb8-d3b7-4583-864e-4598b5886c4f

-------------------------------
[INFO] SUCCESS (took 1 seconds)
-------------------------------
```

The results will be aggregated into one test execution and stored under the ID shown in the output:

- `--test-execution-id`: Define a unique ID for the aggregated test execution.
- `--results-file`: Write the aggregated results to the provided file.
- `--workload-repository`: Define the repository from which OpenSearch Benchmark will load workloads (default is `default`).

30 changes: 30 additions & 0 deletions _benchmark/reference/commands/command-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,3 +328,33 @@ Sets what fraction of randomized query values can be repeated. Takes values betw
<!-- vale on -->

Sets how many distinct repeatable pair values are generated for each operation when randomization is used. Default is `5000`. This setting does not work when `--randomization-enabled` is not used.

<!-- vale off -->
## test-iterations
<!-- vale on -->

Specifies the number of times to run the workload. Default is `1`.

<!-- vale off -->
## aggregate
<!-- vale on -->

Determines whether OpenSearch Benchmark should aggregate the results of multiple test executions.

When set to `true`, OpenSearch Benchmark will combine the results from all iterations into a single aggregated report. When set to `false`, results from each iteration will be reported separately.

Default is `true`.

<!-- vale off -->
## sleep-timer
<!-- vale on -->

Specifies the number of seconds to sleep before starting the next test execution. Default is `5`.


<!-- vale off -->
## cancel-on-error
<!-- vale on -->

When set, this flag instructs OpenSearch Benchmark to stop executing tests if an error occurs in one of the test iterations. Default is `false` (not set).

Loading