Support ruler to retrieve proto format query response #6345
+708
−89
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,9 +11,11 @@ import ( | |
| "time" | ||
|
|
||
| jsoniter "github.com/json-iterator/go" | ||
| "github.com/munnerz/goautoneg" | ||
| "github.com/opentracing/opentracing-go" | ||
| otlog "github.com/opentracing/opentracing-go/log" | ||
| "github.com/prometheus/common/model" | ||
| v1 "github.com/prometheus/prometheus/web/api/v1" | ||
| "github.com/weaveworks/common/httpgrpc" | ||
| "google.golang.org/grpc/status" | ||
|
|
||
|
|
@@ -29,6 +31,9 @@ var ( | |
| SortMapKeys: true, | ||
| ValidateJsonRawMessage: false, | ||
| }.Froze() | ||
|
|
||
| rulerMIMEType = v1.MIMEType{Type: "application", SubType: tripperware.QueryResponseCortexMIMESubType} | ||
|
There was a problem hiding this comment. Can we do |
||
| jsonMIMEType = v1.MIMEType{Type: "application", SubType: "json"} | ||
| ) | ||
|
|
||
| type instantQueryCodec struct { | ||
|
|
@@ -68,12 +73,18 @@ func (c instantQueryCodec) DecodeRequest(_ context.Context, r *http.Request, for | |
| result.Stats = r.FormValue("stats") | ||
| result.Path = r.URL.Path | ||
|
|
||
| isSourceRuler := strings.Contains(r.Header.Get("User-Agent"), tripperware.RulerUserAgent) | ||
| if isSourceRuler { | ||
| // When the source is the Ruler, then forward whole headers | ||
| result.Headers = r.Header | ||
| } else { | ||
| // 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 | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -155,7 +166,11 @@ func (c instantQueryCodec) EncodeRequest(ctx context.Context, r tripperware.Requ | |
| } | ||
| } | ||
|
|
||
| isSourceRuler := strings.Contains(h.Get("User-Agent"), tripperware.RulerUserAgent) | ||
| if !isSourceRuler { | ||
| // When the source is the Ruler, skip set header | ||
| tripperware.SetRequestHeaders(h, c.defaultCodecType, c.compression) | ||
| } | ||
|
|
||
| req := &http.Request{ | ||
| Method: "GET", | ||
|
|
@@ -168,7 +183,7 @@ func (c instantQueryCodec) EncodeRequest(ctx context.Context, r tripperware.Requ | |
| return req.WithContext(ctx), nil | ||
| } | ||
|
|
||
| func (c instantQueryCodec) EncodeResponse(ctx context.Context, req *http.Request, res tripperware.Response) (*http.Response, error) { | ||
| sp, _ := opentracing.StartSpanFromContext(ctx, "APIResponse.ToHTTPResponse") | ||
| defer sp.Finish() | ||
|
|
||
|
|
@@ -180,7 +195,7 @@ func (instantQueryCodec) EncodeResponse(ctx context.Context, res tripperware.Res | |
| queryStats := stats.FromContext(ctx) | ||
| tripperware.SetQueryResponseStats(a, queryStats) | ||
|
|
||
| contentType, b, err := marshalResponse(a, req.Header.Get("Accept")) | ||
|
There was a problem hiding this comment. Should we only try to return non JSON response format if we know the request comes from Ruler? But tbh Idk if we can identify ruler requests or not. We probably have to do what you are doing here. WDYT? @alanprot @danielblando There was a problem hiding this comment. @yeya24 There was a problem hiding this comment. Yeah.. maybe we should define our internal MIME type so external calls will only get that format if they really wanna. There was a problem hiding this comment. This sounds worth trying. Let's hear from other maintainers, too |
||
| if err != nil { | ||
| return nil, httpgrpc.Errorf(http.StatusInternalServerError, "error encoding response: %v", err) | ||
| } | ||
|
|
@@ -189,7 +204,7 @@ func (instantQueryCodec) EncodeResponse(ctx context.Context, res tripperware.Res | |
|
|
||
| resp := http.Response{ | ||
| Header: http.Header{ | ||
| "Content-Type": []string{contentType}, | ||
| }, | ||
| Body: io.NopCloser(bytes.NewBuffer(b)), | ||
| StatusCode: http.StatusOK, | ||
|
|
@@ -217,3 +232,18 @@ func decorateWithParamName(err error, field string) error { | |
| } | ||
| return fmt.Errorf(errTmpl, field, err) | ||
| } | ||
|
|
||
| func marshalResponse(resp *tripperware.PrometheusResponse, acceptHeader string) (string, []byte, error) { | ||
| for _, clause := range goautoneg.ParseAccept(acceptHeader) { | ||
| if jsonMIMEType.Satisfies(clause) { | ||
| b, err := json.Marshal(resp) | ||
| return tripperware.ApplicationJson, b, err | ||
| } else if rulerMIMEType.Satisfies(clause) { | ||
| b, err := resp.Marshal() | ||
| return tripperware.QueryResponseCortexMIMEType, b, err | ||
| } | ||
| } | ||
|
|
||
| b, err := json.Marshal(resp) | ||
| return tripperware.ApplicationJson, b, err | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: missing name for this matrix test https://github.com/cortexproject/cortex/pull/6345/files#diff-9c2062cda65af13cf43cc9371cae0424744499ad5ca83597ea2bf4df2437f4d8R106
seems like it is the same as https://github.com/cortexproject/cortex/pull/6345/files#diff-9c2062cda65af13cf43cc9371cae0424744499ad5ca83597ea2bf4df2437f4d8R186?