Skip to content

Add a format query label value to queries total metric #6925

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
merged 1 commit into from
Jul 29, 2025
Merged

Add a format query label value to queries total metric #6925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
* [ENHANCEMENT] Ring: Add zone label to ring_members metric. #6900
* [ENHANCEMENT] Ingester: Add new metric `cortex_ingester_push_errors_total` to track reasons for ingester request failures. #6901
* [ENHANCEMENT] Parquet Storage: Allow Parquet Queryable to disable fallback to Store Gateway. #6920
* [ENHANCEMENT] Query Frontend: Add a `format_query` label value to the `op` label at `cortex_query_frontend_queries_total` metric. #6925
* [BUGFIX] Ingester: Avoid error or early throttling when READONLY ingesters are present in the ring #6517
* [BUGFIX] Ingester: Fix labelset data race condition. #6573
* [BUGFIX] Compactor: Cleaner should not put deletion marker for blocks with no-compact marker. #6576
Expand Down
4 changes: 4 additions & 0 deletions pkg/querier/tripperware/roundtrip.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ const (
opTypeLabelValues = "label_values"
opTypeMetadata = "metadata"
opTypeQueryExemplars = "query_exemplars"
opTypeFormatQuery = "format_query"
)

// HandlerFunc is like http.HandlerFunc, but for Handler.
Expand Down Expand Up @@ -152,6 +153,7 @@ func NewQueryTripperware(
isLabelValues := strings.HasSuffix(r.URL.Path, "/values")
isMetadata := strings.HasSuffix(r.URL.Path, "/metadata")
isQueryExemplars := strings.HasSuffix(r.URL.Path, "/query_exemplars")
isFormatQuery := strings.HasSuffix(r.URL.Path, "/format_query")

op := opTypeQuery
switch {
Expand All @@ -169,6 +171,8 @@ func NewQueryTripperware(
op = opTypeMetadata
case isQueryExemplars:
op = opTypeQueryExemplars
case isFormatQuery:
op = opTypeFormatQuery
}

tenantIDs, err := tenant.TenantIDs(r.Context())
Expand Down
13 changes: 13 additions & 0 deletions pkg/querier/tripperware/roundtrip_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ const (
labelNamesQuery = "/api/v1/labels"
labelValuesQuery = "/api/v1/label/label/values"
metadataQuery = "/api/v1/metadata"
formatQuery = "/api/v1/format_query?query=foo/bar"

responseBody = `{"status":"success","data":{"resultType":"matrix","result":[{"metric":{"foo":"bar"},"values":[[1536673680,"137"],[1536673780,"137"]]}]}}`
instantResponseBody = `{"status":"success","data":{"resultType":"vector","result":[{"metric":{"foo":"bar"},"values":[[1536673680,"137"],[1536673780,"137"]]}]}}`
Expand Down Expand Up @@ -229,6 +230,18 @@ cortex_query_frontend_queries_total{op="remote_read", source="api", user="1"} 1
# HELP cortex_query_frontend_queries_total Total queries sent per tenant.
# TYPE cortex_query_frontend_queries_total counter
cortex_query_frontend_queries_total{op="query_range", source="api", user="1"} 1
`,
},
{
path: formatQuery,
expectedBody: "bar",
limits: defaultOverrides,
maxSubQuerySteps: 11000,
userAgent: "dummyUserAgent/1.2",
expectedMetric: `
# HELP cortex_query_frontend_queries_total Total queries sent per tenant.
# TYPE cortex_query_frontend_queries_total counter
cortex_query_frontend_queries_total{op="format_query", source="api", user="1"} 1
`,
},
{
Expand Down
Loading