Opensearch Settings
Properties
| Property | Type | Required | Description |
|---|---|---|---|
action_auto_create_index_enabled | boolean | no | Explicitly allow or block automatic creation of indices. Defaults to true |
action_destructive_requires_name | boolean | no | |
auth_failure_listeners | object | no | schema details |
cluster_max_shards_per_node | integer | no | Controls the number of shards allowed in the cluster per data node |
cluster_routing_allocation_node_concurrent_recoveries | integer | no | How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2. |
email-sender | object | no | schema details |
enable_security_audit | boolean | no | |
http_max_content_length | integer | no | Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. |
http_max_header_size | integer | no | The max size of allowed headers, in bytes |
http_max_initial_line_length | integer | no | The max length of an HTTP URL, in bytes |
indices_fielddata_cache_size | integer | no | Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations. |
indices_memory_index_buffer_size | integer | no | Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. |
indices_memory_max_index_buffer_size | integer | no | Absolute value. Default is unbound. Doesn’t work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit. |
indices_memory_min_index_buffer_size | integer | no | Absolute value. Default is 48mb. Doesn’t work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit. |
indices_queries_cache_size | integer | no | Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality. |
indices_query_bool_max_clause_count | integer | no | Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value. |
indices_recovery_max_bytes_per_sec | integer | no | Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb |
indices_recovery_max_concurrent_file_chunks | integer | no | Number of file chunks sent in parallel for each recovery. Defaults to 2. |
ism-history | object | no | schema details |
knn_memory_circuit_breaker_enabled | boolean | no | Enable or disable KNN memory circuit breaker. Defaults to true. |
knn_memory_circuit_breaker_limit | integer | no | Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size. |
override_main_response_version | boolean | no | Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false |
plugins_alerting_filter_by_backend_roles | boolean | no | Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false |
reindex_remote_whitelist | array[string] | no | Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart. |
script_max_compilations_rate | string | no | Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context |
search_backpressure | object | no | schema details |
search_max_buckets | integer | no | Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. |
shard_indexing_pressure | object | no | schema details |
thread_pool_analyze_queue_size | integer | no | Size for the thread pool queue. See documentation for exact details. |
thread_pool_analyze_size | integer | no | Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
thread_pool_force_merge_size | integer | no | Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
thread_pool_get_queue_size | integer | no | Size for the thread pool queue. See documentation for exact details. |
thread_pool_get_size | integer | no | Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
thread_pool_search_queue_size | integer | no | Size for the thread pool queue. See documentation for exact details. |
thread_pool_search_size | integer | no | Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
thread_pool_search_throttled_queue_size | integer | no | Size for the thread pool queue. See documentation for exact details. |
thread_pool_search_throttled_size | integer | no | Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
thread_pool_write_queue_size | integer | no | Size for the thread pool queue. See documentation for exact details. |
thread_pool_write_size | integer | no | Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
Last updated on