Naarcha-AWS 2a5864ed6b
Add editorial for both Benchmark sections (#4192)
* Benchmark editorial

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-26 22:52:01 -05:00

25 lines
757 B
Markdown

---
layout: default
title: generate
nav_order: 70
parent: Command reference
---
The `generate` command generates visualizations based on benchmark results.
## Usage
The following example generates a time-series chart, which outputs into the `.benchmark` directory:
```
opensearch-benchmark generate --chart-type="time-series"
```
## Options
The following options customize the visualization produced by the `generate` command:
- `--chart-spec-path`: Sets the path to the JSON files containing chart specifications that can be used to generate charts.
- `--chart-type`: Generates the indicated chart type, either `time-series` or `bar`. Default is `time-series`.
- `--output-path`: The path and name where the chart outputs. Default is `stdout`.