Add /api/v1/format_query API endpoint for formatting queries #11036
Conversation
This uses the formatting functionality introduced in #10544. I've chosen "query" instead of "expr" in both the endpoint and parameter names to stay consistent with the existing API endpoints. Otherwise, I would have preferred to use the term "expr". Signed-off-by: Julius Volz <julius.volz@gmail.com>
Signed-off-by: Julius Volz <julius.volz@gmail.com>
|
Are they removed? I would expect them to make the query "invalid" |
Signed-off-by: Julius Volz <julius.volz@gmail.com>
|
They are removed because the parser doesn't even remember comments or tell you that it encountered any. It just throws them away currently. So there'd also not be a way to mark such an expression invalid, but I also would not have expected that as a user. I added a comment that the comments are being removed. |
|
It could be cool to have the prettifier in the graph page too |
| @@ -206,6 +206,35 @@ $ curl 'http://localhost:9090/api/v1/query_range?query=up&start=2015-07-01T20:10 | |||
| } | |||
| ``` | |||
|
|
|||
| ## Formatting query expressions | |||
There was a problem hiding this comment.
Will it be nice to add that "prettified expressions will follow the specifications as mentioned here"?
There was a problem hiding this comment.
I would skip it for now because not all things in that spec is user digestible. For example max_characters_per_line. It is more of a developer reference. I am not sure if we need to have a user facing spec for this (for now. If we do in future, we need to improve it).
There was a problem hiding this comment.
(In a user facing doc, max_characters_per_line will be replaced with some actual number for example)
There was a problem hiding this comment.
Yep, agreed with @codesome here.
|
We tried to preserve comments in the first attempt, by totally bypassing the parser. But that turned out to be a way too complex and fragile of a code. So this is a step 1, a simpler implementation with the trade-off of comments to get the ground moving. |
We are doing it, right? 👀 |
Of course! That's the next step :) |
|
Will merge if nobody complains in a day or so :) |
|
Actually, will merge now so I can build on top of it better. |
This uses the formatting functionality introduced in
#10544.
I've chosen "query" instead of "expr" in both the endpoint and parameter
names to stay consistent with the existing API endpoints. Otherwise, I
would have preferred to use the term "expr".
Signed-off-by: Julius Volz julius.volz@gmail.com