From 9882d5137c959554d001540e57ea11553b98a74f Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 18 Sep 2019 10:23:26 -0700 Subject: [PATCH 1/8] Add docs for courier:batchSearches UI setting --- docs/management/advanced-options.asciidoc | 4 ++++ src/legacy/core_plugins/kibana/ui_setting_defaults.js | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index a11be56791e38..56bc5a4831adf 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -185,6 +185,10 @@ Refresh the page to apply the changes. === Search settings [horizontal] +`courier:batchSearches`:: Determines whether to send multiple concurrent search requests (such as from a dashboard from +multiple panels) as a single `_msearch` request, or multiple `_search` requests. Note that cancellation of queries (for +example, when a user navigates away from the page before the search has returned) is only supported when using the +`_search` Elasticsearch endpoint. `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. diff --git a/src/legacy/core_plugins/kibana/ui_setting_defaults.js b/src/legacy/core_plugins/kibana/ui_setting_defaults.js index f7dd100bb5b70..a30686552bf6d 100644 --- a/src/legacy/core_plugins/kibana/ui_setting_defaults.js +++ b/src/legacy/core_plugins/kibana/ui_setting_defaults.js @@ -426,8 +426,10 @@ 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.', + `Determines whether to send multiple concurrent search requests (such as from a dashboard from multiple + panels) as a single _msearch request, or multiple _search requests. Note that cancellation of queries (for + example, when a user navigates away from the page before the search has returned) is only supported when + using the _search Elasticsearch endpoint.`, }), category: ['search'], }, From da2af813b21be68575f38bd18ebf82fe95d89692 Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 09:47:22 -0700 Subject: [PATCH 2/8] Update ui_setting_defaults.js --- src/legacy/core_plugins/kibana/ui_setting_defaults.js | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/legacy/core_plugins/kibana/ui_setting_defaults.js b/src/legacy/core_plugins/kibana/ui_setting_defaults.js index a30686552bf6d..6d05147186435 100644 --- a/src/legacy/core_plugins/kibana/ui_setting_defaults.js +++ b/src/legacy/core_plugins/kibana/ui_setting_defaults.js @@ -426,10 +426,9 @@ export function getUiSettingDefaults() { type: 'boolean', description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', { defaultMessage: - `Determines whether to send multiple concurrent search requests (such as from a dashboard from multiple - panels) as a single _msearch request, or multiple _search requests. Note that cancellation of queries (for - example, when a user navigates away from the page before the search has returned) is only supported when - using the _search Elasticsearch endpoint.`, + `When disabled, dashboard panels will load individually instead of altogether, and search requests will be terminated + when users navigate away or update the query. When disabled, dashboard panels will load altogether when all of the + data has been loaded.`, }), category: ['search'], }, From 28444a162f15d31ec5318948ec1c86942b5d85b8 Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 09:48:17 -0700 Subject: [PATCH 3/8] Update ui_setting_defaults.js --- src/legacy/core_plugins/kibana/ui_setting_defaults.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/legacy/core_plugins/kibana/ui_setting_defaults.js b/src/legacy/core_plugins/kibana/ui_setting_defaults.js index 6d05147186435..f4376c2bb65df 100644 --- a/src/legacy/core_plugins/kibana/ui_setting_defaults.js +++ b/src/legacy/core_plugins/kibana/ui_setting_defaults.js @@ -426,8 +426,8 @@ export function getUiSettingDefaults() { type: 'boolean', description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', { defaultMessage: - `When disabled, dashboard panels will load individually instead of altogether, and search requests will be terminated - when users navigate away or update the query. When disabled, dashboard panels will load altogether when all of the + `When disabled, dashboard panels will load individually, and search requests will be terminated when users + navigate away or update the query. When disabled, dashboard panels will load altogether when all of the data has been loaded.`, }), category: ['search'], From d3184b98149153e143843354894cad7e5a09363a Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 09:49:13 -0700 Subject: [PATCH 4/8] Update advanced-options.asciidoc --- docs/management/advanced-options.asciidoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 56bc5a4831adf..29249a498bf9c 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -185,10 +185,9 @@ Refresh the page to apply the changes. === Search settings [horizontal] -`courier:batchSearches`:: Determines whether to send multiple concurrent search requests (such as from a dashboard from -multiple panels) as a single `_msearch` request, or multiple `_search` requests. Note that cancellation of queries (for -example, when a user navigates away from the page before the search has returned) is only supported when using the -`_search` Elasticsearch endpoint. +`courier:batchSearches`:: When disabled, dashboard panels will load individually, and search requests will be +terminated when users navigate away or update the query. When disabled, dashboard panels will load altogether +when all of the data has been loaded. `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. From 179763982b82f5108bf1fd1e918d2ddd5ad7b04f Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 10:59:25 -0700 Subject: [PATCH 5/8] Update advanced-options.asciidoc --- docs/management/advanced-options.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 29249a498bf9c..5f5757d63188f 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -186,7 +186,7 @@ Refresh the page to apply the changes. [horizontal] `courier:batchSearches`:: When disabled, dashboard panels will load individually, and search requests will be -terminated when users navigate away or update the query. When disabled, dashboard panels will load altogether +terminated when users navigate away or update the query. When enabled, dashboard panels will load altogether when all of the data has been loaded. `courier:customRequestPreference`:: {ref}/search-request-body.html#request-body-search-preference[Request preference] to use when `courier:setRequestPreference` is set to "custom". From bfa991f06727a5b26e272f50085d66b91f28a08a Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 10:59:43 -0700 Subject: [PATCH 6/8] Update ui_setting_defaults.js --- src/legacy/core_plugins/kibana/ui_setting_defaults.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/legacy/core_plugins/kibana/ui_setting_defaults.js b/src/legacy/core_plugins/kibana/ui_setting_defaults.js index f4376c2bb65df..7121c50714a5a 100644 --- a/src/legacy/core_plugins/kibana/ui_setting_defaults.js +++ b/src/legacy/core_plugins/kibana/ui_setting_defaults.js @@ -427,7 +427,7 @@ export function getUiSettingDefaults() { description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', { defaultMessage: `When disabled, dashboard panels will load individually, and search requests will be terminated when users - navigate away or update the query. When disabled, dashboard panels will load altogether when all of the + navigate away or update the query. When enabled, dashboard panels will load altogether when all of the data has been loaded.`, }), category: ['search'], From 116b4a8a949657e71022523ebfd74ad73027bc0e Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 15:21:12 -0700 Subject: [PATCH 7/8] Update advanced-options.asciidoc --- docs/management/advanced-options.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 5f5757d63188f..2e9118fef46fa 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -185,9 +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 be -terminated when users navigate away or update the query. When enabled, dashboard panels will load altogether -when all of the data has been loaded. +`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. From 62ca085e1a7635cbc30789b3659e4665119a8b4b Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Wed, 25 Sep 2019 15:22:22 -0700 Subject: [PATCH 8/8] Update ui_setting_defaults.js --- src/legacy/core_plugins/kibana/ui_setting_defaults.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/legacy/core_plugins/kibana/ui_setting_defaults.js b/src/legacy/core_plugins/kibana/ui_setting_defaults.js index 7121c50714a5a..8592242e7ff20 100644 --- a/src/legacy/core_plugins/kibana/ui_setting_defaults.js +++ b/src/legacy/core_plugins/kibana/ui_setting_defaults.js @@ -426,9 +426,9 @@ export function getUiSettingDefaults() { type: 'boolean', description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', { defaultMessage: - `When disabled, dashboard panels will load individually, and search requests will be terminated when users - navigate away or update the query. When enabled, dashboard panels will load altogether when all of the - data has been loaded.`, + `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.`, }), category: ['search'], },