Indicate when errors represent timeouts #124936
Conversation
This commit adds a `timed_out` key to the error responses that represent a timeout condition. It also adds an `X-Timed-Out` header to the response indicating the same outside the response body.
rjernst
added
>enhancement
:Core/Infra/REST API
|
Hi @rjernst, I've created a changelog YAML for you. |
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
|
I'm not particularly happy with this approach, but I think it's relatively small and achieves the goal: getting a timed out indicator in the response body and headers. I would have liked to not use subclassing a method to indicate the type is an exception, instead using the ElasticsearchTimeoutException as a base for all timeouts, but that doesn't work with SearchTimeoutException. |
|
@elasticmachine update branch |
| "timed_out": true, | ||
| "header": { | ||
| "X-Timed-Out": "true" | ||
| } |
There was a problem hiding this comment.
If we always render headers, do we need a separate timed_out field?
There was a problem hiding this comment.
I was surprised to learn we have this header map. It's kind of odd we have it in the first place. Accessing it in this case would mean looking for error.header."X-Timed-Out" and then the weird ?1. IMO a json-specific field is nicer.
There was a problem hiding this comment.
Yep that's why I felt my two comments were mutually exclusive :)
| public ElasticsearchException(Throwable cause) { | ||
| super(cause); | ||
| if (isTimeout()) { | ||
| headers.put(TIMED_OUT_HEADER, List.of("true")); |
There was a problem hiding this comment.
RFC 8941 §4.1.9 specifies the string ?1 for a true boolean value in a HTTP header field.
💔 Backport failed
You can use sqren/backport to manually backport by running |
This commit adds a `timed_out` key to the error responses that represent a timeout condition. It also adds an `X-Timed-Out` header to the response indicating the same outside the response body.
This commit adds a `timed_out` key to the error responses that represent a timeout condition. It also adds an `X-Timed-Out` header to the response indicating the same outside the response body.
This commit adds a
timed_outkey to the error responses that represent a timeout condition. It also adds anX-Timed-Outheader to the response indicating the same outside the response body.