From b26e7712a69a20655f293ea8997db0be963b8f6f Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 7 Nov 2023 13:41:59 -0600 Subject: [PATCH] Delete _benchmark/workloads/reference directory (#5516) Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _benchmark/workloads/reference/index.md | 109 ---------------------- _benchmark/workloads/reference/indices.md | 30 ------ 2 files changed, 139 deletions(-) delete mode 100644 _benchmark/workloads/reference/index.md delete mode 100644 _benchmark/workloads/reference/indices.md diff --git a/_benchmark/workloads/reference/index.md b/_benchmark/workloads/reference/index.md deleted file mode 100644 index 234fb7f9..00000000 --- a/_benchmark/workloads/reference/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -layout: default -title: Workload reference -nav_order: 60 -has_children: true ---- - -# OpenSearch Benchmark workload reference - -A workload is a specification of one or more benchmarking scenarios. A workload typically includes the following: - -- One or more data streams that are ingested into indexes -- A set of queries and operations that are invoked as part of the benchmark - -This section provides a list of options and examples you can use when customizing or using a workload. - -For more information about what comprises a workload, see [Anatomy of a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/concepts#anatomy-of-a-workload). - - -## Workload examples - -If you want to try certain workloads before creating your own, use the following examples. - -### Running unthrottled - -In the following example, OpenSearch Benchmark runs an unthrottled bulk index operation for 1 hour against the `movies` index: - -```json -{ - "description": "Tutorial benchmark for OpenSearch Benchmark", - "indices": [ - { - "name": "movies", - "body": "index.json" - } - ], - "corpora": [ - { - "name": "movies", - "documents": [ - { - "source-file": "movies-documents.json", - "document-count": 11658903, # Fetch document count from command line - "uncompressed-bytes": 1544799789 # Fetch uncompressed bytes from command line - } - ] - } - ], - "schedule": [ - { - "operation": "bulk", - "warmup-time-period": 120, - "time-period": 3600, - "clients": 8 - } -] -} -``` - -### Workload with a single task - -The following workload runs a benchmark with a single task: a `match_all` query. Because no `clients` are indicated, only one client is used. According to the `schedule`, the workload runs the `match_all` query at 10 operations per second with 1 client, uses 100 iterations to warm up, and uses the next 100 iterations to measure the benchmark: - -```json -{ - "description": "Tutorial benchmark for OpenSearch Benchmark", - "indices": [ - { - "name": "movies", - "body": "index.json" - } - ], - "corpora": [ - { - "name": "movies", - "documents": [ - { - "source-file": "movies-documents.json", - "document-count": 11658903, # Fetch document count from command line - "uncompressed-bytes": 1544799789 # Fetch uncompressed bytes from command line - } - ] - } - ], -{ - "schedule": [ - { - "operation": { - "operation-type": "search", - "index": "_all", - "body": { - "query": { - "match_all": {} - } - } - }, - "warmup-iterations": 100, - "iterations": 100, - "target-throughput": 10 - } - ] -} -} -``` - -## Next steps - -- For more information about configuring OpenSearch Benchmark, see [Configuring OpenSearch Benchmark]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/). -- For a list of prepackaged workloads for OpenSearch Benchmark, see the [opensearch-benchmark-workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads) repository. diff --git a/_benchmark/workloads/reference/indices.md b/_benchmark/workloads/reference/indices.md deleted file mode 100644 index 3b7e916b..00000000 --- a/_benchmark/workloads/reference/indices.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: indices -parent: Workload reference -nav_order: 65 ---- - -# indices - -The `indices` element contains a list of all indexes used in the workload. - -## Example - -```json -"indices": [ - { - "name": "geonames", - "body": "geonames-index.json", - } -] -``` - -## Configuration options - -Use the following options with `indices`: - -Parameter | Required | Type | Description -:--- | :--- | :--- | :--- -`name` | Yes | String | The name of the index template. -`body` | No | String | The file name corresponding to the index definition used in the body of the Create Index API.