kibana/docs/settings/search-sessions-settings.asciidoc
Lukas Olson 040714c2b7
Deprecate search session documentation (#192224)
## Summary

Resolves https://github.com/elastic/kibana/issues/186334.
(See https://github.com/elastic/kibana/issues/187923 and
https://github.com/elastic/kibana/pull/188037.)

Updates the documentation to have a message that search sessions are
deprecated and will be removed.
2024-09-12 13:35:55 -07:00

24 lines
1 KiB
Text

[[search-session-settings-kb]]
=== Search sessions settings in {kib}
++++
<titleabbrev>Search sessions settings</titleabbrev>
++++
deprecated::[8.15.0,Search Sessions are deprecated and will be removed in a future version.]
Configure the search session settings in your `kibana.yml` configuration file.
deprecated:[8.15.0] `data.search.sessions.enabled` {ess-icon}::
Set to `true` (default) to enable search sessions.
deprecated:[8.15.0] `data.search.sessions.notTouchedTimeout` {ess-icon}::
How long {kib} stores search results from unsaved sessions,
after the last search in the session completes. The default is `5m`.
deprecated:[8.15.0] `data.search.sessions.maxUpdateRetries` {ess-icon}::
How many retries {kib} can perform while attempting to save a search session. The default is `10`.
deprecated:[8.15.0] `data.search.sessions.defaultExpiration` {ess-icon}::
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`.