-
Notifications
You must be signed in to change notification settings - Fork 795
/
instant_query.go
630 lines (554 loc) · 16.3 KB
/
instant_query.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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
package instantquery
import (
"bytes"
"context"
"fmt"
"io"
"net/http"
"net/url"
"sort"
"strings"
"time"
jsoniter "github.com/json-iterator/go"
"github.com/opentracing/opentracing-go"
otlog "github.com/opentracing/opentracing-go/log"
"github.com/prometheus/common/model"
"github.com/prometheus/prometheus/model/labels"
"github.com/prometheus/prometheus/model/timestamp"
promqlparser "github.com/prometheus/prometheus/promql/parser"
"github.com/weaveworks/common/httpgrpc"
"google.golang.org/grpc/status"
"github.com/cortexproject/cortex/pkg/cortexpb"
"github.com/cortexproject/cortex/pkg/querier/tripperware"
"github.com/cortexproject/cortex/pkg/querier/tripperware/queryrange"
"github.com/cortexproject/cortex/pkg/util"
"github.com/cortexproject/cortex/pkg/util/spanlogger"
)
var (
InstantQueryCodec tripperware.Codec = newInstantQueryCodec()
json = jsoniter.Config{
EscapeHTML: false, // No HTML in our responses.
SortMapKeys: true,
ValidateJsonRawMessage: false,
}.Froze()
)
type PrometheusRequest struct {
tripperware.Request
Time int64
Stats string
Query string
Path string
Headers http.Header
}
// GetTime returns time in milliseconds.
func (r *PrometheusRequest) GetTime() int64 {
return r.Time
}
// GetStart returns always 0 for instant query.
func (r *PrometheusRequest) GetStart() int64 {
return 0
}
// GetEnd returns always 0 for instant query.
func (r *PrometheusRequest) GetEnd() int64 {
return 0
}
// GetStep returns always 0 for instant query.
func (r *PrometheusRequest) GetStep() int64 {
return 0
}
// GetQuery returns the query of the request.
func (r *PrometheusRequest) GetQuery() string {
return r.Query
}
// WithStartEnd clone the current request with different start and end timestamp.
func (r *PrometheusRequest) WithStartEnd(int64, int64) tripperware.Request {
return r
}
// WithQuery clone the current request with a different query.
func (r *PrometheusRequest) WithQuery(query string) tripperware.Request {
q := *r
q.Query = query
return &q
}
// LogToSpan writes information about this request to an OpenTracing span
func (r *PrometheusRequest) LogToSpan(sp opentracing.Span) {
sp.LogFields(
otlog.String("query", r.GetQuery()),
otlog.String("time", timestamp.Time(r.GetTime()).String()),
)
}
// GetStats returns the stats of the request.
func (r *PrometheusRequest) GetStats() string {
return r.Stats
}
// WithStats clones the current `PrometheusRequest` with a new stats.
func (r *PrometheusRequest) WithStats(stats string) tripperware.Request {
q := *r
q.Stats = stats
return &q
}
type instantQueryCodec struct {
tripperware.Codec
now func() time.Time
}
func newInstantQueryCodec() instantQueryCodec {
return instantQueryCodec{now: time.Now}
}
func (resp *PrometheusInstantQueryResponse) HTTPHeaders() map[string][]string {
if resp != nil && resp.GetHeaders() != nil {
r := map[string][]string{}
for _, header := range resp.GetHeaders() {
if header != nil {
r[header.Name] = header.Values
}
}
return r
}
return nil
}
func (c instantQueryCodec) DecodeRequest(_ context.Context, r *http.Request, forwardHeaders []string) (tripperware.Request, error) {
result := PrometheusRequest{Headers: map[string][]string{}}
var err error
result.Time, err = util.ParseTimeParam(r, "time", c.now().Unix())
if err != nil {
return nil, decorateWithParamName(err, "time")
}
result.Query = r.FormValue("query")
result.Stats = r.FormValue("stats")
result.Path = r.URL.Path
// Include the specified headers from http request in prometheusRequest.
for _, header := range forwardHeaders {
for h, hv := range r.Header {
if strings.EqualFold(h, header) {
result.Headers[h] = hv
break
}
}
}
return &result, nil
}
func (instantQueryCodec) DecodeResponse(ctx context.Context, r *http.Response, _ tripperware.Request) (tripperware.Response, error) {
log, ctx := spanlogger.New(ctx, "PrometheusInstantQueryResponse") //nolint:ineffassign,staticcheck
defer log.Finish()
if err := ctx.Err(); err != nil {
return nil, err
}
buf, err := tripperware.BodyBuffer(r, log)
if err != nil {
log.Error(err)
return nil, err
}
if r.StatusCode/100 != 2 {
return nil, httpgrpc.Errorf(r.StatusCode, string(buf))
}
var resp PrometheusInstantQueryResponse
if err := json.Unmarshal(buf, &resp); err != nil {
return nil, httpgrpc.Errorf(http.StatusInternalServerError, "error decoding response: %v", err)
}
for h, hv := range r.Header {
resp.Headers = append(resp.Headers, &tripperware.PrometheusResponseHeader{Name: h, Values: hv})
}
return &resp, nil
}
func (instantQueryCodec) EncodeRequest(ctx context.Context, r tripperware.Request) (*http.Request, error) {
promReq, ok := r.(*PrometheusRequest)
if !ok {
return nil, httpgrpc.Errorf(http.StatusBadRequest, "invalid request format")
}
params := url.Values{
"time": []string{tripperware.EncodeTime(promReq.Time)},
"query": []string{promReq.Query},
}
if promReq.Stats != "" {
params.Add("stats", promReq.Stats)
}
u := &url.URL{
Path: promReq.Path,
RawQuery: params.Encode(),
}
var h = http.Header{}
for n, hv := range promReq.Headers {
for _, v := range hv {
h.Add(n, v)
}
}
// Always ask gzip to the querier
h.Set("Accept-Encoding", "gzip")
req := &http.Request{
Method: "GET",
RequestURI: u.String(), // This is what the httpgrpc code looks at.
URL: u,
Body: http.NoBody,
Header: h,
}
return req.WithContext(ctx), nil
}
func (instantQueryCodec) EncodeResponse(ctx context.Context, res tripperware.Response) (*http.Response, error) {
sp, _ := opentracing.StartSpanFromContext(ctx, "APIResponse.ToHTTPResponse")
defer sp.Finish()
a, ok := res.(*PrometheusInstantQueryResponse)
if !ok {
return nil, httpgrpc.Errorf(http.StatusInternalServerError, "invalid response format")
}
b, err := json.Marshal(a)
if err != nil {
return nil, httpgrpc.Errorf(http.StatusInternalServerError, "error encoding response: %v", err)
}
sp.LogFields(otlog.Int("bytes", len(b)))
resp := http.Response{
Header: http.Header{
"Content-Type": []string{"application/json"},
},
Body: io.NopCloser(bytes.NewBuffer(b)),
StatusCode: http.StatusOK,
ContentLength: int64(len(b)),
}
return &resp, nil
}
func (instantQueryCodec) MergeResponse(ctx context.Context, req tripperware.Request, responses ...tripperware.Response) (tripperware.Response, error) {
sp, _ := opentracing.StartSpanFromContext(ctx, "PrometheusInstantQueryResponse.MergeResponse")
sp.SetTag("response_count", len(responses))
defer sp.Finish()
if len(responses) == 0 {
return NewEmptyPrometheusInstantQueryResponse(), nil
} else if len(responses) == 1 {
return responses[0], nil
}
promResponses := make([]*PrometheusInstantQueryResponse, 0, len(responses))
for _, resp := range responses {
promResponses = append(promResponses, resp.(*PrometheusInstantQueryResponse))
}
var data PrometheusInstantQueryData
// For now, we only shard queries that returns a vector.
switch promResponses[0].Data.ResultType {
case model.ValVector.String():
v, err := vectorMerge(ctx, req, promResponses)
if err != nil {
return nil, err
}
data = PrometheusInstantQueryData{
ResultType: model.ValVector.String(),
Result: PrometheusInstantQueryResult{
Result: &PrometheusInstantQueryResult_Vector{
Vector: v,
},
},
Stats: statsMerge(promResponses),
}
case model.ValMatrix.String():
sampleStreams, err := matrixMerge(ctx, promResponses)
if err != nil {
return nil, err
}
data = PrometheusInstantQueryData{
ResultType: model.ValMatrix.String(),
Result: PrometheusInstantQueryResult{
Result: &PrometheusInstantQueryResult_Matrix{
Matrix: &Matrix{
SampleStreams: sampleStreams,
},
},
},
Stats: statsMerge(promResponses),
}
default:
return nil, fmt.Errorf("unexpected result type on instant query: %s", promResponses[0].Data.ResultType)
}
res := &PrometheusInstantQueryResponse{
Status: queryrange.StatusSuccess,
Data: data,
}
return res, nil
}
func vectorMerge(ctx context.Context, req tripperware.Request, resps []*PrometheusInstantQueryResponse) (*Vector, error) {
output := map[string]*Sample{}
metrics := []string{} // Used to preserve the order for topk and bottomk.
sortPlan, err := sortPlanForQuery(req.GetQuery())
if err != nil {
return nil, err
}
buf := make([]byte, 0, 1024)
for _, resp := range resps {
if err = ctx.Err(); err != nil {
return nil, err
}
if resp == nil {
continue
}
// Merge vector result samples only. Skip other types such as
// string, scalar as those are not sharable.
if resp.Data.Result.GetVector() == nil {
continue
}
for _, sample := range resp.Data.Result.GetVector().Samples {
s := sample
if s == nil {
continue
}
metric := string(cortexpb.FromLabelAdaptersToLabels(sample.Labels).Bytes(buf))
if existingSample, ok := output[metric]; !ok {
output[metric] = s
metrics = append(metrics, metric) // Preserve the order of metric.
} else if existingSample.GetSample().TimestampMs < s.GetSample().TimestampMs {
// Choose the latest sample if we see overlap.
output[metric] = s
}
}
}
result := &Vector{
Samples: make([]*Sample, 0, len(output)),
}
if len(output) == 0 {
return result, nil
}
if sortPlan == mergeOnly {
for _, k := range metrics {
result.Samples = append(result.Samples, output[k])
}
return result, nil
}
type pair struct {
metric string
s *Sample
}
samples := make([]*pair, 0, len(output))
for k, v := range output {
samples = append(samples, &pair{
metric: k,
s: v,
})
}
sort.Slice(samples, func(i, j int) bool {
// Order is determined by vector
switch sortPlan {
case sortByValuesAsc:
return samples[i].s.Sample.Value < samples[j].s.Sample.Value
case sortByValuesDesc:
return samples[i].s.Sample.Value > samples[j].s.Sample.Value
}
return samples[i].metric < samples[j].metric
})
for _, p := range samples {
result.Samples = append(result.Samples, p.s)
}
return result, nil
}
type sortPlan int
const (
mergeOnly sortPlan = 0
sortByValuesAsc sortPlan = 1
sortByValuesDesc sortPlan = 2
sortByLabels sortPlan = 3
)
func sortPlanForQuery(q string) (sortPlan, error) {
expr, err := promqlparser.ParseExpr(q)
if err != nil {
return 0, err
}
// Check if the root expression is topk or bottomk
if aggr, ok := expr.(*promqlparser.AggregateExpr); ok {
if aggr.Op == promqlparser.TOPK || aggr.Op == promqlparser.BOTTOMK {
return mergeOnly, nil
}
}
checkForSort := func(expr promqlparser.Expr) (sortAsc, sortDesc bool) {
if n, ok := expr.(*promqlparser.Call); ok {
if n.Func != nil {
if n.Func.Name == "sort" {
sortAsc = true
}
if n.Func.Name == "sort_desc" {
sortDesc = true
}
}
}
return sortAsc, sortDesc
}
// Check the root expression for sort
if sortAsc, sortDesc := checkForSort(expr); sortAsc || sortDesc {
if sortAsc {
return sortByValuesAsc, nil
}
return sortByValuesDesc, nil
}
// If the root expression is a binary expression, check the LHS and RHS for sort
if bin, ok := expr.(*promqlparser.BinaryExpr); ok {
if sortAsc, sortDesc := checkForSort(bin.LHS); sortAsc || sortDesc {
if sortAsc {
return sortByValuesAsc, nil
}
return sortByValuesDesc, nil
}
if sortAsc, sortDesc := checkForSort(bin.RHS); sortAsc || sortDesc {
if sortAsc {
return sortByValuesAsc, nil
}
return sortByValuesDesc, nil
}
}
return sortByLabels, nil
}
func matrixMerge(ctx context.Context, resps []*PrometheusInstantQueryResponse) ([]tripperware.SampleStream, error) {
output := make(map[string]tripperware.SampleStream)
for _, resp := range resps {
if err := ctx.Err(); err != nil {
return nil, err
}
if resp == nil {
continue
}
if resp.Data.Result.GetMatrix() == nil {
continue
}
tripperware.MergeSampleStreams(output, resp.Data.Result.GetMatrix().GetSampleStreams())
}
keys := make([]string, 0, len(output))
for key := range output {
keys = append(keys, key)
}
sort.Strings(keys)
result := make([]tripperware.SampleStream, 0, len(output))
for _, key := range keys {
result = append(result, output[key])
}
return result, nil
}
// NewEmptyPrometheusInstantQueryResponse returns an empty successful Prometheus query range response.
func NewEmptyPrometheusInstantQueryResponse() *PrometheusInstantQueryResponse {
return &PrometheusInstantQueryResponse{
Status: queryrange.StatusSuccess,
Data: PrometheusInstantQueryData{
ResultType: model.ValVector.String(),
Result: PrometheusInstantQueryResult{
Result: &PrometheusInstantQueryResult_Vector{},
},
},
}
}
func statsMerge(resps []*PrometheusInstantQueryResponse) *tripperware.PrometheusResponseStats {
output := map[int64]*tripperware.PrometheusResponseQueryableSamplesStatsPerStep{}
hasStats := false
for _, resp := range resps {
if resp.Data.Stats == nil {
continue
}
hasStats = true
if resp.Data.Stats.Samples == nil {
continue
}
for _, s := range resp.Data.Stats.Samples.TotalQueryableSamplesPerStep {
if stats, ok := output[s.GetTimestampMs()]; ok {
stats.Value += s.Value
} else {
output[s.GetTimestampMs()] = s
}
}
}
if !hasStats {
return nil
}
return tripperware.StatsMerge(output)
}
func decorateWithParamName(err error, field string) error {
errTmpl := "invalid parameter %q; %v"
if status, ok := status.FromError(err); ok {
return httpgrpc.Errorf(int(status.Code()), errTmpl, field, status.Message())
}
return fmt.Errorf(errTmpl, field, err)
}
// UnmarshalJSON implements json.Unmarshaler.
func (s *Sample) UnmarshalJSON(data []byte) error {
var sample struct {
Metric labels.Labels `json:"metric"`
Value cortexpb.Sample `json:"value"`
}
if err := json.Unmarshal(data, &sample); err != nil {
return err
}
s.Labels = cortexpb.FromLabelsToLabelAdapters(sample.Metric)
s.Sample = sample.Value
return nil
}
// MarshalJSON implements json.Marshaler.
func (s *Sample) MarshalJSON() ([]byte, error) {
sample := struct {
Metric model.Metric `json:"metric"`
Value cortexpb.Sample `json:"value"`
}{
Metric: cortexpb.FromLabelAdaptersToMetric(s.Labels),
Value: s.Sample,
}
return json.Marshal(sample)
}
// UnmarshalJSON implements json.Unmarshaler.
func (s *PrometheusInstantQueryData) UnmarshalJSON(data []byte) error {
var queryData struct {
ResultType string `json:"resultType"`
Stats *tripperware.PrometheusResponseStats `json:"stats,omitempty"`
}
if err := json.Unmarshal(data, &queryData); err != nil {
return err
}
s.ResultType = queryData.ResultType
s.Stats = queryData.Stats
switch s.ResultType {
case model.ValVector.String():
var result struct {
Samples []*Sample `json:"result"`
}
if err := json.Unmarshal(data, &result); err != nil {
return err
}
s.Result = PrometheusInstantQueryResult{
Result: &PrometheusInstantQueryResult_Vector{Vector: &Vector{
Samples: result.Samples,
}},
}
case model.ValMatrix.String():
var result struct {
SampleStreams []tripperware.SampleStream `json:"result"`
}
if err := json.Unmarshal(data, &result); err != nil {
return err
}
s.Result = PrometheusInstantQueryResult{
Result: &PrometheusInstantQueryResult_Matrix{Matrix: &Matrix{
SampleStreams: result.SampleStreams,
}},
}
default:
s.Result = PrometheusInstantQueryResult{
Result: &PrometheusInstantQueryResult_RawBytes{data},
}
}
return nil
}
// MarshalJSON implements json.Marshaler.
func (s *PrometheusInstantQueryData) MarshalJSON() ([]byte, error) {
switch s.ResultType {
case model.ValVector.String():
res := struct {
ResultType string `json:"resultType"`
Data []*Sample `json:"result"`
Stats *tripperware.PrometheusResponseStats `json:"stats,omitempty"`
}{
ResultType: s.ResultType,
Data: s.Result.GetVector().Samples,
Stats: s.Stats,
}
return json.Marshal(res)
case model.ValMatrix.String():
res := struct {
ResultType string `json:"resultType"`
Data []tripperware.SampleStream `json:"result"`
Stats *tripperware.PrometheusResponseStats `json:"stats,omitempty"`
}{
ResultType: s.ResultType,
Data: s.Result.GetMatrix().SampleStreams,
Stats: s.Stats,
}
return json.Marshal(res)
default:
return s.Result.GetRawBytes(), nil
}
}