Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for courier:batchSearches UI setting #46053

Merged
merged 8 commits into from
Sep 26, 2019
Merged

Add docs for courier:batchSearches UI setting #46053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9882d51
Add docs for courier:batchSearches UI setting
lukasolson Sep 18, 2019
da2af81
Update ui_setting_defaults.js
lukasolson Sep 25, 2019
28444a1
Update ui_setting_defaults.js
lukasolson Sep 25, 2019
d3184b9
Update advanced-options.asciidoc
lukasolson Sep 25, 2019
1797639
Update advanced-options.asciidoc
lukasolson Sep 25, 2019
bfa991f
Update ui_setting_defaults.js
lukasolson Sep 25, 2019
116b4a8
Update advanced-options.asciidoc
lukasolson Sep 25, 2019
62ca085
Update ui_setting_defaults.js
lukasolson Sep 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/management/advanced-options.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ Refresh the page to apply the changes.
=== Search settings

[horizontal]
`courier:batchSearches`:: When disabled, dashboard panels will load individually, and search requests will terminate when
users navigate away or update the query. When enabled, dashboard panels will load together when all of the data is loaded,
and searches will not terminate.
`courier:customRequestPreference`:: {ref}/search-request-body.html#request-body-search-preference[Request preference]
to use when `courier:setRequestPreference` is set to "custom".
`courier:ignoreFilterIfFieldNotInIndex`:: Skips filters that apply to fields that don't exist in the index for a visualization.
Expand Down
5 changes: 3 additions & 2 deletions src/legacy/core_plugins/kibana/ui_setting_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,8 +426,9 @@ export function getUiSettingDefaults() {
type: 'boolean',
description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', {
defaultMessage:
'Batch multiple concurrent searches in a single request. This may improve overall load' +
'times, but it also means that no single search request will be returned until the last has completed.',
`When disabled, dashboard panels will load individually, and search requests will terminate when users navigate
away or update the query. When enabled, dashboard panels will load together when all of the data is loaded, and
searches will not terminate.`,
}),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this description. When I looked at the UI, I noticed that the switch is on by default. So how about we describe the default behavior and then explain what happens when you disable:

Screen Shot 2019-09-25 at 12 52 08 PM

What do you think?

category: ['search'],
},
Expand Down