Skip to content

Commit

Permalink
update aggregate command reference with latest changes
Browse files Browse the repository at this point in the history 
Signed-off-by: Michael Oviedo <[email protected]>
  • Loading branch information
@OVI3D0
OVI3D0 committed Nov 27, 2024
1 parent e398cb7 commit 2bcc481
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion _benchmark/reference/commands/aggregate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,28 @@ Aggregate test execution ID: aggregate_results_geonames_9aafcfb8-d3b7-4583-864e
-------------------------------
```

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

### Additional options
- `--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`).

## Aggregated Results

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

View workflow job for this annotation

GitHub Actions / style-job 

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

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'Aggregated Results' is a heading and should be in sentence case.", "location": {"path": "_benchmark/reference/commands/aggregate.md", "range": {"start": {"line": 79, "column": 4}}}, "severity": "ERROR"}
Aggregated results now include new metrics and changes:

- **Relative Standard Deviation (RSD)**: For each metric (e.g., throughput, latency, service time) an additional `mean_rsd` value is included to show the spread of results across test executions.
- **Overall Min/Max Values**: Instead of averaging min and max values, the aggregated results now include `overall_min` and `overall_max` which reflect the true minimum/maximum across all test executions.
- **Storage**: Aggregated test results are now stored in a separate `aggregated_results` folder alongside the `test_executions` folder.

### Aggregated Metrics Example:

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

View workflow job for this annotation

GitHub Actions / style-job 

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

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'Aggregated Metrics Example:' is a heading and should be in sentence case.", "location": {"path": "_benchmark/reference/commands/aggregate.md", "range": {"start": {"line": 86, "column": 5}}}, "severity": "ERROR"}
```json
"throughput": {
"overall_min": 29056.890292903263,
"mean": 50115.8603858536,
"median": 50099.54349684457,
"overall_max": 72255.15946248993,
"unit": "docs/s",
"mean_rsd": 59.426059705973664
},
```

0 comments on commit 2bcc481

Please sign in to comment.