Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _benchmark/FAQs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: FAQs
nav_order: 103
nav_order: 115
---

# FAQs
Expand Down
4 changes: 2 additions & 2 deletions _benchmark/anatomy-of-a-workload.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Anatomy of a workload
nav_order: 10
nav_order: 15
redirect_from:
- /benchmark/user-guide/understanding-workloads/anatomy-of-a-workload/
---
Expand Down Expand Up @@ -170,7 +170,7 @@ According to this `schedule`, the actions will run in the following order:
3. The `clients` field defines the number of clients, in this example, eight, that will run the bulk indexing operation concurrently.
4. The `search` operation runs a `match_all` query to match all documents after they have been indexed by the `bulk` API using the specified clients.
- The `iterations` field defines the number of times each client runs the `search` operation. The benchmark report automatically adjusts the percentile numbers based on this number. To generate a precise percentile, the benchmark needs to run at least 1,000 iterations.
- The `target-throughput` field defines the number of requests per second performed by each client. This setting can help reduce benchmark latency. For example, a `target-throughput` of 100 requests divided by 8 clients means that each client will issue 12 requests per second. For more information about how target throughput is defined in OpenSearch Benchmark, see [Target throughput]({{site.url}}{{site.baseurl}}/benchmark/user-guide/target-throughput/).
- The `target-throughput` field defines the number of requests per second performed by each client. This setting can help reduce benchmark latency. For example, a `target-throughput` of 100 requests divided by 8 clients means that each client will issue 12 requests per second. For more information about how target throughput is defined in OpenSearch Benchmark, see [Target throughput]({{site.url}}{{site.baseurl}}/benchmark/target-throughput/).

<!-- vale off -->
## index.json
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/choosing-a-workload.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ This workload tests the following queries and search functions:

## Creating a custom workload

If you can't find an official workload that suits your needs, you can create a custom workload. For more information, see [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/creating-custom-workloads/).
If you can't find an official workload that suits your needs, you can create a custom workload. For more information, see [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/creating-custom-workloads/).
2 changes: 1 addition & 1 deletion _benchmark/common-operations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Common operations
nav_order: 15
nav_order: 25
redirect_from:
- /benchmark/user-guide/understanding-workloads/common-operations/
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
layout: default
title: Sharing custom workloads
nav_order: 11
grand_parent: User guide
parent: Working with workloads
redirect_from:
nav_order: 45
redirect_from:
- /benchmark/user-guide/contributing-workloads/
- /benchmark/user-guide/working-with-workloads/contributing-workloads/
---

# Sharing custom workloads
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
layout: default
title: Creating custom workloads
nav_order: 10
grand_parent: User guide
parent: Working with workloads
nav_order: 35
redirect_from:
- /benchmark/user-guide/creating-custom-workloads/
- /benchmark/creating-custom-workloads/
- /benchmark/user-guide/creating-osb-workloads/
- /benchmark/user-guide/working-with-workloads/creating-custom-workloads/
---

# Creating custom workloads
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: default
title: Running distributed loads
nav_order: 15
parent: Optimizing benchmarks
grand_parent: User guide
nav_order: 50
redirect_from:
- /benchmark/user-guide/optimizing-benchmarks/distributed-load/
---

# Running distributed loads
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: default
title: Expanding a workload's data corpus
nav_order: 20
parent: Optimizing benchmarks
grand_parent: User guide
nav_order: 55
redirect_from:
- /benchmark/user-guide/optimizing-benchmarks/expand-data-corpus/
---

# Expanding a workload's data corpus
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/features/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Additional features
nav_order: 30
nav_order: 80
has_children: true
has_toc: false
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
layout: default
title: Fine-tuning custom workloads
nav_order: 12
grand_parent: User guide
parent: Working with workloads
redirect_from:
nav_order: 40
redirect_from:
- /benchmark/user-guide/finetine-workloads/
- /benchmark/user-guide/working-with-workloads/finetune-workloads/
---

