opensearch-docs-cn/_search-plugins/knn/settings.md

25 lines
1.5 KiB
Markdown
Raw Normal View History

2021-05-05 13:09:47 -04:00
---
layout: default
title: Settings
parent: k-NN
nav_order: 7
2021-05-28 18:20:24 -04:00
redirect_from: /docs/knn/settings/
2021-05-05 13:09:47 -04:00
---
2021-05-11 12:29:35 -04:00
# k-NN settings
2021-05-05 13:09:47 -04:00
The k-NN plugin adds several new cluster settings.
2021-05-05 13:09:47 -04:00
## Cluster settings
Setting | Default | Description
:--- | :--- | :---
2021-05-11 12:29:35 -04:00
`knn.algo_param.index_thread_qty` | 1 | The number of threads used for graph creation. Keeping this value low reduces the CPU impact of the k-NN plugin, but also reduces indexing performance.
2021-05-05 13:09:47 -04:00
`knn.cache.item.expiry.enabled` | false | Whether to remove graphs that have not been accessed for a certain duration from memory.
`knn.cache.item.expiry.minutes` | 3h | If enabled, the idle time before removing a graph from memory.
`knn.circuit_breaker.unset.percentage` | 75.0 | The native memory usage threshold for the circuit breaker. Memory usage must be below this percentage of `knn.memory.circuit_breaker.limit` for `knn.circuit_breaker.triggered` to remain false.
`knn.circuit_breaker.triggered` | false | True when memory usage exceeds the `knn.circuit_breaker.unset.percentage` value.
2021-05-11 12:29:35 -04:00
`knn.memory.circuit_breaker.limit` | 50% | The native memory limit for graphs. At the default value, if a machine has 100 GB of memory and the JVM uses 32 GB, the k-NN plugin uses 50% of the remaining 68 GB (34 GB). If memory usage exceeds this value, k-NN removes the least recently used graphs.
`knn.memory.circuit_breaker.enabled` | true | Whether to enable the k-NN memory circuit breaker.
`knn.plugin.enabled`| true | Enables or disables the k-NN plugin.