Document more "xpack.data_enhanced.search.sessions.*" settings (#96542) (#96794)

This commit is contained in:
Anton Dosov 2021-04-12 16:59:37 +02:00 committed by GitHub
parent 5264f10c7b
commit 570c25ef67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,15 +11,33 @@ Configure the search session settings in your `kibana.yml` configuration file.
[cols="2*<"]
|===
a| `xpack.data_enhanced.`
`search.sessions.enabled`
`search.sessions.enabled` {ess-icon}
| Set to `true` (default) to enable search sessions.
a| `xpack.data_enhanced.`
`search.sessions.trackingInterval`
| The frequency for updating the state of a search session. The default is 10s.
`search.sessions.trackingInterval` {ess-icon}
| The frequency for updating the state of a search session. The default is `10s`.
a| `xpack.data_enhanced.`
`search.sessions.defaultExpiration`
`search.sessions.pageSize` {ess-icon}
| How many search sessions {kib} processes at once while monitoring
session progress. The default is `100`.
a| `xpack.data_enhanced.`
`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`.
a| `xpack.data_enhanced.`
`search.sessions.notTouchedInProgressTimeout` {ess-icon}
| How long a search session can run after a user navigates away without saving a session. The default is `1m`.
a| `xpack.data_enhanced.`
`search.sessions.maxUpdateRetries` {ess-icon}
| How many retries {kib} can perform while attempting to save a search session. The default is `3`.
a| `xpack.data_enhanced.`
`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.
Extending a search session resets the expiration by the same value. The default is `7d`.
|===