github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

Deprecate search session documentation (#192224)

Browse source 
## 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.
This commit is contained in:
Lukas Olson 2024-09-12 22:35:55 +02:00 • committed by GitHub
parent 850cdf0275
commit 040714c2b7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/discover/search-sessions.asciidoc
View file

@ -1,6 +1,8 @@
[[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.

4
docs/management/advanced-options.asciidoc
View file

@ -556,8 +556,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 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.
[[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.
[float]
[[kibana-siem-settings]]

14
docs/settings/search-sessions-settings.asciidoc
View file

@ -5,22 +5,20 @@
<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.
`data.search.sessions.enabled` {ess-icon}::
deprecated:[8.15.0] `data.search.sessions.enabled` {ess-icon}::
Set to `true` (default) to enable search sessions.
`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}::
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`.
`data.search.sessions.maxUpdateRetries` {ess-icon}::
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`.
`data.search.sessions.defaultExpiration` {ess-icon}::
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`.