Search - add “partial_results” summary flag to SearchResponse #47847
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
markharwood
added
the
:Search/Search
|
Pinging @elastic/es-search (:Search/Search) |
markharwood
force-pushed
the
fix/47700
branch
from
166433d
to
e7fb688
Compare
|
Stale and no take-up |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have a multitude of flags and conditions that indicate partial failure in our search responses.
These make it hard for clients to answer the most basic question:
To aid with that, this PR proposes a simple new "partial_results" boolean in the response which summarises all the reasons for incomplete data (timed out, unavailable shards, cancellations, failures). Client applications should pay close attention to this summary flag and warn users if it is set to true.
Of course, setting the existing
allow_partial_search_resultsflag to false is a way to avoid returning any incomplete data in the first place but this is currently not the default setting and clients need a simple way to understand if they are missing any data.Relates to #47700