diff --git a/_benchmark/FAQs.md b/_benchmark/FAQs.md index c69a664c409..e2e6fd1b07f 100644 --- a/_benchmark/FAQs.md +++ b/_benchmark/FAQs.md @@ -1,7 +1,7 @@ --- layout: default title: FAQs -nav_order: 103 +nav_order: 115 --- # FAQs diff --git a/_benchmark/anatomy-of-a-workload.md b/_benchmark/anatomy-of-a-workload.md index 2bfbb913ea0..4f8479adc38 100644 --- a/_benchmark/anatomy-of-a-workload.md +++ b/_benchmark/anatomy-of-a-workload.md @@ -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/ --- @@ -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/). ## index.json diff --git a/_benchmark/choosing-a-workload.md b/_benchmark/choosing-a-workload.md index f484384a3fe..3175f1d7324 100644 --- a/_benchmark/choosing-a-workload.md +++ b/_benchmark/choosing-a-workload.md @@ -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/). diff --git a/_benchmark/common-operations.md b/_benchmark/common-operations.md index a3d5e4e98a2..63a0748cdae 100644 --- a/_benchmark/common-operations.md +++ b/_benchmark/common-operations.md @@ -1,7 +1,7 @@ --- layout: default title: Common operations -nav_order: 15 +nav_order: 25 redirect_from: - /benchmark/user-guide/understanding-workloads/common-operations/ --- diff --git a/_benchmark/user-guide/working-with-workloads/contributing-workloads.md b/_benchmark/contributing-workloads.md similarity index 97% rename from _benchmark/user-guide/working-with-workloads/contributing-workloads.md rename to _benchmark/contributing-workloads.md index da854a4263a..1070ff4dec9 100644 --- a/_benchmark/user-guide/working-with-workloads/contributing-workloads.md +++ b/_benchmark/contributing-workloads.md @@ -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 diff --git a/_benchmark/user-guide/working-with-workloads/creating-custom-workloads.md b/_benchmark/creating-custom-workloads.md similarity index 99% rename from _benchmark/user-guide/working-with-workloads/creating-custom-workloads.md rename to _benchmark/creating-custom-workloads.md index c91993b5189..da3532cf371 100644 --- a/_benchmark/user-guide/working-with-workloads/creating-custom-workloads.md +++ b/_benchmark/creating-custom-workloads.md @@ -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 diff --git a/_benchmark/user-guide/optimizing-benchmarks/distributed-load.md b/_benchmark/distributed-load.md similarity index 96% rename from _benchmark/user-guide/optimizing-benchmarks/distributed-load.md rename to _benchmark/distributed-load.md index 8d68a0f6475..33b3bd51256 100644 --- a/_benchmark/user-guide/optimizing-benchmarks/distributed-load.md +++ b/_benchmark/distributed-load.md @@ -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 diff --git a/_benchmark/user-guide/optimizing-benchmarks/expand-data-corpus.md b/_benchmark/expand-data-corpus.md similarity index 97% rename from _benchmark/user-guide/optimizing-benchmarks/expand-data-corpus.md rename to _benchmark/expand-data-corpus.md index 73deae40689..913aee39be6 100644 --- a/_benchmark/user-guide/optimizing-benchmarks/expand-data-corpus.md +++ b/_benchmark/expand-data-corpus.md @@ -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 diff --git a/_benchmark/features/index.md b/_benchmark/features/index.md index 35a5f65d987..e402d01b0e2 100644 --- a/_benchmark/features/index.md +++ b/_benchmark/features/index.md @@ -1,7 +1,7 @@ --- layout: default title: Additional features -nav_order: 30 +nav_order: 80 has_children: true has_toc: false redirect_from: diff --git a/_benchmark/user-guide/working-with-workloads/finetune-workloads.md b/_benchmark/finetune-workloads.md similarity index 98% rename from _benchmark/user-guide/working-with-workloads/finetune-workloads.md rename to _benchmark/finetune-workloads.md index d150247ad8e..8581a4a22e4 100644 --- a/_benchmark/user-guide/working-with-workloads/finetune-workloads.md +++ b/_benchmark/finetune-workloads.md @@ -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 diff --git a/_benchmark/index.md b/_benchmark/index.md index 6d7b018e4a0..00e098d43e6 100644 --- a/_benchmark/index.md +++ b/_benchmark/index.md @@ -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/" diff --git a/_benchmark/migration-assistance.md b/_benchmark/migration-assistance.md index 37cffa0797c..0290df603cb 100644 --- a/_benchmark/migration-assistance.md +++ b/_benchmark/migration-assistance.md @@ -1,7 +1,7 @@ --- layout: default title: Migration assistance -nav_order: 102 +nav_order: 110 --- # Migrating from 1.X to 2.X diff --git a/_benchmark/user-guide/optimizing-benchmarks/performance-testing-best-practices.md b/_benchmark/performance-testing-best-practices.md similarity index 98% rename from _benchmark/user-guide/optimizing-benchmarks/performance-testing-best-practices.md rename to _benchmark/performance-testing-best-practices.md index 2d191983b62..82dbc948ce9 100644 --- a/_benchmark/user-guide/optimizing-benchmarks/performance-testing-best-practices.md +++ b/_benchmark/performance-testing-best-practices.md @@ -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 diff --git a/_benchmark/quickstart.md b/_benchmark/quickstart.md index 12b428cb217..2dfa5fdb8af 100644 --- a/_benchmark/quickstart.md +++ b/_benchmark/quickstart.md @@ -1,7 +1,7 @@ --- layout: default title: Quickstart -nav_order: 2 +nav_order: 5 --- # OpenSearch Benchmark quickstart diff --git a/_benchmark/user-guide/optimizing-benchmarks/randomizing-queries.md b/_benchmark/randomizing-queries.md similarity index 98% rename from _benchmark/user-guide/optimizing-benchmarks/randomizing-queries.md rename to _benchmark/randomizing-queries.md index 2242e7e9727..592ed504e9d 100644 --- a/_benchmark/user-guide/optimizing-benchmarks/randomizing-queries.md +++ b/_benchmark/randomizing-queries.md @@ -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 diff --git a/_benchmark/reference/index.md b/_benchmark/reference/index.md index 460f8677d26..cde40e926a8 100644 --- a/_benchmark/reference/index.md +++ b/_benchmark/reference/index.md @@ -1,7 +1,7 @@ --- layout: default title: Reference -nav_order: 25 +nav_order: 75 has_children: true redirect_from: - /benchmark/reference/ diff --git a/_benchmark/reference/summary-report.md b/_benchmark/reference/summary-report.md index e71197d8e1f..96430876f01 100644 --- a/_benchmark/reference/summary-report.md +++ b/_benchmark/reference/summary-report.md @@ -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 diff --git a/_benchmark/user-guide/working-with-workloads/running-workloads.md b/_benchmark/running-workloads.md similarity index 99% rename from _benchmark/user-guide/working-with-workloads/running-workloads.md rename to _benchmark/running-workloads.md index a8f9676a4a5..5682df72d52 100644 --- a/_benchmark/user-guide/working-with-workloads/running-workloads.md +++ b/_benchmark/running-workloads.md @@ -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 diff --git a/_benchmark/user-guide/optimizing-benchmarks/target-throughput.md b/_benchmark/target-throughput.md similarity index 98% rename from _benchmark/user-guide/optimizing-benchmarks/target-throughput.md rename to _benchmark/target-throughput.md index 792ea291015..b964c04bc62 100644 --- a/_benchmark/user-guide/optimizing-benchmarks/target-throughput.md +++ b/_benchmark/target-throughput.md @@ -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 diff --git a/_benchmark/user-guide/index.md b/_benchmark/user-guide/index.md index 3f5937b1912..174362aee60 100644 --- a/_benchmark/user-guide/index.md +++ b/_benchmark/user-guide/index.md @@ -1,7 +1,7 @@ --- layout: default title: User guide -nav_order: 5 +nav_order: 10 has_children: true has_toc: false more_cards: @@ -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/ --- diff --git a/_benchmark/user-guide/optimizing-benchmarks/index.md b/_benchmark/user-guide/optimizing-benchmarks/index.md deleted file mode 100644 index d626e64d4d5..00000000000 --- a/_benchmark/user-guide/optimizing-benchmarks/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: Optimizing benchmarks -nav_order: 25 -parent: User guide -has_children: true -has_toc: false -more_cards: - - heading: "Running distributed loads" - description: "Configure multiple load generator machines to run large-scale benchmarks" - link: "/benchmark/user-guide/optimizing-benchmarks/distributed-load/" - - heading: "Expanding a workload's data corpus" - description: "Increase dataset size and complexity for more realistic benchmark scenarios" - link: "/benchmark/user-guide/optimizing-benchmarks/expand-data-corpus/" - - heading: "Target throughput" - description: "Set specific throughput targets to match your production workload patterns" - link: "/benchmark/user-guide/optimizing-benchmarks/target-throughput/" - - heading: "Performance testing best practices" - description: "Follow these best practices to achieve more meaningful benchmark results" - link: "/benchmark/user-guide/optimizing-benchmarks/performance-testing-best-practices/" - - heading: "Randomizing queries" - description: "Generate varied search patterns to simulate real-world queries" - link: "/benchmark/user-guide/optimizing-benchmarks/randomizing-queries/" -redirect_from: - - /benchmark/user-guide/optimizing-benchmarks/ ---- - -# Optimizing benchmarks - -This section provides information about optimizing the benchmark tools for your cluster. - -{% include cards.html cards=page.more_cards %} \ No newline at end of file diff --git a/_benchmark/user-guide/understanding-results/index.md b/_benchmark/user-guide/understanding-results/index.md deleted file mode 100644 index 4c05226f0c7..00000000000 --- a/_benchmark/user-guide/understanding-results/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: default -title: Understanding results -nav_order: 20 -parent: User guide -has_children: true -redirect_from: - - /benchmark/user-guide/understanding-results/ ---- - -After [running a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/running-workloads/), OpenSearch Benchmark produces a series of metrics. This section describes how to interpret benchmark results through summary reports and how to visualize metrics using telemetry devices: - -- [How metrics are reported]({{site.url}}{{site.baseurl}}/benchmark/reference/summary-report/) -- [How to visualize metrics]({{site.url}}{{site.baseurl}}/benchmark/reference/telemetry/) \ No newline at end of file diff --git a/_benchmark/user-guide/working-with-workloads/index.md b/_benchmark/user-guide/working-with-workloads/index.md deleted file mode 100644 index 3302492fac7..00000000000 --- a/_benchmark/user-guide/working-with-workloads/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default -title: Working with workloads -nav_order: 15 -parent: User guide -has_toc: false -has_children: true -redirect_from: - - /benchmark/user-guide/working-with-workloads/ ---- - -# Working with workloads - -Once you're familiar with the [anatomy of a workload]({{site.url}}{{site.baseurl}}/benchmark/anatomy-of-a-workload/) and have [chosen a workload]({{site.url}}{{site.baseurl}}/benchmark/choosing-a-workload/), you can begin working with workloads. - -- [Running workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/running-workloads/): Learn how to run an OpenSearch Benchmark workload. -- [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/creating-custom-workloads/): Create a custom workload with your own datasets. -- [Fine-tuning workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/finetune-workloads/): Fine-tune your custom workload according to the needs of your cluster. -- [Contributing workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/contributing-workloads/): Contribute your custom workload for the OpenSearch community to use. \ No newline at end of file diff --git a/_benchmark/version-history.md b/_benchmark/version-history.md index 8110b02047b..4ce30156e4f 100644 --- a/_benchmark/version-history.md +++ b/_benchmark/version-history.md @@ -1,7 +1,7 @@ --- layout: default title: Version history -nav_order: 101 +nav_order: 105 --- # Version history diff --git a/_benchmark/workloads/vectorsearch.md b/_benchmark/workloads/vectorsearch.md index 7eebf0aab2c..fcec58d4228 100644 --- a/_benchmark/workloads/vectorsearch.md +++ b/_benchmark/workloads/vectorsearch.md @@ -1,7 +1,7 @@ --- layout: default title: Vector search -nav_order: 35 +nav_order: 85 --- # Vector search workload