Back to Kibana

Background search and search sessions settings in {{kib}} [search-session-settings-kb]

docs/reference/configuration-reference/search-sessions-settings.md

9.4.02.5 KB
Original Source

Background search and search sessions settings in {{kib}} [search-session-settings-kb]

:::{important} - Background search replaces Search sessions

Background search is a feature introduced in version 9.2. It replaces the Search sessions feature, deprecated in version 8.15. :::

:::{note} If a setting is applicable to {{ech}} environments, its name is followed by this icon: :::

:::::{applies-switch}

::::{applies-item} stack: ga 9.2+

data.search.sessions.enabled : false by default. Set to true to enable background searches.

data.search.sessions.maxUpdateRetries : How many retries {{kib}} can perform while attempting to send a search to the background. The default is 10.

data.search.sessions.defaultExpiration : How long background search results are stored before they expire and are deleted. When users extend the validity period of the background search, this setting also determines by how long. The default is 7d. ::::

::::{applies-item} stack: ga 9.0-9.1

data.search.sessions.enabled : Deprecated in 8.15.0. false by default. Set to true to enable search sessions.

data.search.sessions.notTouchedTimeout : Deprecated in 8.15.0. How long {{kib}} stores search results from unsaved sessions, after the last search in the session completes. The default is 5m.

data.search.sessions.maxUpdateRetries : Deprecated in 8.15.0. How many retries {{kib}} can perform while attempting to save a search session. The default is 10.

data.search.sessions.defaultExpiration : Deprecated in 8.15.0. How long search session results are stored before they are deleted. Extending a search session resets the expiration by the same value. The default is 7d.

::::

:::::