diff --git a/go.mod b/go.mod index 4597ee4201..565456ed96 100644 --- a/go.mod +++ b/go.mod @@ -167,7 +167,7 @@ require ( github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.2 // indirect github.com/morikuni/aec v1.0.0 // indirect - github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect + github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 github.com/opencontainers/go-digest v1.0.0 // indirect github.com/opencontainers/image-spec v1.0.2 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect diff --git a/web/api/v1/api.go b/web/api/v1/api.go index fe343aab13..73892aaf6d 100644 --- a/web/api/v1/api.go +++ b/web/api/v1/api.go @@ -27,12 +27,12 @@ import ( "strconv" "strings" "time" - "unsafe" "github.com/go-kit/log" "github.com/go-kit/log/level" "github.com/grafana/regexp" jsoniter "github.com/json-iterator/go" + "github.com/munnerz/goautoneg" "github.com/pkg/errors" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/common/model" @@ -40,7 +40,6 @@ import ( "golang.org/x/exp/slices" "github.com/prometheus/prometheus/config" - "github.com/prometheus/prometheus/model/exemplar" "github.com/prometheus/prometheus/model/labels" "github.com/prometheus/prometheus/model/textparse" "github.com/prometheus/prometheus/model/timestamp" @@ -53,7 +52,6 @@ import ( "github.com/prometheus/prometheus/tsdb" "github.com/prometheus/prometheus/tsdb/index" "github.com/prometheus/prometheus/util/httputil" - "github.com/prometheus/prometheus/util/jsonutil" "github.com/prometheus/prometheus/util/stats" ) @@ -71,14 +69,15 @@ const ( type errorType string const ( - errorNone errorType = "" - errorTimeout errorType = "timeout" - errorCanceled errorType = "canceled" - errorExec errorType = "execution" - errorBadData errorType = "bad_data" - errorInternal errorType = "internal" - errorUnavailable errorType = "unavailable" - errorNotFound errorType = "not_found" + errorNone errorType = "" + errorTimeout errorType = "timeout" + errorCanceled errorType = "canceled" + errorExec errorType = "execution" + errorBadData errorType = "bad_data" + errorInternal errorType = "internal" + errorUnavailable errorType = "unavailable" + errorNotFound errorType = "not_found" + errorNotAcceptable errorType = "not_acceptable" ) var LocalhostRepresentations = []string{"127.0.0.1", "localhost", "::1"} @@ -149,7 +148,8 @@ type RuntimeInfo struct { StorageRetention string `json:"storageRetention"` } -type response struct { +// Response contains a response to a HTTP API request. +type Response struct { Status status `json:"status"` Data interface{} `json:"data,omitempty"` ErrorType errorType `json:"errorType,omitempty"` @@ -217,14 +217,8 @@ type API struct { remoteWriteHandler http.Handler remoteReadHandler http.Handler -} -func init() { - jsoniter.RegisterTypeEncoderFunc("promql.Series", marshalSeriesJSON, marshalSeriesJSONIsEmpty) - jsoniter.RegisterTypeEncoderFunc("promql.Sample", marshalSampleJSON, marshalSampleJSONIsEmpty) - jsoniter.RegisterTypeEncoderFunc("promql.FPoint", marshalFPointJSON, marshalPointJSONIsEmpty) - jsoniter.RegisterTypeEncoderFunc("promql.HPoint", marshalHPointJSON, marshalPointJSONIsEmpty) - jsoniter.RegisterTypeEncoderFunc("exemplar.Exemplar", marshalExemplarJSON, marshalExemplarJSONEmpty) + codecs []Codec } // NewAPI returns an initialized API type. @@ -285,6 +279,8 @@ func NewAPI( remoteReadHandler: remote.NewReadHandler(logger, registerer, q, configFunc, remoteReadSampleLimit, remoteReadConcurrencyLimit, remoteReadMaxBytesInFrame), } + a.InstallCodec(JSONCodec{}) + if statsRenderer != nil { a.statsRenderer = statsRenderer } @@ -296,6 +292,18 @@ func NewAPI( return a } +// InstallCodec adds codec to this API's available codecs. +// Codecs installed first take precedence over codecs installed later when evaluating wildcards in Accept headers. +// The first installed codec is used as a fallback when the Accept header cannot be satisfied or if there is no Accept header. +func (api *API) InstallCodec(codec Codec) { + api.codecs = append(api.codecs, codec) +} + +// ClearCodecs removes all available codecs from this API, including the default codec installed by NewAPI. +func (api *API) ClearCodecs() { + api.codecs = nil +} + func setUnavailStatusOnTSDBNotReady(r apiFuncResult) apiFuncResult { if r.err != nil && errors.Cause(r.err.err) == tsdb.ErrNotReady { r.err.typ = errorUnavailable @@ -318,7 +326,7 @@ func (api *API) Register(r *route.Router) { } if result.data != nil { - api.respond(w, result.data, result.warnings) + api.respond(w, r, result.data, result.warnings) return } w.WriteHeader(http.StatusNoContent) @@ -386,7 +394,7 @@ func (api *API) Register(r *route.Router) { r.Put("/admin/tsdb/snapshot", wrapAgent(api.snapshot)) } -type queryData struct { +type QueryData struct { ResultType parser.ValueType `json:"resultType"` Result parser.Value `json:"result"` Stats stats.QueryStats `json:"stats,omitempty"` @@ -451,7 +459,7 @@ func (api *API) query(r *http.Request) (result apiFuncResult) { } qs := sr(ctx, qry.Stats(), r.FormValue("stats")) - return apiFuncResult{&queryData{ + return apiFuncResult{&QueryData{ ResultType: res.Value.Type(), Result: res.Value, Stats: qs, @@ -553,7 +561,7 @@ func (api *API) queryRange(r *http.Request) (result apiFuncResult) { } qs := sr(ctx, qry.Stats(), r.FormValue("stats")) - return apiFuncResult{&queryData{ + return apiFuncResult{&QueryData{ ResultType: res.Value.Type(), Result: res.Value, Stats: qs, @@ -1549,7 +1557,7 @@ func (api *API) serveWALReplayStatus(w http.ResponseWriter, r *http.Request) { if err != nil { api.respondError(w, &apiError{errorInternal, err}, nil) } - api.respond(w, walReplayStatus{ + api.respond(w, r, walReplayStatus{ Min: status.Min, Max: status.Max, Current: status.Current, @@ -1651,34 +1659,59 @@ func (api *API) cleanTombstones(*http.Request) apiFuncResult { return apiFuncResult{nil, nil, nil, nil} } -func (api *API) respond(w http.ResponseWriter, data interface{}, warnings storage.Warnings) { +func (api *API) respond(w http.ResponseWriter, req *http.Request, data interface{}, warnings storage.Warnings) { statusMessage := statusSuccess var warningStrings []string for _, warning := range warnings { warningStrings = append(warningStrings, warning.Error()) } - json := jsoniter.ConfigCompatibleWithStandardLibrary - b, err := json.Marshal(&response{ + + resp := &Response{ Status: statusMessage, Data: data, Warnings: warningStrings, - }) + } + + codec, err := api.negotiateCodec(req, resp) if err != nil { - level.Error(api.logger).Log("msg", "error marshaling json response", "err", err) + api.respondError(w, &apiError{errorNotAcceptable, err}, nil) + return + } + + b, err := codec.Encode(resp) + if err != nil { + level.Error(api.logger).Log("msg", "error marshaling response", "err", err) http.Error(w, err.Error(), http.StatusInternalServerError) return } - w.Header().Set("Content-Type", "application/json") + w.Header().Set("Content-Type", codec.ContentType().String()) w.WriteHeader(http.StatusOK) if n, err := w.Write(b); err != nil { level.Error(api.logger).Log("msg", "error writing response", "bytesWritten", n, "err", err) } } +func (api *API) negotiateCodec(req *http.Request, resp *Response) (Codec, error) { + for _, clause := range goautoneg.ParseAccept(req.Header.Get("Accept")) { + for _, codec := range api.codecs { + if codec.ContentType().Satisfies(clause) && codec.CanEncode(resp) { + return codec, nil + } + } + } + + defaultCodec := api.codecs[0] + if !defaultCodec.CanEncode(resp) { + return nil, fmt.Errorf("cannot encode response as %s", defaultCodec.ContentType()) + } + + return defaultCodec, nil +} + func (api *API) respondError(w http.ResponseWriter, apiErr *apiError, data interface{}) { json := jsoniter.ConfigCompatibleWithStandardLibrary - b, err := json.Marshal(&response{ + b, err := json.Marshal(&Response{ Status: statusError, ErrorType: apiErr.typ, Error: apiErr.err.Error(), @@ -1704,6 +1737,8 @@ func (api *API) respondError(w http.ResponseWriter, apiErr *apiError, data inter code = http.StatusInternalServerError case errorNotFound: code = http.StatusNotFound + case errorNotAcceptable: + code = http.StatusNotAcceptable default: code = http.StatusInternalServerError } @@ -1785,174 +1820,3 @@ OUTER: } return matcherSets, nil } - -// marshalSeriesJSON writes something like the following: -// -// { -// "metric" : { -// "__name__" : "up", -// "job" : "prometheus", -// "instance" : "localhost:9090" -// }, -// "values": [ -// [ 1435781451.781, "1" ], -// < more values> -// ], -// "histograms": [ -// [ 1435781451.781, { < histogram, see jsonutil.MarshalHistogram > } ], -// < more histograms > -// ], -// }, -func marshalSeriesJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { - s := *((*promql.Series)(ptr)) - stream.WriteObjectStart() - stream.WriteObjectField(`metric`) - m, err := s.Metric.MarshalJSON() - if err != nil { - stream.Error = err - return - } - stream.SetBuffer(append(stream.Buffer(), m...)) - - for i, p := range s.Floats { - stream.WriteMore() - if i == 0 { - stream.WriteObjectField(`values`) - stream.WriteArrayStart() - } - marshalFPointJSON(unsafe.Pointer(&p), stream) - } - if len(s.Floats) > 0 { - stream.WriteArrayEnd() - } - for i, p := range s.Histograms { - stream.WriteMore() - if i == 0 { - stream.WriteObjectField(`histograms`) - stream.WriteArrayStart() - } - marshalHPointJSON(unsafe.Pointer(&p), stream) - } - if len(s.Histograms) > 0 { - stream.WriteArrayEnd() - } - stream.WriteObjectEnd() -} - -func marshalSeriesJSONIsEmpty(unsafe.Pointer) bool { - return false -} - -// marshalSampleJSON writes something like the following for normal value samples: -// -// { -// "metric" : { -// "__name__" : "up", -// "job" : "prometheus", -// "instance" : "localhost:9090" -// }, -// "value": [ 1435781451.781, "1.234" ] -// }, -// -// For histogram samples, it writes something like this: -// -// { -// "metric" : { -// "__name__" : "up", -// "job" : "prometheus", -// "instance" : "localhost:9090" -// }, -// "histogram": [ 1435781451.781, { < histogram, see jsonutil.MarshalHistogram > } ] -// }, -func marshalSampleJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { - s := *((*promql.Sample)(ptr)) - stream.WriteObjectStart() - stream.WriteObjectField(`metric`) - m, err := s.Metric.MarshalJSON() - if err != nil { - stream.Error = err - return - } - stream.SetBuffer(append(stream.Buffer(), m...)) - stream.WriteMore() - if s.H == nil { - stream.WriteObjectField(`value`) - } else { - stream.WriteObjectField(`histogram`) - } - stream.WriteArrayStart() - jsonutil.MarshalTimestamp(s.T, stream) - stream.WriteMore() - if s.H == nil { - jsonutil.MarshalFloat(s.F, stream) - } else { - jsonutil.MarshalHistogram(s.H, stream) - } - stream.WriteArrayEnd() - stream.WriteObjectEnd() -} - -func marshalSampleJSONIsEmpty(unsafe.Pointer) bool { - return false -} - -// marshalFPointJSON writes `[ts, "1.234"]`. -func marshalFPointJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { - p := *((*promql.FPoint)(ptr)) - stream.WriteArrayStart() - jsonutil.MarshalTimestamp(p.T, stream) - stream.WriteMore() - jsonutil.MarshalFloat(p.F, stream) - stream.WriteArrayEnd() -} - -// marshalHPointJSON writes `[ts, { < histogram, see jsonutil.MarshalHistogram > } ]`. -func marshalHPointJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { - p := *((*promql.HPoint)(ptr)) - stream.WriteArrayStart() - jsonutil.MarshalTimestamp(p.T, stream) - stream.WriteMore() - jsonutil.MarshalHistogram(p.H, stream) - stream.WriteArrayEnd() -} - -func marshalPointJSONIsEmpty(unsafe.Pointer) bool { - return false -} - -// marshalExemplarJSON writes. -// -// { -// labels: , -// value: "", -// timestamp: -// } -func marshalExemplarJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { - p := *((*exemplar.Exemplar)(ptr)) - stream.WriteObjectStart() - - // "labels" key. - stream.WriteObjectField(`labels`) - lbls, err := p.Labels.MarshalJSON() - if err != nil { - stream.Error = err - return - } - stream.SetBuffer(append(stream.Buffer(), lbls...)) - - // "value" key. - stream.WriteMore() - stream.WriteObjectField(`value`) - jsonutil.MarshalFloat(p.Value, stream) - - // "timestamp" key. - stream.WriteMore() - stream.WriteObjectField(`timestamp`) - jsonutil.MarshalTimestamp(p.Ts, stream) - - stream.WriteObjectEnd() -} - -func marshalExemplarJSONEmpty(unsafe.Pointer) bool { - return false -} diff --git a/web/api/v1/api_test.go b/web/api/v1/api_test.go index 9105ce3362..321a13d5e2 100644 --- a/web/api/v1/api_test.go +++ b/web/api/v1/api_test.go @@ -18,7 +18,6 @@ import ( "encoding/json" "fmt" "io" - "math" "net/http" "net/http/httptest" "net/url" @@ -30,7 +29,6 @@ import ( "testing" "time" - "github.com/prometheus/prometheus/model/histogram" "github.com/prometheus/prometheus/prompb" "github.com/prometheus/prometheus/util/stats" @@ -835,8 +833,8 @@ func TestStats(t *testing.T) { name: "stats is blank", param: "", expected: func(t *testing.T, i interface{}) { - require.IsType(t, i, &queryData{}) - qd := i.(*queryData) + require.IsType(t, i, &QueryData{}) + qd := i.(*QueryData) require.Nil(t, qd.Stats) }, }, @@ -844,8 +842,8 @@ func TestStats(t *testing.T) { name: "stats is true", param: "true", expected: func(t *testing.T, i interface{}) { - require.IsType(t, i, &queryData{}) - qd := i.(*queryData) + require.IsType(t, i, &QueryData{}) + qd := i.(*QueryData) require.NotNil(t, qd.Stats) qs := qd.Stats.Builtin() require.NotNil(t, qs.Timings) @@ -859,8 +857,8 @@ func TestStats(t *testing.T) { name: "stats is all", param: "all", expected: func(t *testing.T, i interface{}) { - require.IsType(t, i, &queryData{}) - qd := i.(*queryData) + require.IsType(t, i, &QueryData{}) + qd := i.(*QueryData) require.NotNil(t, qd.Stats) qs := qd.Stats.Builtin() require.NotNil(t, qs.Timings) @@ -880,8 +878,8 @@ func TestStats(t *testing.T) { }, param: "known", expected: func(t *testing.T, i interface{}) { - require.IsType(t, i, &queryData{}) - qd := i.(*queryData) + require.IsType(t, i, &QueryData{}) + qd := i.(*QueryData) require.NotNil(t, qd.Stats) j, err := json.Marshal(qd.Stats) require.NoError(t, err) @@ -1042,7 +1040,7 @@ func testEndpoints(t *testing.T, api *API, tr *testTargetRetriever, es storage.E "query": []string{"2"}, "time": []string{"123.4"}, }, - response: &queryData{ + response: &QueryData{ ResultType: parser.ValueTypeScalar, Result: promql.Scalar{ V: 2, @@ -1056,7 +1054,7 @@ func testEndpoints(t *testing.T, api *API, tr *testTargetRetriever, es storage.E "query": []string{"0.333"}, "time": []string{"1970-01-01T00:02:03Z"}, }, - response: &queryData{ + response: &QueryData{ ResultType: parser.ValueTypeScalar, Result: promql.Scalar{ V: 0.333, @@ -1070,7 +1068,7 @@ func testEndpoints(t *testing.T, api *API, tr *testTargetRetriever, es storage.E "query": []string{"0.333"}, "time": []string{"1970-01-01T01:02:03+01:00"}, }, - response: &queryData{ + response: &QueryData{ ResultType: parser.ValueTypeScalar, Result: promql.Scalar{ V: 0.333, @@ -1083,7 +1081,7 @@ func testEndpoints(t *testing.T, api *API, tr *testTargetRetriever, es storage.E query: url.Values{ "query": []string{"0.333"}, }, - response: &queryData{ + response: &QueryData{ ResultType: parser.ValueTypeScalar, Result: promql.Scalar{ V: 0.333, @@ -1099,7 +1097,7 @@ func testEndpoints(t *testing.T, api *API, tr *testTargetRetriever, es storage.E "end": []string{"2"}, "step": []string{"1"}, }, - response: &queryData{ + response: &QueryData{ ResultType: parser.ValueTypeMatrix, Result: promql.Matrix{ promql.Series{ @@ -2968,39 +2966,123 @@ func TestAdminEndpoints(t *testing.T) { } func TestRespondSuccess(t *testing.T) { + api := API{ + logger: log.NewNopLogger(), + } + + api.ClearCodecs() + api.InstallCodec(JSONCodec{}) + api.InstallCodec(&testCodec{contentType: MIMEType{"test", "cannot-encode"}, canEncode: false}) + api.InstallCodec(&testCodec{contentType: MIMEType{"test", "can-encode"}, canEncode: true}) + api.InstallCodec(&testCodec{contentType: MIMEType{"test", "can-encode-2"}, canEncode: true}) + s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - api := API{} - api.respond(w, "test", nil) + api.respond(w, r, "test", nil) })) defer s.Close() - resp, err := http.Get(s.URL) - if err != nil { - t.Fatalf("Error on test request: %s", err) + for _, tc := range []struct { + name string + acceptHeader string + expectedContentType string + expectedBody string + }{ + { + name: "no Accept header", + expectedContentType: "application/json", + expectedBody: `{"status":"success","data":"test"}`, + }, + { + name: "Accept header with single content type which is suitable", + acceptHeader: "test/can-encode", + expectedContentType: "test/can-encode", + expectedBody: `response from test/can-encode codec`, + }, + { + name: "Accept header with single content type which is not available", + acceptHeader: "test/not-registered", + expectedContentType: "application/json", + expectedBody: `{"status":"success","data":"test"}`, + }, + { + name: "Accept header with single content type which cannot encode the response payload", + acceptHeader: "test/cannot-encode", + expectedContentType: "application/json", + expectedBody: `{"status":"success","data":"test"}`, + }, + { + name: "Accept header with multiple content types, all of which are suitable", + acceptHeader: "test/can-encode, test/can-encode-2", + expectedContentType: "test/can-encode", + expectedBody: `response from test/can-encode codec`, + }, + { + name: "Accept header with multiple content types, only one of which is available", + acceptHeader: "test/not-registered, test/can-encode", + expectedContentType: "test/can-encode", + expectedBody: `response from test/can-encode codec`, + }, + { + name: "Accept header with multiple content types, only one of which can encode the response payload", + acceptHeader: "test/cannot-encode, test/can-encode", + expectedContentType: "test/can-encode", + expectedBody: `response from test/can-encode codec`, + }, + { + name: "Accept header with multiple content types, none of which are available", + acceptHeader: "test/not-registered, test/also-not-registered", + expectedContentType: "application/json", + expectedBody: `{"status":"success","data":"test"}`, + }, + } { + t.Run(tc.name, func(t *testing.T) { + req, err := http.NewRequest(http.MethodGet, s.URL, nil) + require.NoError(t, err) + + if tc.acceptHeader != "" { + req.Header.Set("Accept", tc.acceptHeader) + } + + resp, err := http.DefaultClient.Do(req) + require.NoError(t, err) + + body, err := io.ReadAll(resp.Body) + defer resp.Body.Close() + require.NoError(t, err) + + require.Equal(t, http.StatusOK, resp.StatusCode) + require.Equal(t, tc.expectedContentType, resp.Header.Get("Content-Type")) + require.Equal(t, tc.expectedBody, string(body)) + }) } +} + +func TestRespondSuccess_DefaultCodecCannotEncodeResponse(t *testing.T) { + api := API{ + logger: log.NewNopLogger(), + } + + api.ClearCodecs() + api.InstallCodec(&testCodec{contentType: MIMEType{"application", "default-format"}, canEncode: false}) + + s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + api.respond(w, r, "test", nil) + })) + defer s.Close() + + req, err := http.NewRequest(http.MethodGet, s.URL, nil) + require.NoError(t, err) + + resp, err := http.DefaultClient.Do(req) + require.NoError(t, err) + body, err := io.ReadAll(resp.Body) defer resp.Body.Close() - if err != nil { - t.Fatalf("Error reading response body: %s", err) - } + require.NoError(t, err) - if resp.StatusCode != http.StatusOK { - t.Fatalf("Return code %d expected in success response but got %d", 200, resp.StatusCode) - } - if h := resp.Header.Get("Content-Type"); h != "application/json" { - t.Fatalf("Expected Content-Type %q but got %q", "application/json", h) - } - - var res response - if err = json.Unmarshal(body, &res); err != nil { - t.Fatalf("Error unmarshaling JSON body: %s", err) - } - - exp := &response{ - Status: statusSuccess, - Data: "test", - } - require.Equal(t, exp, &res) + require.Equal(t, http.StatusNotAcceptable, resp.StatusCode) + require.Equal(t, "application/json", resp.Header.Get("Content-Type")) + require.Equal(t, `{"status":"error","errorType":"not_acceptable","error":"cannot encode response as application/default-format"}`, string(body)) } func TestRespondError(t *testing.T) { @@ -3027,12 +3109,12 @@ func TestRespondError(t *testing.T) { t.Fatalf("Expected Content-Type %q but got %q", "application/json", h) } - var res response + var res Response if err = json.Unmarshal(body, &res); err != nil { t.Fatalf("Error unmarshaling JSON body: %s", err) } - exp := &response{ + exp := &Response{ Status: statusError, Data: "test", ErrorType: errorTimeout, @@ -3250,165 +3332,6 @@ func TestOptionsMethod(t *testing.T) { } } -func TestRespond(t *testing.T) { - cases := []struct { - response interface{} - expected string - }{ - { - response: &queryData{ - ResultType: parser.ValueTypeMatrix, - Result: promql.Matrix{ - promql.Series{ - Floats: []promql.FPoint{{F: 1, T: 1000}}, - Metric: labels.FromStrings("__name__", "foo"), - }, - }, - }, - expected: `{"status":"success","data":{"resultType":"matrix","result":[{"metric":{"__name__":"foo"},"values":[[1,"1"]]}]}}`, - }, - { - response: &queryData{ - ResultType: parser.ValueTypeMatrix, - Result: promql.Matrix{ - promql.Series{ - Histograms: []promql.HPoint{{H: &histogram.FloatHistogram{ - Schema: 2, - ZeroThreshold: 0.001, - ZeroCount: 12, - Count: 10, - Sum: 20, - PositiveSpans: []histogram.Span{ - {Offset: 3, Length: 2}, - {Offset: 1, Length: 3}, - }, - NegativeSpans: []histogram.Span{ - {Offset: 2, Length: 2}, - }, - PositiveBuckets: []float64{1, 2, 2, 1, 1}, - NegativeBuckets: []float64{2, 1}, - }, T: 1000}}, - Metric: labels.FromStrings("__name__", "foo"), - }, - }, - }, - expected: `{"status":"success","data":{"resultType":"matrix","result":[{"metric":{"__name__":"foo"},"histograms":[[1,{"count":"10","sum":"20","buckets":[[1,"-1.6817928305074288","-1.414213562373095","1"],[1,"-1.414213562373095","-1.189207115002721","2"],[3,"-0.001","0.001","12"],[0,"1.414213562373095","1.6817928305074288","1"],[0,"1.6817928305074288","2","2"],[0,"2.378414230005442","2.82842712474619","2"],[0,"2.82842712474619","3.3635856610148576","1"],[0,"3.3635856610148576","4","1"]]}]]}]}}`, - }, - { - response: promql.FPoint{F: 0, T: 0}, - expected: `{"status":"success","data":[0,"0"]}`, - }, - { - response: promql.FPoint{F: 20, T: 1}, - expected: `{"status":"success","data":[0.001,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: 10}, - expected: `{"status":"success","data":[0.010,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: 100}, - expected: `{"status":"success","data":[0.100,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: 1001}, - expected: `{"status":"success","data":[1.001,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: 1010}, - expected: `{"status":"success","data":[1.010,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: 1100}, - expected: `{"status":"success","data":[1.100,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: 12345678123456555}, - expected: `{"status":"success","data":[12345678123456.555,"20"]}`, - }, - { - response: promql.FPoint{F: 20, T: -1}, - expected: `{"status":"success","data":[-0.001,"20"]}`, - }, - { - response: promql.FPoint{F: math.NaN(), T: 0}, - expected: `{"status":"success","data":[0,"NaN"]}`, - }, - { - response: promql.FPoint{F: math.Inf(1), T: 0}, - expected: `{"status":"success","data":[0,"+Inf"]}`, - }, - { - response: promql.FPoint{F: math.Inf(-1), T: 0}, - expected: `{"status":"success","data":[0,"-Inf"]}`, - }, - { - response: promql.FPoint{F: 1.2345678e6, T: 0}, - expected: `{"status":"success","data":[0,"1234567.8"]}`, - }, - { - response: promql.FPoint{F: 1.2345678e-6, T: 0}, - expected: `{"status":"success","data":[0,"0.0000012345678"]}`, - }, - { - response: promql.FPoint{F: 1.2345678e-67, T: 0}, - expected: `{"status":"success","data":[0,"1.2345678e-67"]}`, - }, - { - response: []exemplar.QueryResult{ - { - SeriesLabels: labels.FromStrings("foo", "bar"), - Exemplars: []exemplar.Exemplar{ - { - Labels: labels.FromStrings("traceID", "abc"), - Value: 100.123, - Ts: 1234, - }, - }, - }, - }, - expected: `{"status":"success","data":[{"seriesLabels":{"foo":"bar"},"exemplars":[{"labels":{"traceID":"abc"},"value":"100.123","timestamp":1.234}]}]}`, - }, - { - response: []exemplar.QueryResult{ - { - SeriesLabels: labels.FromStrings("foo", "bar"), - Exemplars: []exemplar.Exemplar{ - { - Labels: labels.FromStrings("traceID", "abc"), - Value: math.Inf(1), - Ts: 1234, - }, - }, - }, - }, - expected: `{"status":"success","data":[{"seriesLabels":{"foo":"bar"},"exemplars":[{"labels":{"traceID":"abc"},"value":"+Inf","timestamp":1.234}]}]}`, - }, - } - - for _, c := range cases { - s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - api := API{} - api.respond(w, c.response, nil) - })) - defer s.Close() - - resp, err := http.Get(s.URL) - if err != nil { - t.Fatalf("Error on test request: %s", err) - } - body, err := io.ReadAll(resp.Body) - defer resp.Body.Close() - if err != nil { - t.Fatalf("Error reading response body: %s", err) - } - - if string(body) != c.expected { - t.Fatalf("Expected response \n%v\n but got \n%v\n", c.expected, string(body)) - } - } -} - func TestTSDBStatus(t *testing.T) { tsdb := &fakeDB{} tsdbStatusAPI := func(api *API) apiFunc { return api.serveTSDBStatus } @@ -3495,11 +3418,13 @@ var testResponseWriter = httptest.ResponseRecorder{} func BenchmarkRespond(b *testing.B) { b.ReportAllocs() + request, err := http.NewRequest(http.MethodGet, "/does-not-matter", nil) + require.NoError(b, err) points := []promql.FPoint{} for i := 0; i < 10000; i++ { points = append(points, promql.FPoint{F: float64(i * 1000000), T: int64(i)}) } - response := &queryData{ + response := &QueryData{ ResultType: parser.ValueTypeMatrix, Result: promql.Matrix{ promql.Series{ @@ -3510,8 +3435,9 @@ func BenchmarkRespond(b *testing.B) { } b.ResetTimer() api := API{} + api.InstallCodec(JSONCodec{}) for n := 0; n < b.N; n++ { - api.respond(&testResponseWriter, response, nil) + api.respond(&testResponseWriter, request, response, nil) } } @@ -3623,6 +3549,23 @@ func TestGetGlobalURL(t *testing.T) { } } +type testCodec struct { + contentType MIMEType + canEncode bool +} + +func (t *testCodec) ContentType() MIMEType { + return t.contentType +} + +func (t *testCodec) CanEncode(_ *Response) bool { + return t.canEncode +} + +func (t *testCodec) Encode(_ *Response) ([]byte, error) { + return []byte(fmt.Sprintf("response from %v codec", t.contentType)), nil +} + func TestExtractQueryOpts(t *testing.T) { tests := []struct { name string diff --git a/web/api/v1/codec.go b/web/api/v1/codec.go new file mode 100644 index 0000000000..492e00a74a --- /dev/null +++ b/web/api/v1/codec.go @@ -0,0 +1,53 @@ +// Copyright 2016 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 v1 + +import "github.com/munnerz/goautoneg" + +// A Codec performs encoding of API responses. +type Codec interface { + // ContentType returns the MIME time that this Codec emits. + ContentType() MIMEType + + // CanEncode determines if this Codec can encode resp. + CanEncode(resp *Response) bool + + // Encode encodes resp, ready for transmission to an API consumer. + Encode(resp *Response) ([]byte, error) +} + +type MIMEType struct { + Type string + SubType string +} + +func (m MIMEType) String() string { + return m.Type + "/" + m.SubType +} + +func (m MIMEType) Satisfies(accept goautoneg.Accept) bool { + if accept.Type == "*" && accept.SubType == "*" { + return true + } + + if accept.Type == m.Type && accept.SubType == "*" { + return true + } + + if accept.Type == m.Type && accept.SubType == m.SubType { + return true + } + + return false +} diff --git a/web/api/v1/codec_test.go b/web/api/v1/codec_test.go new file mode 100644 index 0000000000..911bf206e3 --- /dev/null +++ b/web/api/v1/codec_test.go @@ -0,0 +1,68 @@ +// Copyright 2016 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 v1 + +import ( + "testing" + + "github.com/munnerz/goautoneg" + "github.com/stretchr/testify/require" +) + +func TestMIMEType_String(t *testing.T) { + m := MIMEType{Type: "application", SubType: "json"} + + require.Equal(t, "application/json", m.String()) +} + +func TestMIMEType_Satisfies(t *testing.T) { + m := MIMEType{Type: "application", SubType: "json"} + + scenarios := map[string]struct { + accept goautoneg.Accept + expected bool + }{ + "exact match": { + accept: goautoneg.Accept{Type: "application", SubType: "json"}, + expected: true, + }, + "sub-type wildcard match": { + accept: goautoneg.Accept{Type: "application", SubType: "*"}, + expected: true, + }, + "full wildcard match": { + accept: goautoneg.Accept{Type: "*", SubType: "*"}, + expected: true, + }, + "inverted": { + accept: goautoneg.Accept{Type: "json", SubType: "application"}, + expected: false, + }, + "inverted sub-type wildcard": { + accept: goautoneg.Accept{Type: "json", SubType: "*"}, + expected: false, + }, + "complete mismatch": { + accept: goautoneg.Accept{Type: "text", SubType: "plain"}, + expected: false, + }, + } + + for name, scenario := range scenarios { + t.Run(name, func(t *testing.T) { + actual := m.Satisfies(scenario.accept) + require.Equal(t, scenario.expected, actual) + }) + } +} diff --git a/web/api/v1/json_codec.go b/web/api/v1/json_codec.go new file mode 100644 index 0000000000..62e7563b1b --- /dev/null +++ b/web/api/v1/json_codec.go @@ -0,0 +1,219 @@ +// Copyright 2016 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 v1 + +import ( + "unsafe" + + jsoniter "github.com/json-iterator/go" + + "github.com/prometheus/prometheus/model/exemplar" + "github.com/prometheus/prometheus/promql" + "github.com/prometheus/prometheus/util/jsonutil" +) + +func init() { + jsoniter.RegisterTypeEncoderFunc("promql.Series", marshalSeriesJSON, marshalSeriesJSONIsEmpty) + jsoniter.RegisterTypeEncoderFunc("promql.Sample", marshalSampleJSON, marshalSampleJSONIsEmpty) + jsoniter.RegisterTypeEncoderFunc("promql.FPoint", marshalFPointJSON, marshalPointJSONIsEmpty) + jsoniter.RegisterTypeEncoderFunc("promql.HPoint", marshalHPointJSON, marshalPointJSONIsEmpty) + jsoniter.RegisterTypeEncoderFunc("exemplar.Exemplar", marshalExemplarJSON, marshalExemplarJSONEmpty) +} + +// JSONCodec is a Codec that encodes API responses as JSON. +type JSONCodec struct{} + +func (j JSONCodec) ContentType() MIMEType { + return MIMEType{Type: "application", SubType: "json"} +} + +func (j JSONCodec) CanEncode(_ *Response) bool { + return true +} + +func (j JSONCodec) Encode(resp *Response) ([]byte, error) { + json := jsoniter.ConfigCompatibleWithStandardLibrary + return json.Marshal(resp) +} + +// marshalSeriesJSON writes something like the following: +// +// { +// "metric" : { +// "__name__" : "up", +// "job" : "prometheus", +// "instance" : "localhost:9090" +// }, +// "values": [ +// [ 1435781451.781, "1" ], +// < more values> +// ], +// "histograms": [ +// [ 1435781451.781, { < histogram, see jsonutil.MarshalHistogram > } ], +// < more histograms > +// ], +// }, +func marshalSeriesJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { + s := *((*promql.Series)(ptr)) + stream.WriteObjectStart() + stream.WriteObjectField(`metric`) + m, err := s.Metric.MarshalJSON() + if err != nil { + stream.Error = err + return + } + stream.SetBuffer(append(stream.Buffer(), m...)) + + for i, p := range s.Floats { + stream.WriteMore() + if i == 0 { + stream.WriteObjectField(`values`) + stream.WriteArrayStart() + } + marshalFPointJSON(unsafe.Pointer(&p), stream) + } + if len(s.Floats) > 0 { + stream.WriteArrayEnd() + } + for i, p := range s.Histograms { + stream.WriteMore() + if i == 0 { + stream.WriteObjectField(`histograms`) + stream.WriteArrayStart() + } + marshalHPointJSON(unsafe.Pointer(&p), stream) + } + if len(s.Histograms) > 0 { + stream.WriteArrayEnd() + } + stream.WriteObjectEnd() +} + +func marshalSeriesJSONIsEmpty(unsafe.Pointer) bool { + return false +} + +// marshalSampleJSON writes something like the following for normal value samples: +// +// { +// "metric" : { +// "__name__" : "up", +// "job" : "prometheus", +// "instance" : "localhost:9090" +// }, +// "value": [ 1435781451.781, "1.234" ] +// }, +// +// For histogram samples, it writes something like this: +// +// { +// "metric" : { +// "__name__" : "up", +// "job" : "prometheus", +// "instance" : "localhost:9090" +// }, +// "histogram": [ 1435781451.781, { < histogram, see jsonutil.MarshalHistogram > } ] +// }, +func marshalSampleJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { + s := *((*promql.Sample)(ptr)) + stream.WriteObjectStart() + stream.WriteObjectField(`metric`) + m, err := s.Metric.MarshalJSON() + if err != nil { + stream.Error = err + return + } + stream.SetBuffer(append(stream.Buffer(), m...)) + stream.WriteMore() + if s.H == nil { + stream.WriteObjectField(`value`) + } else { + stream.WriteObjectField(`histogram`) + } + stream.WriteArrayStart() + jsonutil.MarshalTimestamp(s.T, stream) + stream.WriteMore() + if s.H == nil { + jsonutil.MarshalFloat(s.F, stream) + } else { + jsonutil.MarshalHistogram(s.H, stream) + } + stream.WriteArrayEnd() + stream.WriteObjectEnd() +} + +func marshalSampleJSONIsEmpty(unsafe.Pointer) bool { + return false +} + +// marshalFPointJSON writes `[ts, "1.234"]`. +func marshalFPointJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { + p := *((*promql.FPoint)(ptr)) + stream.WriteArrayStart() + jsonutil.MarshalTimestamp(p.T, stream) + stream.WriteMore() + jsonutil.MarshalFloat(p.F, stream) + stream.WriteArrayEnd() +} + +// marshalHPointJSON writes `[ts, { < histogram, see jsonutil.MarshalHistogram > } ]`. +func marshalHPointJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { + p := *((*promql.HPoint)(ptr)) + stream.WriteArrayStart() + jsonutil.MarshalTimestamp(p.T, stream) + stream.WriteMore() + jsonutil.MarshalHistogram(p.H, stream) + stream.WriteArrayEnd() +} + +func marshalPointJSONIsEmpty(unsafe.Pointer) bool { + return false +} + +// marshalExemplarJSON writes. +// +// { +// labels: , +// value: "", +// timestamp: +// } +func marshalExemplarJSON(ptr unsafe.Pointer, stream *jsoniter.Stream) { + p := *((*exemplar.Exemplar)(ptr)) + stream.WriteObjectStart() + + // "labels" key. + stream.WriteObjectField(`labels`) + lbls, err := p.Labels.MarshalJSON() + if err != nil { + stream.Error = err + return + } + stream.SetBuffer(append(stream.Buffer(), lbls...)) + + // "value" key. + stream.WriteMore() + stream.WriteObjectField(`value`) + jsonutil.MarshalFloat(p.Value, stream) + + // "timestamp" key. + stream.WriteMore() + stream.WriteObjectField(`timestamp`) + jsonutil.MarshalTimestamp(p.Ts, stream) + + stream.WriteObjectEnd() +} + +func marshalExemplarJSONEmpty(unsafe.Pointer) bool { + return false +} diff --git a/web/api/v1/json_codec_test.go b/web/api/v1/json_codec_test.go new file mode 100644 index 0000000000..6b97b55e57 --- /dev/null +++ b/web/api/v1/json_codec_test.go @@ -0,0 +1,178 @@ +// Copyright 2016 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 v1 + +import ( + "math" + "testing" + + "github.com/prometheus/prometheus/model/exemplar" + "github.com/prometheus/prometheus/model/histogram" + "github.com/prometheus/prometheus/model/labels" + "github.com/prometheus/prometheus/promql" + "github.com/prometheus/prometheus/promql/parser" +) + +func TestJsonCodec_Encode(t *testing.T) { + cases := []struct { + response interface{} + expected string + }{ + { + response: &QueryData{ + ResultType: parser.ValueTypeMatrix, + Result: promql.Matrix{ + promql.Series{ + Floats: []promql.FPoint{{F: 1, T: 1000}}, + Metric: labels.FromStrings("__name__", "foo"), + }, + }, + }, + expected: `{"status":"success","data":{"resultType":"matrix","result":[{"metric":{"__name__":"foo"},"values":[[1,"1"]]}]}}`, + }, + { + response: &QueryData{ + ResultType: parser.ValueTypeMatrix, + Result: promql.Matrix{ + promql.Series{ + Histograms: []promql.HPoint{{H: &histogram.FloatHistogram{ + Schema: 2, + ZeroThreshold: 0.001, + ZeroCount: 12, + Count: 10, + Sum: 20, + PositiveSpans: []histogram.Span{ + {Offset: 3, Length: 2}, + {Offset: 1, Length: 3}, + }, + NegativeSpans: []histogram.Span{ + {Offset: 2, Length: 2}, + }, + PositiveBuckets: []float64{1, 2, 2, 1, 1}, + NegativeBuckets: []float64{2, 1}, + }, T: 1000}}, + Metric: labels.FromStrings("__name__", "foo"), + }, + }, + }, + expected: `{"status":"success","data":{"resultType":"matrix","result":[{"metric":{"__name__":"foo"},"histograms":[[1,{"count":"10","sum":"20","buckets":[[1,"-1.6817928305074288","-1.414213562373095","1"],[1,"-1.414213562373095","-1.189207115002721","2"],[3,"-0.001","0.001","12"],[0,"1.414213562373095","1.6817928305074288","1"],[0,"1.6817928305074288","2","2"],[0,"2.378414230005442","2.82842712474619","2"],[0,"2.82842712474619","3.3635856610148576","1"],[0,"3.3635856610148576","4","1"]]}]]}]}}`, + }, + { + response: promql.FPoint{F: 0, T: 0}, + expected: `{"status":"success","data":[0,"0"]}`, + }, + { + response: promql.FPoint{F: 20, T: 1}, + expected: `{"status":"success","data":[0.001,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: 10}, + expected: `{"status":"success","data":[0.010,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: 100}, + expected: `{"status":"success","data":[0.100,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: 1001}, + expected: `{"status":"success","data":[1.001,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: 1010}, + expected: `{"status":"success","data":[1.010,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: 1100}, + expected: `{"status":"success","data":[1.100,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: 12345678123456555}, + expected: `{"status":"success","data":[12345678123456.555,"20"]}`, + }, + { + response: promql.FPoint{F: 20, T: -1}, + expected: `{"status":"success","data":[-0.001,"20"]}`, + }, + { + response: promql.FPoint{F: math.NaN(), T: 0}, + expected: `{"status":"success","data":[0,"NaN"]}`, + }, + { + response: promql.FPoint{F: math.Inf(1), T: 0}, + expected: `{"status":"success","data":[0,"+Inf"]}`, + }, + { + response: promql.FPoint{F: math.Inf(-1), T: 0}, + expected: `{"status":"success","data":[0,"-Inf"]}`, + }, + { + response: promql.FPoint{F: 1.2345678e6, T: 0}, + expected: `{"status":"success","data":[0,"1234567.8"]}`, + }, + { + response: promql.FPoint{F: 1.2345678e-6, T: 0}, + expected: `{"status":"success","data":[0,"0.0000012345678"]}`, + }, + { + response: promql.FPoint{F: 1.2345678e-67, T: 0}, + expected: `{"status":"success","data":[0,"1.2345678e-67"]}`, + }, + { + response: []exemplar.QueryResult{ + { + SeriesLabels: labels.FromStrings("foo", "bar"), + Exemplars: []exemplar.Exemplar{ + { + Labels: labels.FromStrings("traceID", "abc"), + Value: 100.123, + Ts: 1234, + }, + }, + }, + }, + expected: `{"status":"success","data":[{"seriesLabels":{"foo":"bar"},"exemplars":[{"labels":{"traceID":"abc"},"value":"100.123","timestamp":1.234}]}]}`, + }, + { + response: []exemplar.QueryResult{ + { + SeriesLabels: labels.FromStrings("foo", "bar"), + Exemplars: []exemplar.Exemplar{ + { + Labels: labels.FromStrings("traceID", "abc"), + Value: math.Inf(1), + Ts: 1234, + }, + }, + }, + }, + expected: `{"status":"success","data":[{"seriesLabels":{"foo":"bar"},"exemplars":[{"labels":{"traceID":"abc"},"value":"+Inf","timestamp":1.234}]}]}`, + }, + } + + codec := JSONCodec{} + + for _, c := range cases { + body, err := codec.Encode(&Response{ + Status: statusSuccess, + Data: c.response, + }) + if err != nil { + t.Fatalf("Error encoding response body: %s", err) + } + + if string(body) != c.expected { + t.Fatalf("Expected response \n%v\n but got \n%v\n", c.expected, string(body)) + } + } +}