fix query frontend per tenant metrics leak when cleaning up user labels by yeya24 · Pull Request #6698 · cortexproject/cortex · GitHub
Skip to content

fix query frontend per tenant metrics leak when cleaning up user labels #6698

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
yeya24 merged 2 commits into from
Apr 15, 2025
Merged

fix query frontend per tenant metrics leak when cleaning up user labels #6698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a20aed5
fix query frontend per tenant metrics leak when cleaning up user labels
yeya24 Apr 15, 2025
fe76d3d
changelog
yeya24 Apr 15, 2025
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
48 changes: 36 additions & 12 deletions pkg/frontend/transport/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,25 +167,49 @@ func NewHandler(cfg HandlerConfig, tenantFederationCfg tenantfederation.Config,
[]string{"reason", "source", "user"},
)

h.activeUsers = util.NewActiveUsersCleanupWithDefaultValues(func(user string) {
h.querySeconds.DeleteLabelValues(user)
h.queryFetchedSeries.DeleteLabelValues(user)
h.queryFetchedSamples.DeleteLabelValues(user)
h.queryScannedSamples.DeleteLabelValues(user)
h.queryPeakSamples.DeleteLabelValues(user)
h.queryChunkBytes.DeleteLabelValues(user)
h.queryDataBytes.DeleteLabelValues(user)
if err := util.DeleteMatchingLabels(h.rejectedQueries, map[string]string{"user": user}); err != nil {
level.Warn(log).Log("msg", "failed to remove cortex_rejected_queries_total metric for user", "user", user, "err", err)
}
})
h.activeUsers = util.NewActiveUsersCleanupWithDefaultValues(h.cleanupMetricsForInactiveUser)
// If cleaner stops or fail, we will simply not clean the metrics for inactive users.
_ = h.activeUsers.StartAsync(context.Background())
}

return h
}

func (h *Handler) cleanupMetricsForInactiveUser(user string) {
if !h.cfg.QueryStatsEnabled {
return
}

// Create a map with the user label to match
userLabel := map[string]string{"user": user}

// Clean up all metrics for the user
if err := util.DeleteMatchingLabels(h.querySeconds, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_seconds_total metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.queryFetchedSeries, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_fetched_series_total metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.queryFetchedSamples, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_samples_total metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.queryScannedSamples, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_samples_scanned_total metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.queryPeakSamples, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_peak_samples metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.queryChunkBytes, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_fetched_chunks_bytes_total metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.queryDataBytes, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_query_fetched_data_bytes_total metric for user", "user", user, "err", err)
}
if err := util.DeleteMatchingLabels(h.rejectedQueries, userLabel); err != nil {
level.Warn(h.log).Log("msg", "failed to remove cortex_rejected_queries_total metric for user", "user", user, "err", err)
}
}

func (f *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
var (
stats *querier_stats.QueryStats
Expand Down
106 changes: 106 additions & 0 deletions pkg/frontend/transport/handler_test.go
View file
Open in desktop