elasticsearch/docs/reference/search
Michael Peterson a451511e3a
Change skip_unavailable default value to true (#105792)
In order to improve the experience of cross-cluster search, we are changing
the default value of the remote cluster `skip_unavailable` setting from `false` to `true`.

This setting causes any cross-cluster _search (or _async_search) to entirely fail when
any remote cluster with `skip_unavailable=false` is either unavailable (connection to it fails)
or if the search on it fails on all shards.

Setting `skip_unavailable=true` allows partial results from other clusters to be
returned. In that case, the search response cluster metadata will show a `skipped`
status, so the user can see that no data came in from that cluster. Kibana also
now leverages this metadata in the cross-cluster search responses to allow users
to see how many clusters returned data and drill down into which clusters did not
(including failure messages).

Currently, the user/admin has to specifically set the value to `true` in the configs, like so:

```
cluster:
    remote:
        remote1:
            seeds: 10.10.10.10:9300
            skip_unavailable: true
```

even though that is probably what search admins want in the vast majority of cases.

Setting `skip_unavailable=false` should be a conscious (and probably rare) choice
by an Elasticsearch admin that a particular cluster's results are so essential to a
search (or visualization in dashboard or Discover panel) that no results at all should
be shown if it cannot return any results.
2024-04-29 15:53:47 -04:00
..
search-your-data Change skip_unavailable default value to true (#105792) 2024-04-29 15:53:47 -04:00
suggesters Update term-suggest.asciidoc (#86780) 2023-05-09 12:23:45 +02:00
async-search.asciidoc [Doc] Privileges required to retrieve the status of async searches 2024-04-02 09:35:02 +03:00
clear-scroll-api.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
count.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
explain.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
field-caps.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
knn-search.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
multi-search-template-api.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
multi-search.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
point-in-time-api.asciidoc Add support for index_filter to open pit (#102388) 2023-11-21 15:35:49 +01:00
profile.asciidoc Adding aggregations support for the _ignored field (#101373) 2024-04-29 16:41:34 +02:00
rank-eval.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
render-search-template-api.asciidoc [DOCS] Overhaul search template docs (#72583) 2021-06-30 16:03:49 -04:00
retriever.asciidoc Fix for from parameter when using sub_searches and rank (#106253) 2024-04-25 20:11:44 +03:00
rrf.asciidoc Fix for from parameter when using sub_searches and rank (#106253) 2024-04-25 20:11:44 +03:00
scroll-api.asciidoc [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
search-shards.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
search-template-api.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
search-vector-tile-api.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
search.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
suggesters.asciidoc Remove 'under development' note in suggester docs (#84366) 2022-02-24 13:27:03 -08:00
terms-enum.asciidoc Limit _terms_enum prefix size (#97488) 2023-07-10 12:21:07 +02:00
validate.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00