Background search and search sessions settings in Kibana

Background search settings

data.search.sessions.enabled

Supported on:

false by default. Set to true to enable background searches.

Datatype: bool

Default: false

data.search.sessions.maxUpdateRetries

Supported on:

How many retries Kibana can perform while attempting to send a search to the background. The default is 10.

Datatype: int

Default: 10

data.search.sessions.defaultExpiration

Supported on:

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.

Datatype: string

Default: 7d

Search sessions settings (deprecated)

data.search.sessions.enabled

Supported on:

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

Datatype: bool

Default: false

Deprecation details

Deprecated in 8.15.0. Replaced by the background search feature in 9.2.

data.search.sessions.notTouchedTimeout

Supported on:

Deprecated in 8.15.0. How long Kibana stores search results from unsaved sessions, after the last search in the session completes. The default is 5m.

Datatype: string

Default: 5m

Deprecation details

Deprecated in 8.15.0. This setting was part of the search sessions feature, which has been replaced by background search in 9.2.

data.search.sessions.maxUpdateRetries

Supported on:

Deprecated in 8.15.0. How many retries Kibana can perform while attempting to save a search session. The default is 10.

Datatype: int

Default: 10

Deprecation details

Deprecated in 8.15.0. Replaced by the background search feature in 9.2.

data.search.sessions.defaultExpiration

Supported on:

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.

Datatype: string

Default: 7d

Deprecation details

Deprecated in 8.15.0. Replaced by the background search feature in 9.2.