/
step_align.go
86 lines (71 loc) · 2.64 KB
/
step_align.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
// SPDX-License-Identifier: AGPL-3.0-only
// Provenance-includes-location: https://github.com/cortexproject/cortex/blob/master/pkg/querier/queryrange/step_align.go
// Provenance-includes-license: Apache-2.0
// Provenance-includes-copyright: The Cortex Authors.
package querymiddleware
import (
"context"
"github.com/go-kit/log"
"github.com/grafana/dskit/tenant"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/grafana/mimir/pkg/util/spanlogger"
"github.com/grafana/mimir/pkg/util/validation"
)
type stepAlignMiddleware struct {
next MetricsQueryHandler
limits Limits
logger log.Logger
aligned *prometheus.CounterVec
}
// newStepAlignMiddleware creates a middleware that aligns the start and end of request to the step to
// improve the cacheability of the query results based on per-tenant configuration.
func newStepAlignMiddleware(limits Limits, logger log.Logger, registerer prometheus.Registerer) MetricsQueryMiddleware {
aligned := promauto.With(registerer).NewCounterVec(prometheus.CounterOpts{
Name: "cortex_query_frontend_queries_step_aligned_total",
Help: "Number of queries whose start or end times have been adjusted to be step-aligned.",
}, []string{"user"})
return MetricsQueryMiddlewareFunc(func(next MetricsQueryHandler) MetricsQueryHandler {
return &stepAlignMiddleware{
next: next,
limits: limits,
logger: logger,
aligned: aligned,
}
})
}
func (s *stepAlignMiddleware) Do(ctx context.Context, r MetricsQueryRequest) (Response, error) {
tenants, err := tenant.TenantIDs(ctx)
if err != nil {
return s.next.Do(ctx, r)
}
if validation.AllTrueBooleansPerTenant(tenants, s.limits.AlignQueriesWithStep) {
start := (r.GetStart() / r.GetStep()) * r.GetStep()
end := (r.GetEnd() / r.GetStep()) * r.GetStep()
if start != r.GetStart() || end != r.GetEnd() {
for _, id := range tenants {
s.aligned.WithLabelValues(id).Inc()
}
spanlog := spanlogger.FromContext(ctx, s.logger)
spanlog.DebugLog(
"msg", "query start or end has been adjusted to be step-aligned",
spanlogger.TenantIDsTagName, tenants,
"original_start", r.GetStart(),
"original_end", r.GetEnd(),
"adjusted_start", start,
"adjusted_end", end,
"step", r.GetStep(),
)
return s.next.Do(ctx, r.WithStartEnd(start, end))
}
}
return s.next.Do(ctx, r)
}
// isRequestStepAligned returns whether the MetricsQueryRequest start and end timestamps are aligned
// with the step.
func isRequestStepAligned(req MetricsQueryRequest) bool {
if req.GetStep() == 0 {
return true
}
return req.GetEnd()%req.GetStep() == 0 && req.GetStart()%req.GetStep() == 0
}