// Copyright 2013 The Prometheus Authors // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package stats import ( "context" "encoding/json" "fmt" "github.com/prometheus/client_golang/prometheus" "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/trace" ) // QueryTiming identifies the code area or functionality in which time is spent // during a query. type QueryTiming int // Query timings. const ( EvalTotalTime QueryTiming = iota ResultSortTime QueryPreparationTime InnerEvalTime ExecQueueTime ExecTotalTime ) // Return a string representation of a QueryTiming identifier. func (s QueryTiming) String() string { switch s { case EvalTotalTime: return "Eval total time" case ResultSortTime: return "Result sorting time" case QueryPreparationTime: return "Query preparation time" case InnerEvalTime: return "Inner eval time" case ExecQueueTime: return "Exec queue wait time" case ExecTotalTime: return "Exec total time" default: return "Unknown query timing" } } // SpanOperation returns a string representation of a QueryTiming span operation. func (s QueryTiming) SpanOperation() string { switch s { case EvalTotalTime: return "promqlEval" case ResultSortTime: return "promqlSort" case QueryPreparationTime: return "promqlPrepare" case InnerEvalTime: return "promqlInnerEval" case ExecQueueTime: return "promqlExecQueue" case ExecTotalTime: return "promqlExec" default: return "Unknown query timing" } } // stepStat represents a single statistic for a given step timestamp. type stepStat struct { T int64 V int64 } func (s stepStat) String() string { return fmt.Sprintf("%v @[%v]", s.V, s.T) } // MarshalJSON implements json.Marshaler. func (s stepStat) MarshalJSON() ([]byte, error) { return json.Marshal([...]interface{}{float64(s.T) / 1000, s.V}) } // queryTimings with all query timers mapped to durations. type queryTimings struct { EvalTotalTime float64 `json:"evalTotalTime"` ResultSortTime float64 `json:"resultSortTime"` QueryPreparationTime float64 `json:"queryPreparationTime"` InnerEvalTime float64 `json:"innerEvalTime"` ExecQueueTime float64 `json:"execQueueTime"` ExecTotalTime float64 `json:"execTotalTime"` } type querySamples struct { TotalQueryableSamplesPerStep []stepStat `json:"totalQueryableSamplesPerStep,omitempty"` TotalQueryableSamples int64 `json:"totalQueryableSamples"` PeakSamples int `json:"peakSamples"` } // BuiltinStats holds the statistics that Prometheus's core gathers. type BuiltinStats struct { Timings queryTimings `json:"timings,omitempty"` Samples *querySamples `json:"samples,omitempty"` } // QueryStats holds BuiltinStats and any other stats the particular // implementation wants to collect. type QueryStats interface { Builtin() BuiltinStats } func (s *BuiltinStats) Builtin() BuiltinStats { return *s } // NewQueryStats makes a QueryStats struct with all QueryTimings found in the // given TimerGroup. func NewQueryStats(s *Statistics) QueryStats { var ( qt queryTimings samples *querySamples tg = s.Timers sp = s.Samples ) for s, timer := range tg.TimerGroup.timers { switch s { case EvalTotalTime: qt.EvalTotalTime = timer.Duration() case ResultSortTime: qt.ResultSortTime = timer.Duration() case QueryPreparationTime: qt.QueryPreparationTime = timer.Duration() case InnerEvalTime: qt.InnerEvalTime = timer.Duration() case ExecQueueTime: qt.ExecQueueTime = timer.Duration() case ExecTotalTime: qt.ExecTotalTime = timer.Duration() } } if sp != nil { samples = &querySamples{ TotalQueryableSamples: sp.TotalSamples, PeakSamples: sp.PeakSamples, } samples.TotalQueryableSamplesPerStep = sp.totalSamplesPerStepPoints() } qs := BuiltinStats{Timings: qt, Samples: samples} return &qs } func (qs *QuerySamples) TotalSamplesPerStepMap() *TotalSamplesPerStep { if !qs.EnablePerStepStats { return nil } ts := TotalSamplesPerStep{} for _, s := range qs.totalSamplesPerStepPoints() { ts[s.T] = int(s.V) } return &ts } func (qs *QuerySamples) totalSamplesPerStepPoints() []stepStat { if !qs.EnablePerStepStats { return nil } ts := make([]stepStat, len(qs.TotalSamplesPerStep)) for i, c := range qs.TotalSamplesPerStep { ts[i] = stepStat{T: qs.startTimestamp + int64(i)*qs.interval, V: c} } return ts } // SpanTimer unifies tracing and timing, to reduce repetition. type SpanTimer struct { timer *Timer observers []prometheus.Observer span trace.Span } func NewSpanTimer(ctx context.Context, operation string, timer *Timer, observers ...prometheus.Observer) (*SpanTimer, context.Context) { ctx, span := otel.Tracer("").Start(ctx, operation) timer.Start() return &SpanTimer{ timer: timer, observers: observers, span: span, }, ctx } func (s *SpanTimer) Finish() { s.timer.Stop() s.span.End() for _, obs := range s.observers { obs.Observe(s.timer.ElapsedTime().Seconds()) } } type Statistics struct { Timers *QueryTimers Samples *QuerySamples } type QueryTimers struct { *TimerGroup } type TotalSamplesPerStep map[int64]int type QuerySamples struct { // PeakSamples represent the highest count of samples considered // while evaluating a query. It corresponds to the peak value of // currentSamples, which is in turn compared against the MaxSamples // configured in the engine. PeakSamples int // TotalSamples represents the total number of samples scanned // while evaluating a query. TotalSamples int64 // TotalSamplesPerStep represents the total number of samples scanned // per step while evaluating a query. Each step should be identical to the // TotalSamples when a step is run as an instant query, which means // we intentionally do not account for optimizations that happen inside the // range query engine that reduce the actual work that happens. TotalSamplesPerStep []int64 EnablePerStepStats bool startTimestamp int64 interval int64 } type Stats struct { TimerStats *QueryTimers SampleStats *QuerySamples } func (qs *QuerySamples) InitStepTracking(start, end, interval int64) { if !qs.EnablePerStepStats { return } numSteps := int((end-start)/interval) + 1 qs.TotalSamplesPerStep = make([]int64, numSteps) qs.startTimestamp = start qs.interval = interval } // IncrementSamplesAtStep increments the total samples count. Use this if you know the step index. func (qs *QuerySamples) IncrementSamplesAtStep(i int, samples int64) { if qs == nil { return } qs.TotalSamples += samples if qs.TotalSamplesPerStep != nil { qs.TotalSamplesPerStep[i] += samples } } // IncrementSamplesAtTimestamp increments the total samples count. Use this if you only have the corresponding step // timestamp. func (qs *QuerySamples) IncrementSamplesAtTimestamp(t, samples int64) { if qs == nil { return } qs.TotalSamples += samples if qs.TotalSamplesPerStep != nil { i := int((t - qs.startTimestamp) / qs.interval) qs.TotalSamplesPerStep[i] += samples } } // UpdatePeak updates the peak number of samples considered in // the evaluation of a query as used with the MaxSamples limit. func (qs *QuerySamples) UpdatePeak(samples int) { if qs == nil { return } if samples > qs.PeakSamples { qs.PeakSamples = samples } } // UpdatePeakFromSubquery updates the peak number of samples considered // in a query from its evaluation of a subquery. func (qs *QuerySamples) UpdatePeakFromSubquery(other *QuerySamples) { if qs == nil || other == nil { return } if other.PeakSamples > qs.PeakSamples { qs.PeakSamples = other.PeakSamples } } func NewQueryTimers() *QueryTimers { return &QueryTimers{NewTimerGroup()} } func NewQuerySamples(enablePerStepStats bool) *QuerySamples { qs := QuerySamples{EnablePerStepStats: enablePerStepStats} return &qs } func (qs *QuerySamples) NewChild() *QuerySamples { return NewQuerySamples(false) } func (qs *QueryTimers) GetSpanTimer(ctx context.Context, qt QueryTiming, observers ...prometheus.Observer) (*SpanTimer, context.Context) { return NewSpanTimer(ctx, qt.SpanOperation(), qs.TimerGroup.GetTimer(qt), observers...) }