/
query_range.go
397 lines (337 loc) · 10.9 KB
/
query_range.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
package queryrange
import (
"bytes"
"context"
"fmt"
"io"
"math"
"net/http"
"net/url"
"sort"
"strconv"
"strings"
"time"
"github.com/gogo/status"
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/timestamp"
"github.com/weaveworks/common/httpgrpc"
"github.com/cortexproject/cortex/pkg/querier/tripperware"
"github.com/cortexproject/cortex/pkg/util"
"github.com/cortexproject/cortex/pkg/util/spanlogger"
)
// StatusSuccess Prometheus success result.
const StatusSuccess = "success"
var (
matrix = model.ValMatrix.String()
json = jsoniter.Config{
EscapeHTML: false, // No HTML in our responses.
SortMapKeys: true,
ValidateJsonRawMessage: false,
}.Froze()
errEndBeforeStart = httpgrpc.Errorf(http.StatusBadRequest, "end timestamp must not be before start time")
errNegativeStep = httpgrpc.Errorf(http.StatusBadRequest, "zero or negative query resolution step widths are not accepted. Try a positive integer")
errStepTooSmall = httpgrpc.Errorf(http.StatusBadRequest, "exceeded maximum resolution of 11,000 points per timeseries. Try decreasing the query resolution (?step=XX)")
// Name of the cache control header.
cacheControlHeader = "Cache-Control"
)
type prometheusCodec struct {
sharded bool
}
func NewPrometheusCodec(sharded bool) *prometheusCodec { //nolint:revive
return &prometheusCodec{sharded: sharded}
}
// WithStartEnd clones the current `PrometheusRequest` with a new `start` and `end` timestamp.
func (q *PrometheusRequest) WithStartEnd(start int64, end int64) tripperware.Request {
new := *q
new.Start = start
new.End = end
return &new
}
// WithQuery clones the current `PrometheusRequest` with a new query.
func (q *PrometheusRequest) WithQuery(query string) tripperware.Request {
new := *q
new.Query = query
return &new
}
// WithStats clones the current `PrometheusRequest` with a new stats.
func (q *PrometheusRequest) WithStats(stats string) tripperware.Request {
new := *q
new.Stats = stats
return &new
}
// LogToSpan logs the current `PrometheusRequest` parameters to the specified span.
func (q *PrometheusRequest) LogToSpan(sp opentracing.Span) {
sp.LogFields(
otlog.String("query", q.GetQuery()),
otlog.String("start", timestamp.Time(q.GetStart()).String()),
otlog.String("end", timestamp.Time(q.GetEnd()).String()),
otlog.Int64("step (ms)", q.GetStep()),
)
}
type byFirstTime []*PrometheusResponse
func (a byFirstTime) Len() int { return len(a) }
func (a byFirstTime) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a byFirstTime) Less(i, j int) bool { return a[i].minTime() < a[j].minTime() }
func (resp *PrometheusResponse) minTime() int64 {
result := resp.Data.Result
if len(result) == 0 {
return -1
}
if len(result[0].Samples) == 0 {
return -1
}
return result[0].Samples[0].TimestampMs
}
func (resp *PrometheusResponse) 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
}
// NewEmptyPrometheusResponse returns an empty successful Prometheus query range response.
func NewEmptyPrometheusResponse() *PrometheusResponse {
return &PrometheusResponse{
Status: StatusSuccess,
Data: PrometheusData{
ResultType: model.ValMatrix.String(),
Result: []tripperware.SampleStream{},
},
}
}
func (c prometheusCodec) MergeResponse(ctx context.Context, _ tripperware.Request, responses ...tripperware.Response) (tripperware.Response, error) {
sp, _ := opentracing.StartSpanFromContext(ctx, "QueryRangeResponse.MergeResponse")
sp.SetTag("response_count", len(responses))
defer sp.Finish()
if len(responses) == 0 {
return NewEmptyPrometheusResponse(), nil
}
promResponses := make([]*PrometheusResponse, 0, len(responses))
for _, res := range responses {
promResponses = append(promResponses, res.(*PrometheusResponse))
}
// Merge the responses.
sort.Sort(byFirstTime(promResponses))
sampleStreams, err := matrixMerge(ctx, promResponses)
if err != nil {
return nil, err
}
response := PrometheusResponse{
Status: StatusSuccess,
Data: PrometheusData{
ResultType: model.ValMatrix.String(),
Result: sampleStreams,
Stats: statsMerge(c.sharded, promResponses),
},
}
return &response, nil
}
func (c prometheusCodec) DecodeRequest(_ context.Context, r *http.Request, forwardHeaders []string) (tripperware.Request, error) {
var result PrometheusRequest
var err error
result.Start, err = util.ParseTime(r.FormValue("start"))
if err != nil {
return nil, decorateWithParamName(err, "start")
}
result.End, err = util.ParseTime(r.FormValue("end"))
if err != nil {
return nil, decorateWithParamName(err, "end")
}
if result.End < result.Start {
return nil, errEndBeforeStart
}
result.Step, err = parseDurationMs(r.FormValue("step"))
if err != nil {
return nil, decorateWithParamName(err, "step")
}
if result.Step <= 0 {
return nil, errNegativeStep
}
// For safety, limit the number of returned points per timeseries.
// This is sufficient for 60s resolution for a week or 1h resolution for a year.
if (result.End-result.Start)/result.Step > 11000 {
return nil, errStepTooSmall
}
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 = append(result.Headers, &tripperware.PrometheusRequestHeader{Name: h, Values: hv})
break
}
}
}
for _, value := range r.Header.Values(cacheControlHeader) {
if strings.Contains(value, noStoreValue) {
result.CachingOptions.Disabled = true
break
}
}
return &result, nil
}
func (prometheusCodec) 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{
"start": []string{tripperware.EncodeTime(promReq.Start)},
"end": []string{tripperware.EncodeTime(promReq.End)},
"step": []string{encodeDurationMs(promReq.Step)},
"query": []string{promReq.Query},
"stats": []string{promReq.Stats},
}
u := &url.URL{
Path: promReq.Path,
RawQuery: params.Encode(),
}
var h = http.Header{}
for _, hv := range promReq.Headers {
for _, v := range hv.Values {
h.Add(hv.Name, 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 (prometheusCodec) DecodeResponse(ctx context.Context, r *http.Response, _ tripperware.Request) (tripperware.Response, error) {
log, ctx := spanlogger.New(ctx, "ParseQueryRangeResponse") //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))
}
log.LogFields(otlog.Int("bytes", len(buf)))
var resp PrometheusResponse
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 (prometheusCodec) EncodeResponse(ctx context.Context, res tripperware.Response) (*http.Response, error) {
sp, _ := opentracing.StartSpanFromContext(ctx, "APIResponse.ToHTTPResponse")
defer sp.Finish()
a, ok := res.(*PrometheusResponse)
if !ok {
return nil, httpgrpc.Errorf(http.StatusInternalServerError, "invalid response format")
}
sp.LogFields(otlog.Int("series", len(a.Data.Result)))
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
}
// statsMerge merge the stats from 2 responses
// this function is similar to matrixMerge
func statsMerge(shouldSumStats bool, resps []*PrometheusResponse) *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 shouldSumStats {
if stats, ok := output[s.GetTimestampMs()]; ok {
stats.Value += s.Value
} else {
output[s.GetTimestampMs()] = s
}
} else {
output[s.GetTimestampMs()] = s
}
}
}
if !hasStats {
return nil
}
return tripperware.StatsMerge(output)
}
func matrixMerge(ctx context.Context, resps []*PrometheusResponse) ([]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
}
tripperware.MergeSampleStreams(output, resp.Data.GetResult())
}
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
}
func parseDurationMs(s string) (int64, error) {
if d, err := strconv.ParseFloat(s, 64); err == nil {
ts := d * float64(time.Second/time.Millisecond)
if ts > float64(math.MaxInt64) || ts < float64(math.MinInt64) {
return 0, httpgrpc.Errorf(http.StatusBadRequest, "cannot parse %q to a valid duration. It overflows int64", s)
}
return int64(ts), nil
}
if d, err := model.ParseDuration(s); err == nil {
return int64(d) / int64(time.Millisecond/time.Nanosecond), nil
}
return 0, httpgrpc.Errorf(http.StatusBadRequest, "cannot parse %q to a valid duration", s)
}
func encodeDurationMs(d int64) string {
return strconv.FormatFloat(float64(d)/float64(time.Second/time.Millisecond), 'f', -1, 64)
}
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)
}