From 0cb6a1cb432e614873e107cf042b97502b98b7dd Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 16 Oct 2024 13:12:35 -0700 Subject: [PATCH] Revert "Deprecate search session documentation (#192224)" This reverts commit 040714c2b7b412be2d833540da95eec9462119fa. --- docs/discover/search-sessions.asciidoc | 2 -- docs/management/advanced-options.asciidoc | 4 ++-- docs/settings/search-sessions-settings.asciidoc | 14 ++++++++------ 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/discover/search-sessions.asciidoc b/docs/discover/search-sessions.asciidoc index e7d7466b5ae0c..663c4231c0718 100644 --- a/docs/discover/search-sessions.asciidoc +++ b/docs/discover/search-sessions.asciidoc @@ -1,8 +1,6 @@ [[search-sessions]] == Run a search session in the background -deprecated::[8.15.0,Search Sessions are deprecated and will be removed in a future version.] - Sometimes you might need to search through large amounts of data, no matter how long the search takes. Consider a threat hunting scenario, where you need to search through years of data. diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 96dd0cd736cd0..cd602c0bdbdda 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -550,8 +550,8 @@ Includes {ref}/frozen-indices.html[frozen indices] in results. Searching through frozen indices might increase the search time. This setting is off by default. Users must opt-in to include frozen indices. -[[search-timeout]]`search:timeout`:: Change the maximum timeout, in milliseconds (ms), for search requests. To disable -the timeout and allow queries to run to completion, set to 0. The default is `600000`, or 10 minutes. +[[search-timeout]]`search:timeout`:: Change the maximum timeout, in milliseconds (ms), for a search +session. To disable the timeout and allow queries to run to completion, set to 0. The default is 600,000 ms, or 10 minutes. [float] [[kibana-siem-settings]] diff --git a/docs/settings/search-sessions-settings.asciidoc b/docs/settings/search-sessions-settings.asciidoc index 01898549189b7..2862dec25b881 100644 --- a/docs/settings/search-sessions-settings.asciidoc +++ b/docs/settings/search-sessions-settings.asciidoc @@ -5,20 +5,22 @@ Search sessions settings ++++ -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}:: +`data.search.sessions.enabled` {ess-icon}:: Set to `true` (default) to enable search sessions. -deprecated:[8.15.0] `data.search.sessions.notTouchedTimeout` {ess-icon}:: +`data.search.sessions.pageSize` {ess-icon}:: +How many search sessions {kib} processes at once while monitoring +session progress. The default is `100`. + +`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}:: +`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}:: +`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`.