Add metrics to range mapper #6030
Merged
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
ssncferreira
commented
Apr 26, 2022
Comment on lines
+30
to
+48
| DownstreamQueries: promauto.With(registerer).NewCounterVec(prometheus.CounterOpts{ | ||
| Namespace: "loki", | ||
| Name: "query_frontend_shards_total", | ||
| Help: "Number of downstream queries by expression type", | ||
| ConstLabels: prometheus.Labels{"mapper": mapper}, | ||
| }, []string{"type"}), | ||
| ParsedQueries: promauto.With(registerer).NewCounterVec(prometheus.CounterOpts{ | ||
| Namespace: "loki", | ||
| Name: "query_frontend_sharding_parsed_queries_total", | ||
| Help: "Number of parsed queries by evaluation type", | ||
| ConstLabels: prometheus.Labels{"mapper": mapper}, | ||
| }, []string{"type"}), | ||
| DownstreamFactor: promauto.With(registerer).NewHistogram(prometheus.HistogramOpts{ | ||
| Namespace: "loki", | ||
| Name: "query_frontend_shard_factor", | ||
| Help: "Number of downstream queries per request", | ||
| Buckets: prometheus.LinearBuckets(0, 16, 4), | ||
| ConstLabels: prometheus.Labels{"mapper": mapper}, | ||
| }), |
There was a problem hiding this comment.
Since these metric names are now shared amongst all mappers, the names should be updated to make them more general, i.e., replacing "shards" with "downstream". However, this would result in a breaking change. This is my preferred option, but don't know if there is a process for "deprecating" metric names as well as the real impact this might have on current users (e.g., dashboards would stop working, ...)
An alternative would be to remove this generalization by keeping the shard and the range mapper (and future mappers) metrics with their own exclusive names. Wdyt?
There was a problem hiding this comment.
We can create a PR or an issue for that and merge it during a 3.0.
This was referenced Jun 28, 2022
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.
What this PR does / why we need it:
Note: the metric names were not changed for backward compatibility (see comment for more detail).
For example, for the following configuration:
row_shards: 2split_queries_by_interval: 1mrunning the instant query
bytes_over_time({app="foo"}[5m])and taking into account that the split by range middleware is executed prior to the sharding middleware (i.e., the downstream queries outputted by the range middleware are inputted to the sharding middleware), the metrics would result in the following values:loki_query_frontend_shards_total{mapper="range",type="metrics"} 5- (counter) the query generates 5 downstream queriesloki_query_frontend_sharding_parsed_queries_total{mapper="range",type="success"} 1- (counter) the query is successfully parsedloki_query_frontend_shard_factor_sum{mapper="range"} 5- (histogram) the query request generates 5 downstream range queries which are passed downwards to the shard mapperloki_query_frontend_shards_total{mapper="shard",type="metrics"} 10- (counter) each of the 5 downstream queries generated by the split by range middleware generates 2 more downstream queries, one for each shardloki_query_frontend_sharding_parsed_queries_total{mapper="shard",type="success"} 5- (counter) all the 5 downstream queries generated by the split by range middleware are successfully parsedloki_query_frontend_shard_factor_sum{mapper="shard"} 10- (histogram) the query request generates 5 downstream shard queriesWhich issue(s) this PR fixes:
NA
Special notes for your reviewer:
Checklist
CHANGELOG.md.docs/sources/upgrading/_index.md