Skip to content

Commit 0907b6d

Browse files
[Docs] Edit search sessions settings page (elastic#238699)
This PR edits the search sessions/background search settings page. **Must merge the following PR first to re-add a link to a new page here:** Relates to: elastic/docs-content#3455 (cherry picked from commit 03a57fb)
1 parent d9bf48d commit 0907b6d

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,40 @@
11
---
2-
navigation_title: "Search sessions settings"
2+
navigation_title: "Background search settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/kibana/current/search-session-settings-kb.html
55
applies_to:
6-
stack: deprecated 8.15.0
7-
deployment:
8-
ess: all
9-
self: all
6+
stack: preview 9.2
7+
serverless: unavailable
108
---
119

12-
# Search sessions settings in {{kib}} [search-session-settings-kb]
10+
# Background search and search sessions settings in {{kib}} [search-session-settings-kb]
11+
12+
:::{important} - Background search replaces Search sessions
13+
14+
[Background search](docs-content://explore-analyze/discover/background-search.md) is a feature introduced in version 9.2. It replaces the **Search sessions** feature, deprecated in version 8.15.
15+
:::
1316

1417
:::{note}
1518
If a setting is applicable to {{ech}} environments, its name is followed by this icon: ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
1619
:::
1720

21+
:::::{tab-set}
22+
:group: background search
23+
24+
::::{tab-item} 9.2 and later
25+
:sync: 92
26+
`data.search.sessions.enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ech}}")
27+
: `false` by default. Set to `true` to enable background searches.
28+
29+
`data.search.sessions.maxUpdateRetries` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ech}}")
30+
: How many retries {{kib}} can perform while attempting to send a search to the background. The default is `10`.
31+
32+
`data.search.sessions.defaultExpiration` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ech}}")
33+
: How long background search results are stored before they expire and are deleted. When users extend the validity period of the background search, this setting also determines by how long. The default is `7d`.
34+
::::
35+
36+
::::{tab-item} 9.1 and earlier
37+
:sync: 91
1838
`data.search.sessions.enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ech}}")
1939
: Deprecated in 8.15.0. `false` by default. Set to `true` to enable search sessions.
2040

@@ -27,3 +47,6 @@ If a setting is applicable to {{ech}} environments, its name is followed by this
2747
`data.search.sessions.defaultExpiration` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ech}}")
2848
: Deprecated in 8.15.0. 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`.
2949

50+
::::
51+
52+
:::::

0 commit comments

Comments
 (0)