# Fine-tuning custom workloads
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ items:
link: "/benchmark/user-guide/install-and-configure/installing-benchmark/"
- heading: "Run a workload"
description: "Run a workload and receive performance metrics"
link: "/benchmark/user-guide/working-with-workloads/running-workloads/"
link: "/benchmark/running-workloads/"
- heading: "Analyze performance metrics"
description: "View your benchmark report and analyze your metrics"
link: "/benchmark/reference/summary-report/"
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/migration-assistance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Migration assistance
nav_order: 102
nav_order: 110
---

# Migrating from 1.X to 2.X
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
layout: default
title: Performance testing best practices
nav_order: 160
parent: Optimizing benchmarks
grand_parent: User guide
nav_order: 70
redirect_from:
- /benchmark/user-guide/optimizing-benchmarks/performance-testing-best-practices/
- /benchmark/user-guide/optimizing-benchmarks/
---

# Performance testing best practices
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Quickstart
nav_order: 2
nav_order: 5
---

# OpenSearch Benchmark quickstart
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: default
title: Randomizing queries
nav_order: 160
parent: Optimizing benchmarks
grand_parent: User guide
nav_order: 65
has_math: true
redirect_from:
- /benchmark/user-guide/optimizing-benchmarks/randomizing-queries/
---

# Randomizing queries
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Reference
nav_order: 25
nav_order: 75
has_children: true
redirect_from:
- /benchmark/reference/
Expand Down
1 change: 1 addition & 0 deletions _benchmark/reference/summary-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ nav_order: 40
parent: Reference
redirect_from:
- /benchmark/user-guide/understanding-results/summary-reports/
- /benchmark/user-guide/understanding-results/
---

# Summary report
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: default
title: Running a workload
nav_order: 9
grand_parent: User guide
parent: Working with workloads
nav_order: 30
redirect_from:
- /benchmark/user-guide/running-workloads/
- /benchmark/user-guide/working-with-workloads/running-workloads/
- /benchmark/user-guide/working-with-workloads/
---

# Running a workload
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
layout: default
title: Target throughput
nav_order: 150
parent: Optimizing benchmarks
grand_parent: User guide
redirect_from:
nav_order: 60
redirect_from:
- /benchmark/user-guide/target-throughput/
- /benchmark/user-guide/optimizing-benchmarks/target-throughput/
---

# Target throughput
Expand Down
8 changes: 4 additions & 4 deletions _benchmark/user-guide/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: User guide
nav_order: 5
nav_order: 10
has_children: true
has_toc: false
more_cards:
Expand All @@ -16,13 +16,13 @@ more_cards:
link: "/benchmark/anatomy-of-a-workload/"
- heading: "Run and customize your workload"
description: "Run and customize your OpenSearch workload to get the most accurate results"
link: "/benchmark/user-guide/working-with-workloads/index/"
link: "/benchmark/running-workloads/"
- heading: "Understanding your results"
description: "Analyze and store your benchmark results"
link: "/benchmark/user-guide/understanding-results/index/"
link: "/benchmark/reference/summary-report/"
- heading: "Optimizing benchmarks"
description: "Optimize your benchmark experience through randomization and best practices"
link: "/benchmark/user-guide/optimizing-benchmarks/index/"
link: "/benchmark/performance-testing-best-practices/"
redirect_from:
- /benchmark/user-guide/
---
Expand Down
32 changes: 0 additions & 32 deletions _benchmark/user-guide/optimizing-benchmarks/index.md

This file was deleted.

14 changes: 0 additions & 14 deletions _benchmark/user-guide/understanding-results/index.md

This file was deleted.

19 changes: 0 additions & 19 deletions _benchmark/user-guide/working-with-workloads/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion _benchmark/version-history.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Version history
nav_order: 101
nav_order: 105
---

# Version history
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/workloads/vectorsearch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Vector search
nav_order: 35
nav_order: 85
---

# Vector search workload
Expand Down
Loading