Skip to content

Commit

Permalink
[8.14] Deprecate search session documentation (elastic#192224) (elast…
Browse files Browse the repository at this point in the history 
…ic#192772)

# Backport

This will backport the following commits from `main` to `8.14`:
- [Deprecate search session documentation
(elastic#192224)](elastic#192224)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lukas
Olson","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-12T20:35:55Z","message":"Deprecate
search session documentation (elastic#192224)\n\n## Summary\r\n\r\nResolves
https://github.com/elastic/kibana/issues/186334.\r\n(See
elastic#187923
and\r\nhttps://github.com/elastic/pull/188037.)\r\n\r\nUpdates
the documentation to have a message that search sessions
are\r\ndeprecated and will be
removed.","sha":"040714c2b7b412be2d833540da95eec9462119fa","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","Team:DataDiscovery","v8.0.2","v8.1.4","v8.2.4","v8.3.4","v8.4.4","v8.5.4","v8.6.3","v8.7.2","v8.8.3","v8.9.3","v8.10.5","v8.11.5","v8.12.3","v8.15.0","v8.13.5","v8.16.0","v8.14.4","v7.17.24","backport:version"],"title":"Deprecate
search session
documentation","number":192224,"url":"https://github.com/elastic/kibana/pull/192224","mergeCommit":{"message":"Deprecate
search session documentation (elastic#192224)\n\n## Summary\r\n\r\nResolves
https://github.com/elastic/kibana/issues/186334.\r\n(See
elastic#187923
and\r\nhttps://github.com/elastic/pull/188037.)\r\n\r\nUpdates
the documentation to have a message that search sessions
are\r\ndeprecated and will be
removed.","sha":"040714c2b7b412be2d833540da95eec9462119fa"}},"sourceBranch":"main","suggestedTargetBranches":["8.0","8.1","8.2","8.3","8.4","8.5","8.6","8.7","8.8","8.9","8.10","8.11","8.12","8.15","8.13","8.14","7.17"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.3","label":"v8.3.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.4","label":"v8.4.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.5","label":"v8.5.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.7","label":"v8.7.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.8","label":"v8.8.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.9","label":"v8.9.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.10","label":"v8.10.5","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.11","label":"v8.11.5","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.12","label":"v8.12.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.13","label":"v8.13.5","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192224","number":192224,"mergeCommit":{"message":"Deprecate
search session documentation (elastic#192224)\n\n## Summary\r\n\r\nResolves
https://github.com/elastic/kibana/issues/186334.\r\n(See
elastic#187923
and\r\nhttps://github.com/elastic/pull/188037.)\r\n\r\nUpdates
the documentation to have a message that search sessions
are\r\ndeprecated and will be
removed.","sha":"040714c2b7b412be2d833540da95eec9462119fa"}},{"branch":"8.14","label":"v8.14.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.17","label":"v7.17.24","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lukas Olson <[email protected]>
  • Loading branch information
@kibanamachine @lukasolson
kibanamachine and lukasolson authored Sep 12, 2024
1 parent a688f51 commit 8cd5f1e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 2 additions & 0 deletions docs/discover/search-sessions.asciidoc
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/management/advanced-options.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 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]]
Expand Down
14 changes: 6 additions & 8 deletions docs/settings/search-sessions-settings.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit 8cd5f1e

Please sign in to comment.