From 9b521e421901fd1f497b789622043b032d9c4a00 Mon Sep 17 00:00:00 2001 From: Stanislav Malyshev Date: Mon, 28 Apr 2025 10:18:46 -0600 Subject: [PATCH 1/2] Update skip_unavailable docs for ESQL --- .../query-filter/languages/esql-cross-clusters.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/explore-analyze/query-filter/languages/esql-cross-clusters.md b/explore-analyze/query-filter/languages/esql-cross-clusters.md index 1dc6f83304..7192df51d0 100644 --- a/explore-analyze/query-filter/languages/esql-cross-clusters.md +++ b/explore-analyze/query-filter/languages/esql-cross-clusters.md @@ -169,7 +169,7 @@ PUT _cluster/settings } ``` -1. Since `skip_unavailable` was not set on `cluster_three`, it uses the default of `false`. See the [Optional remote clusters](#ccq-skip-unavailable-clusters) section for details. +1. Since `skip_unavailable` was not set on `cluster_three`, it uses the default of `true`. See the [Optional remote clusters](#ccq-skip-unavailable-clusters) section for details. @@ -284,7 +284,7 @@ Which returns: ``` 1. How long the entire search (across all clusters) took, in milliseconds. -2. This section of counters shows all possible cluster search states and how many cluster searches are currently in that state. The clusters can have one of the following statuses: **running**, **successful** (searches on all shards were successful), **skipped** (the search failed on a cluster marked with `skip_unavailable`=`true`), **failed** (the search failed on a cluster marked with `skip_unavailable`=`false`) or **partial** (the search was [interrupted](https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html) before finishing). +2. This section of counters shows all possible cluster search states and how many cluster searches are currently in that state. The clusters can have one of the following statuses: **running**, **successful** (searches on all shards were successful), **skipped** (the search failed on a cluster marked with `skip_unavailable`=`true`), **failed** (the search failed on a cluster marked with `skip_unavailable`=`false`) or **partial** (the search was [interrupted](https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html) before finishing or has partially failed). 3. The `_clusters/details` section shows metadata about the search on each cluster. 4. If you included indices from the local cluster you sent the request to in your {{ccs}}, it is identified as "(local)". 5. How long (in milliseconds) the search took on each cluster. This can be useful to determine which clusters have slower response times than others. @@ -469,10 +469,9 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001 ## Optional remote clusters [ccq-skip-unavailable-clusters] -{{ccs-cap}} for {{esql}} currently does not respect the `skip_unavailable` setting. As a result, if a remote cluster specified in the request is unavailable or failed, {{ccs}} for {{esql}} queries will fail regardless of the setting. - -We are actively working to align the behavior of {{ccs}} for {{esql}} with other {{ccs}} APIs. - +{ccs-cap} for {esql} will set the remote cluster which is disconnected from the querying cluster to `skipped` +and continue the query with other clusters, unless the cluster's `skip_unavailable` setting is set to `false`, +in which case the query will fail. ## Query across clusters during an upgrade [ccq-during-upgrade] From 583dd88b69de7986f7af830fe566a074cf8f4a1e Mon Sep 17 00:00:00 2001 From: Stanislav Malyshev Date: Mon, 28 Apr 2025 11:18:54 -0600 Subject: [PATCH 2/2] Reformulate --- explore-analyze/query-filter/languages/esql-cross-clusters.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/explore-analyze/query-filter/languages/esql-cross-clusters.md b/explore-analyze/query-filter/languages/esql-cross-clusters.md index 7192df51d0..88c6e5e379 100644 --- a/explore-analyze/query-filter/languages/esql-cross-clusters.md +++ b/explore-analyze/query-filter/languages/esql-cross-clusters.md @@ -469,8 +469,8 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001 ## Optional remote clusters [ccq-skip-unavailable-clusters] -{ccs-cap} for {esql} will set the remote cluster which is disconnected from the querying cluster to `skipped` -and continue the query with other clusters, unless the cluster's `skip_unavailable` setting is set to `false`, +If a remote cluster disconnects from the querying cluster, {ccs-cap} for {esql} will set it to `skipped` +and continue the query with other clusters, unless the remote cluster's `skip_unavailable` setting is set to `false`, in which case the query will fail. ## Query across clusters during an upgrade [ccq-during-upgrade]