Move Benchmark reference material (#5387)

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
This commit is contained in:
Naarcha-AWS 2023-10-26 14:04:57 -05:00 committed by GitHub
parent 3098c99f2d
commit 7d58aa818d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 40 additions and 4 deletions

View File

@ -3,6 +3,8 @@ layout: default
title: Command flags
nav_order: 51
parent: Command reference
redirect_from: /benchmark/commands/command-flags/
grand_parent: OpenSearch Benchmark Reference
---
# Command flags

View File

@ -3,6 +3,8 @@ layout: default
title: compare
nav_order: 55
parent: Command reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/commands/compare/
---
# compare

View File

@ -3,6 +3,8 @@ layout: default
title: download
nav_order: 60
parent: Command reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/commands/download/
---
# download

View File

@ -3,6 +3,8 @@ layout: default
title: execute-test
nav_order: 65
parent: Command reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/commands/execute-test/
---
# execute-test

View File

@ -3,6 +3,8 @@ layout: default
title: Command reference
nav_order: 50
has_children: true
parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/commands/index/
---
# OpenSearch Benchmark command reference

View File

@ -3,6 +3,8 @@ layout: default
title: info
nav_order: 75
parent: Command reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/commands/info/
---
# info

View File

@ -3,6 +3,8 @@ layout: default
title: list
nav_order: 80
parent: Command reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/commands/list/
---
# list

View File

@ -0,0 +1,10 @@
---
layout: default
title: OpenSearch Benchmark Reference
nav_order: 25
has_children: true
---
# OpenSearch Benchmark Reference
The following section contains reference materials for commands, metrics, and workloads for OpenSearch Benchmark.

View File

@ -1,8 +1,10 @@
---
layout: default
title: Metrics
title: Metrics reference
nav_order: 25
has_children: true
parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/metrics/index/
---
# Metrics

View File

@ -2,12 +2,14 @@
layout: default
title: Metric keys
nav_order: 35
parent: Metrics
parent: Metrics reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/metrics/metric-keys/
---
# Metric keys
Metric keys are the metrics that OpenSearch Benchmark stores, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-keys/). OpenSearch Benchmark stores the following metrics:
Metric keys are the metrics that OpenSearch Benchmark stores, based on the configuration in the [metrics record]({{site.url}}{{site.baseurl}}/benchmark/metrics/metric-records/). OpenSearch Benchmark stores the following metrics:
- `latency`: The time period between submitting a request and receiving the complete response. This also includes wait time, such as the time the request spends waiting until it is ready to be serviced by OpenSearch Benchmark.

View File

@ -2,7 +2,9 @@
layout: default
title: Metric records
nav_order: 30
parent: Metrics
parent: Metrics reference
grand_parent: OpenSearch Benchmark Reference
redirect_from: /benchmark/metrics/metric-records/
---
# Metric records

View File

@ -2,7 +2,9 @@
layout: default
title: corpora
parent: Workload reference
grand_parent: OpenSearch Benchmark Reference
nav_order: 70
redirect_from: /benchmark/workloads/corpora/
---
# corpora

View File

@ -2,7 +2,9 @@
layout: default
title: Workload reference
nav_order: 60
parent: OpenSearch Benchmark Reference
has_children: true
redirect_from: /benchmark/workloads/index/
---
# OpenSearch Benchmark workload reference

View File

@ -2,7 +2,9 @@
layout: default
title: indices
parent: Workload reference
grand_parent: OpenSearch Benchmark Reference
nav_order: 65
redirect_from: /benchmark/workloads/indices/
---
# indices