Skip to content

Commit dd59720

Browse files
kibanamachinelukasolson
kibanamachine
and
lukasolson
authored
[8.11] Deprecate search session documentation (#192224) (#192769)
# Backport This will backport the following commits from `main` to `8.11`: - [Deprecate search session documentation (#192224)](#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":"lukas@elastic.co"},"sourceCommit":{"committedDate":"2024-09-12T20:35:55Z","message":"Deprecate search session documentation (#192224)\n\n## Summary\r\n\r\nResolves https://github.com/elastic/kibana/issues/186334.\r\n(See #187923 and\r\nhttps://github.com//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 (#192224)\n\n## Summary\r\n\r\nResolves https://github.com/elastic/kibana/issues/186334.\r\n(See #187923 and\r\nhttps://github.com//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 (#192224)\n\n## Summary\r\n\r\nResolves https://github.com/elastic/kibana/issues/186334.\r\n(See #187923 and\r\nhttps://github.com//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 <lukas@elastic.co>
1 parent d146b5c commit dd59720

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎docs/discover/search-sessions.asciidoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[[search-sessions]]
22
== Run a search session in the background
33

4+
deprecated::[8.15.0,Search Sessions are deprecated and will be removed in a future version.]
5+
46
Sometimes you might need to search through large amounts of data, no matter
57
how long the search takes.
68
Consider a threat hunting scenario, where you need to search through years of data.

‎docs/management/advanced-options.asciidoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -506,8 +506,8 @@ Includes {ref}/frozen-indices.html[frozen indices] in results. Searching through
506506
frozen indices might increase the search time. This setting is off by default.
507507
Users must opt-in to include frozen indices.
508508

509-
[[search-timeout]]`search:timeout`:: Change the maximum timeout, in milliseconds (ms), for a search
510-
session. To disable the timeout and allow queries to run to completion, set to 0. The default is 600,000 ms, or 10 minutes.
509+
[[search-timeout]]`search:timeout`:: Change the maximum timeout, in milliseconds (ms), for search requests. To disable
510+
the timeout and allow queries to run to completion, set to 0. The default is `600000`, or 10 minutes.
511511

512512
[float]
513513
[[kibana-siem-settings]]

‎docs/settings/search-sessions-settings.asciidoc‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,20 @@
55
<titleabbrev>Search sessions settings</titleabbrev>
66
++++
77

8+
deprecated::[8.15.0,Search Sessions are deprecated and will be removed in a future version.]
9+
810
Configure the search session settings in your `kibana.yml` configuration file.
911

10-
`data.search.sessions.enabled` {ess-icon}::
12+
deprecated:[8.15.0] `data.search.sessions.enabled` {ess-icon}::
1113
Set to `true` (default) to enable search sessions.
1214

13-
`data.search.sessions.pageSize` {ess-icon}::
14-
How many search sessions {kib} processes at once while monitoring
15-
session progress. The default is `100`.
16-
17-
`data.search.sessions.notTouchedTimeout` {ess-icon}::
15+
deprecated:[8.15.0] `data.search.sessions.notTouchedTimeout` {ess-icon}::
1816
How long {kib} stores search results from unsaved sessions,
1917
after the last search in the session completes. The default is `5m`.
2018

21-
`data.search.sessions.maxUpdateRetries` {ess-icon}::
19+
deprecated:[8.15.0] `data.search.sessions.maxUpdateRetries` {ess-icon}::
2220
How many retries {kib} can perform while attempting to save a search session. The default is `10`.
2321

24-
`data.search.sessions.defaultExpiration` {ess-icon}::
22+
deprecated:[8.15.0] `data.search.sessions.defaultExpiration` {ess-icon}::
2523
How long search session results are stored before they are deleted.
2624
Extending a search session resets the expiration by the same value. The default is `7d`.

0 commit comments

Comments
 (0)