update aggregate command reference with latest changes (#8823)

* update aggregate command reference with latest changes Signed-off-by: Michael Oviedo <[email protected]> * Update aggregate.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Michael Oviedo <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit 91e311e) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Dec 3, 2024 · 90ac370 · 90ac370
1 parent 27a7167
commit 90ac370
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/_benchmark/reference/commands/aggregate.md b/_benchmark/reference/commands/aggregate.md
@@ -69,9 +69,30 @@ 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
+
+Aggregated results includes the following information:
+
+- **Relative Standard Deviation (RSD)**: For each metric an additional `mean_rsd` value shows the spread of results across test executions.
+- **Overall min/max values**: Instead of averaging minimum and maximum values, the aggregated result include `overall_min` and `overall_max` which reflect the true minimum/maximum across all test runs.
+- **Storage**: Aggregated test results are  stored in a separate `aggregated_results` folder alongside the `test_executions` folder.
+
+The following example shows aggregated results:
+
+```json
+    "throughput": {
+     "overall_min": 29056.890292903263,
+     "mean": 50115.8603858536,
+     "median": 50099.54349684457,
+     "overall_max": 72255.15946248993,
+     "unit": "docs/s",
+     "mean_rsd": 59.426059705973664
+    },
+```