added query cache to every workload and updated README.md files

Signed-off-by: Kiran Prakash <awskiran@amazon.com>
opensearch-project · Oct 27, 2023 · 93b03fa · 93b03fa
1 parent c99bea8
commit 93b03fa
Show file tree

Hide file tree

Showing 20 changed files with 20 additions and 0 deletions.
diff --git a/eventdata/README.md b/eventdata/README.md
@@ -42,6 +42,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `ingest_percentage` (default: 100): A number between 0 and 100 that defines how much of the document corpus should be ingested.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 5)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/eventdata/index.json b/eventdata/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(5)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/geonames/README.md b/geonames/README.md
@@ -44,6 +44,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `recency` (default: 0): A number between 0 and 1 that defines whether to bias towards more recent ids when simulating conflicts. See the [Benchmark docs](https://github.com/opensearch-project/OpenSearch-Benchmark/blob/main/DEVELOPER_GUIDE.md) for the full definition of this parameter. This requires to run the respective test_procedure.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 5)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/geonames/index.json b/geonames/index.json
@@ -3,6 +3,7 @@
     "index.number_of_shards": {{number_of_shards | default(5)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
     "index.store.type": "{{store_type | default('fs')}}",
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/geopoint/README.md b/geopoint/README.md
@@ -26,6 +26,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `recency` (default: 0): A number between 0 and 1 that defines whether to bias towards more recent ids when simulating conflicts. See the [Benchmark docs](https://github.com/opensearch-project/OpenSearch-Benchmark/blob/main/DEVELOPER_GUIDE.md) for the full definition of this parameter. This requires to run the respective test_procedure.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 5)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `max_num_segments`: The maximum number of segments to force-merge to.
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.

diff --git a/geopoint/index.json b/geopoint/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(5)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/geopointshape/README.md b/geopointshape/README.md
@@ -22,6 +22,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `recency` (default: 0): A number between 0 and 1 that defines whether to bias towards more recent ids when simulating conflicts. See the [Benchmark docs](https://github.com/opensearch-project/OpenSearch-Benchmark/blob/main/DEVELOPER_GUIDE.md) for the full definition of this parameter. This requires to run the respective test_procedure.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 1)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/geopointshape/index.json b/geopointshape/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(1)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/geoshape/README.md b/geoshape/README.md
@@ -21,6 +21,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `ingest_percentage` (default: 100): A number between 0 and 100 that defines how much of the document corpus should be ingested.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 1)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/geoshape/index.json b/geoshape/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(1)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/http_logs/README.md b/http_logs/README.md
@@ -40,6 +40,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `conflict_probability` (default: 25): A number between 0 and 100 that defines the probability of id conflicts. This requires to run the respective test_procedure. Combining ``conflicts=sequential`` and ``conflict-probability=0`` makes Benchmark generate index ids by itself, instead of relying on OpenSearch's `automatic id generation`.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 5)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/http_logs/index.json b/http_logs/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{ number_of_shards | default(5) }},
     "index.number_of_replicas": {{ number_of_replicas | default(0) }},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/nested/README.md b/nested/README.md
@@ -55,6 +55,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `ingest_percentage` (default: 100): A number between 0 and 100 that defines how much of the document corpus should be ingested.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 1)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/nested/index.json b/nested/index.json
@@ -3,6 +3,7 @@
     "index.number_of_shards": {{number_of_shards | default(1)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
     "index.store.type": "{{store_type | default('fs')}}",
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false | tojson)}}
   },
   "mappings": {

diff --git a/nyc_taxis/README.md b/nyc_taxis/README.md
@@ -66,6 +66,7 @@ This workload allows [specifying the following parameters](#specifying-workload-
 * `recency` (default: 0): A number between 0 and 1 that defines whether to bias towards more recent ids when simulating conflicts. See the [Benchmark docs](https://github.com/opensearch-project/OpenSearch-Benchmark/blob/main/DEVELOPER_GUIDE.md) for the full definition of this parameter. Only used by the `update` test_procedure.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 1)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `force_merge_max_num_segments` (default: unset): An integer specifying the max amount of segments the force-merge operation should use.

diff --git a/nyc_taxis/index.json b/nyc_taxis/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(1)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/pmc/README.md b/pmc/README.md
@@ -36,6 +36,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `max_num_segments`: The number of segments to target when doing a force merge (default: -1)
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 5)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/pmc/index.json b/pmc/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(5)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {

diff --git a/so/README.md b/so/README.md
@@ -48,6 +48,7 @@ This workload allows the following parameters to be specified using `--workload-
 * `ingest_percentage` (default: 100): A number between 0 and 100 that defines how much of the document corpus should be ingested.
 * `number_of_replicas` (default: 0)
 * `number_of_shards` (default: 5)
+* `query_cache_enabled` (default: false)
 * `requests_cache_enabled` (default: false)
 * `source_enabled` (default: true): A boolean defining whether the `_source` field is stored in the index.
 * `index_settings`: A list of index settings. Index settings defined elsewhere (e.g. `number_of_replicas`) need to be overridden explicitly.

diff --git a/so/index.json b/so/index.json
@@ -2,6 +2,7 @@
   "settings": {
     "index.number_of_shards": {{number_of_shards | default(5)}},
     "index.number_of_replicas": {{number_of_replicas | default(0)}},
+    "index.queries.cache.enabled": {{query_cache_enabled | default(false) | tojson}},
     "index.requests.cache.enable": {{requests_cache_enabled | default(false) | tojson}}
   },
   "mappings": {