Add completion_time time field to async_search get and status response #97700
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
quux00
added
>enhancement
:Search/Search
|
Pinging @elastic/es-search (Team:Search) |
|
Hi @quux00, I've created a changelog YAML for you. |
quux00
changed the title
quux00
force-pushed
the
async-search/completion-time
branch
from
695b8a2 to
2720025
Compare
quux00
changed the title
|
Hi @quux00, I've created a changelog YAML for you. |
The completion_time is set as the start_time (already present) plus the 'took' time that is set in the SearchResponse object and only if the isRunning status == false since took is set even for in-progress searches. We use the 'took' field because it is based on relative time, not absolute wall clock time which can go backwards due to NPT issues. See the comments in TransportSearchAction about the SearchTimeProvider for details. Closes elastic#88640
…ion_time_in_millis entry. Fixed docs tests to handle the new completion_time_in_millis in the response.
This required incrementing the TransportVersion as unlike the AsyncResponse, the status response does not have access to the searchResponse, which has the took value that is used to compute the completion time in the AsyncResponse.
quux00
force-pushed
the
async-search/completion-time
branch
from
be81322 to
1cbade0
Compare
|
Hi @quux00, I've created a changelog YAML for you. |
|
Hi @quux00, I've updated the changelog YAML for you. |
javanna
approved these changes
Jul 17, 2023
mayya-sharipova
approved these changes
Jul 17, 2023
quux00
added a commit
to elastic/elasticsearch-specification
that referenced
this pull request
Aug 29, 2023
Updates the spec for the response objects for `POST _async_search`, `GET _async_search/:id`, `GET _async_search/status/:id` and `GET _search` Two high level changes have happened in 8.10: 1) `completion_time` and `completion_time_in_millis` (async_search only) elastic/elasticsearch#97700 2) Adding `details` metadata to the `_clusters` section of both async and synchronous search responses elastic/elasticsearch#97731
quux00
added a commit
to elastic/elasticsearch-specification
that referenced
this pull request
Aug 31, 2023
Updates the spec for the response objects for `POST _async_search`, `GET _async_search/:id`, `GET _async_search/status/:id` and `GET _search` Two high level changes have happened in 8.10: 1) `completion_time` and `completion_time_in_millis` (async_search only) elastic/elasticsearch#97700 2) Adding `details` metadata to the `_clusters` section of both async and synchronous search responses elastic/elasticsearch#97731
swallez
pushed a commit
to elastic/elasticsearch-specification
that referenced
this pull request
Sep 1, 2023
Updates the spec for the response objects for `POST _async_search`, `GET _async_search/:id`, `GET _async_search/status/:id` and `GET _search` Two high level changes have happened in 8.10: 1) `completion_time` and `completion_time_in_millis` (async_search only) elastic/elasticsearch#97700 2) Adding `details` metadata to the `_clusters` section of both async and synchronous search responses elastic/elasticsearch#97731
swallez
pushed a commit
to elastic/elasticsearch-specification
that referenced
this pull request
Sep 1, 2023
Updates the spec for the response objects for `POST _async_search`, `GET _async_search/:id`, `GET _async_search/status/:id` and `GET _search` Two high level changes have happened in 8.10: 1) `completion_time` and `completion_time_in_millis` (async_search only) elastic/elasticsearch#97700 2) Adding `details` metadata to the `_clusters` section of both async and synchronous search responses elastic/elasticsearch#97731
swallez
added a commit
to elastic/elasticsearch-specification
that referenced
this pull request
Sep 5, 2023
Updates the spec for the response objects for `POST _async_search`, `GET _async_search/:id`, `GET _async_search/status/:id` and `GET _search` Two high level changes have happened in 8.10: 1) `completion_time` and `completion_time_in_millis` (async_search only) elastic/elasticsearch#97700 2) Adding `details` metadata to the `_clusters` section of both async and synchronous search responses elastic/elasticsearch#97731 Co-authored-by: Michael Peterson <[email protected]>
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.
Both the async_search response and status response objects now include a "completion_time_in_millis"
entry in the XContent output if the search has completed successfully.
The completion_time is set as the start_time (already present) plus the 'took' time that is set in the
SearchResponse object and only if the isRunning status == false since took is set even for in-progress searches.
We use the 'took' field because it is based on relative time, not absolute wall clock time which can go
backwards due to NTP issues. See the comments in TransportSearchAction about the SearchTimeProvider
for details.
Closes #88640