Skip to content

Commit 3aeb5a5

Browse files
Update query-performance-factor.md (#1539)
* Update query-performance-factor.md Fixing the BDB API and linking Workers with CPUs * Updated RS CM UI query performance factor config screenshot * Fixed broken in-page anchor links to calculate query performance factor --------- Co-authored-by: Rachel Elledge <rachel.elledge@redislabs.com>
1 parent 40d1eb2 commit 3aeb5a5

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If you do not have a cluster that supports Redis Query Engine, [install Redis En
3232

3333
1. Calculate the RAM requirements using the [Index Size Calculator](https://redis.io/redisearch-sizing-calculator/). The total RAM required is the sum of the dataset and index sizes.
3434

35-
1. [Determine the query performance factor](#calculate-performance-factor) you want and the required number of CPUs. Unused CPUs, above the 20% necessary for Redis, can be used for the scalable Redis Query Engine.
35+
1. [Determine the query performance factor](#calculate-query-performance-factor) you want and the required number of CPUs. Unused CPUs, above the 20% necessary for Redis, can be used for the scalable Redis Query Engine.
3636

3737
1. Create a new Redis database with the number of CPUs configured for the query performance factor.
3838

@@ -52,7 +52,7 @@ Vertical scaling of the Redis Query Engine is achieved by provisioning additiona
5252

5353
The following table shows the number of CPUs required for each performance factor. This calculation is sensitive to how the search index and queries are defined. Certain scenarios might yield less throughput than the ratios in the following table.
5454

55-
| Scale factor | Minimum CPUs required for Redis Query Engine |
55+
| Scale factor | Minimum CPUs required for Redis Query Engine <WORKERS> |
5656
|----------------|-----------------------------------------|
5757
| None (default) | 1 |
5858
| 2 | 3 |
@@ -71,7 +71,7 @@ The following table shows the number of CPUs required for each performance facto
7171
| CPUs per node | 8 |
7272
| Available CPUs | floor(0.8 * 8)=6 |
7373
| Scale factor | 4x |
74-
| Minimum CPUs required for scale factor | 6 |
74+
| Minimum CPUs required for scale factor - WORKERS | 6 |
7575

7676
## Configure query performance factor manually
7777

@@ -168,12 +168,12 @@ To create a database and configure the query performance factor, use the [create
168168
"conns": 32,
169169
"module_list": [{
170170
"module_name": "search",
171-
"module_args": "MT_MODE MT_MODE_FULL WORKER_THREADS <NUMBER_OF_CPUS>"
171+
"module_args": "WORKERS <NUMBER_OF_THREADS>"
172172
}]
173173
}
174174
```
175175
176-
See [Calculate performance factor](#calculate-performance-factor) to determine the value to use for `<NUMBER_OF_CPUS>`.
176+
See [Calculate performance factor](#calculate-query-performance-factor) to determine the value to use for `<NUMBER_OF_CPUS>`.
177177
178178
#### Example REST API request for a new database
179179
@@ -196,7 +196,7 @@ The following JSON is an example request body used to create a new database with
196196
"replication": false,
197197
"module_list": [{
198198
"module_name": "search",
199-
"module_args": "MT_MODE MT_MODE_FULL WORKER_THREADS 6"
199+
"module_args": "WORKERS 6"
200200
}]
201201
}
202202
```
@@ -239,7 +239,7 @@ curl -o /dev/null -s -k -u "<user>:<password>" https://<host>:9443/v1/bdbs/$DB_I
239239
"modules": [
240240
{
241241
"module_name": "search",
242-
"new_module_args": "MT_MODE MT_MODE_FULL WORKER_THREADS '$CPU'",
242+
"new_module_args": "WORKERS '$CPU'",
243243
"current_module": "'$MODULE_ID'",
244244
"new_module": "'$MODULE_ID'"
245245
}
Loading

0 commit comments

Comments
 (0)