Settings

The asynchronous search plugin adds several settings to the standard OpenSearch cluster settings. They are dynamic, so you can change the default behavior of the plugin without restarting your cluster. You can mark the settings as persistent or transient.

For example, to update the retention period of the result index:

  1. PUT _cluster/settings
  2. {
  3.   "transient": {
  4.     "plugins.asynchronous_search.max_wait_for_completion_timeout": "5m"
  5.   }
  6. }
SettingDefaultDescription
plugins.asynchronous_search.max_search_running_time12 hoursThe maximum running time for the search beyond which the search is terminated.
plugins.asynchronous_search.node_concurrent_running_searches20The concurrent searches running per coordinator node.
plugins.asynchronous_search.max_keep_alive5 daysThe maximum amount of time that search results can be stored in the cluster.
plugins.asynchronous_search.max_wait_for_completion_timeout1 minuteThe maximum value for the wait_for_completion_timeout parameter.
plugins.asynchronous_search.persist_search_failuresfalsePersist asynchronous search results that end with a search failure in the system index.