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:
parent
3098c99f2d
commit
7d58aa818d
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: Command flags
|
title: Command flags
|
||||||
nav_order: 51
|
nav_order: 51
|
||||||
parent: Command reference
|
parent: Command reference
|
||||||
|
redirect_from: /benchmark/commands/command-flags/
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
---
|
---
|
||||||
|
|
||||||
# Command flags
|
# Command flags
|
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: compare
|
title: compare
|
||||||
nav_order: 55
|
nav_order: 55
|
||||||
parent: Command reference
|
parent: Command reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/commands/compare/
|
||||||
---
|
---
|
||||||
|
|
||||||
# compare
|
# compare
|
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: download
|
title: download
|
||||||
nav_order: 60
|
nav_order: 60
|
||||||
parent: Command reference
|
parent: Command reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/commands/download/
|
||||||
---
|
---
|
||||||
|
|
||||||
# download
|
# download
|
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: execute-test
|
title: execute-test
|
||||||
nav_order: 65
|
nav_order: 65
|
||||||
parent: Command reference
|
parent: Command reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/commands/execute-test/
|
||||||
---
|
---
|
||||||
|
|
||||||
# execute-test
|
# execute-test
|
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: Command reference
|
title: Command reference
|
||||||
nav_order: 50
|
nav_order: 50
|
||||||
has_children: true
|
has_children: true
|
||||||
|
parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/commands/index/
|
||||||
---
|
---
|
||||||
|
|
||||||
# OpenSearch Benchmark command reference
|
# OpenSearch Benchmark command reference
|
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: info
|
title: info
|
||||||
nav_order: 75
|
nav_order: 75
|
||||||
parent: Command reference
|
parent: Command reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/commands/info/
|
||||||
---
|
---
|
||||||
|
|
||||||
# info
|
# info
|
|
@ -3,6 +3,8 @@ layout: default
|
||||||
title: list
|
title: list
|
||||||
nav_order: 80
|
nav_order: 80
|
||||||
parent: Command reference
|
parent: Command reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/commands/list/
|
||||||
---
|
---
|
||||||
|
|
||||||
# list
|
# list
|
|
@ -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.
|
|
@ -1,8 +1,10 @@
|
||||||
---
|
---
|
||||||
layout: default
|
layout: default
|
||||||
title: Metrics
|
title: Metrics reference
|
||||||
nav_order: 25
|
nav_order: 25
|
||||||
has_children: true
|
has_children: true
|
||||||
|
parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/metrics/index/
|
||||||
---
|
---
|
||||||
|
|
||||||
# Metrics
|
# Metrics
|
|
@ -2,12 +2,14 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Metric keys
|
title: Metric keys
|
||||||
nav_order: 35
|
nav_order: 35
|
||||||
parent: Metrics
|
parent: Metrics reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/metrics/metric-keys/
|
||||||
---
|
---
|
||||||
|
|
||||||
# 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.
|
- `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.
|
|
@ -2,7 +2,9 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Metric records
|
title: Metric records
|
||||||
nav_order: 30
|
nav_order: 30
|
||||||
parent: Metrics
|
parent: Metrics reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
|
redirect_from: /benchmark/metrics/metric-records/
|
||||||
---
|
---
|
||||||
|
|
||||||
# Metric records
|
# Metric records
|
|
@ -2,7 +2,9 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: corpora
|
title: corpora
|
||||||
parent: Workload reference
|
parent: Workload reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
nav_order: 70
|
nav_order: 70
|
||||||
|
redirect_from: /benchmark/workloads/corpora/
|
||||||
---
|
---
|
||||||
|
|
||||||
# corpora
|
# corpora
|
|
@ -2,7 +2,9 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Workload reference
|
title: Workload reference
|
||||||
nav_order: 60
|
nav_order: 60
|
||||||
|
parent: OpenSearch Benchmark Reference
|
||||||
has_children: true
|
has_children: true
|
||||||
|
redirect_from: /benchmark/workloads/index/
|
||||||
---
|
---
|
||||||
|
|
||||||
# OpenSearch Benchmark workload reference
|
# OpenSearch Benchmark workload reference
|
|
@ -2,7 +2,9 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: indices
|
title: indices
|
||||||
parent: Workload reference
|
parent: Workload reference
|
||||||
|
grand_parent: OpenSearch Benchmark Reference
|
||||||
nav_order: 65
|
nav_order: 65
|
||||||
|
redirect_from: /benchmark/workloads/indices/
|
||||||
---
|
---
|
||||||
|
|
||||||
# indices
|
# indices
|
Loading…
Reference in New Issue