Skip to content

Add missing docs for timeout exceptions #10554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
a2l007 merged 2 commits into from
Nov 13, 2020
Merged

Add missing docs for timeout exceptions #10554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
545da5a
Add missing docs for timeout exceptions
a2l007 Nov 3, 2020
db3b0a4
Add info on auth failures
a2l007 Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/querying/querying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ curl -X DELETE "http://host:port/druid/v2/abc123"

## Query errors

If a query fails, you will get an HTTP 500 response containing a JSON object with the following structure:
If a query fails, Druid returns a response with an HTTP response code and a JSON object with the following structure:

```json
{
Expand All @@ -117,9 +117,14 @@ If a query fails, you will get an HTTP 500 response containing a JSON object wit
"host" : "druid1.example.com:8083"
}
```
The HTTP response code returned depends on the type of query failure. For timed out queries, an HTTP 504 response code is returned.

For [secured](../design/auth.md) Druid clusters, query requests respond with an HTTP 401 response code in case of an authentication failure. For authorization failures, an HTTP 403 response code is returned.

If a query request fails due to being limited by the [query scheduler laning configuration](../configuration/index.md#broker), an HTTP 429 response with the same JSON object schema as an error response, but with `errorMessage` of the form: "Total query capacity exceeded" or "Query capacity exceeded for lane 'low'".

For every other type of query failures, an HTTP 500 response code is returned.
Copy link
Copy Markdown
Contributor

@jihoonson jihoonson Nov 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other missing response codes here are 401 and 403 which can be returned for auth failures. Would you please add them as well?

Copy link
Copy Markdown
Contributor Author

@a2l007 a2l007 Nov 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Added


The fields in the response are:

|field|description|
Expand Down