Docs: add -frontend.enabled-ruler-query-stats to docs #6530
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
SungJin1212
force-pushed
the
Improve-rule-evalutions-via-query-frontend
branch
3 times, most recently
from
34a9309 to
d30c10c
Compare
yeya24
reviewed
Jan 22, 2025
| @@ -29,6 +29,10 @@ In addition, you can configure gRPC client (Ruler -> Query Frontend) config, ple | |||
| You can configure the query response format via `-ruler.query-response-format`. It is used to retrieve query results from the Query Frontend. | |||
| The supported values are `protobuf` and `json`. We recommend using `protobuf`(default) because the retrieved query results containing native histograms are only supported on `protobuf`. | |||
|
|
|||
| ## Configure query stat log on the Query Frontend | |||
| You can enable the query stats log at the Query Frontend for queries coming from the Ruler via `-frontend.enabled-ruler-query-stats`. | |||
| It is disabled by default since the Ruler already leaves rule evaluation logs. | |||
There was a problem hiding this comment.
How does it work in Ruler evaluation log now. It used to work because Ruler embeds its own querier to evaluate rules so it gathers query stats and pass via context.
But now since evaluation is done at QFE does Ruler evaluation log still provide the same information as of before?
There was a problem hiding this comment.
oh.. I just checked it, and the query stats logs values are 0 like:
cortex_ruler_query_seconds_total=0.003627083 query_wall_time_seconds=0s query_storage_wall_time_seconds=0s fetched_series_count=0 fetched_chunks_count=0 fetched_samples_count=0 fetched_chunks_bytes=0 fetched_data_bytes=0
And the Ruler query stats metrics tracked by queryStats also 0:
cortex_ruler_fetched_series_total, cortex_ruler_samples_total, cortex_ruler_fetched_chunks_bytes_total ...
I think we should fix it.
There was a problem hiding this comment.
I added How to track query stat log and metric contents instead.
SungJin1212
force-pushed
the
Improve-rule-evalutions-via-query-frontend
branch
from
d30c10c to
4c16499
Compare
SungJin1212
force-pushed
the
Improve-rule-evalutions-via-query-frontend
branch
from
4c16499 to
d043ebf
Compare
Signed-off-by: SungJin1212 <[email protected]>
SungJin1212
force-pushed
the
Improve-rule-evalutions-via-query-frontend
branch
from
d043ebf to
58edf03
Compare
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.
This PR adds contents of #6504 to the Rule evaluations via query frontend guide docs (https://cortexmetrics.io/docs/guides/rule-evalutions-via-query-frontend).
Which issue(s) this PR fixes:
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]