Add a static handler for buildinfo static API (#5009)

* add a roundtripper for buildinfo static API

Signed-off-by: Ben Ye <[email protected]>

* use static handler rather than tripperware

Signed-off-by: Ben Ye <[email protected]>

Signed-off-by: Ben Ye <[email protected]>

Author: yeya24

pkg/api/api.go

@@ -366,6 +366,7 @@ func (a *API) RegisterQueryable(
 
 // RegisterQueryAPI registers the Prometheus API routes with the provided handler.
 func (a *API) RegisterQueryAPI(handler http.Handler) {
+	infoHandler := &buildInfoHandler{logger: a.logger}
 	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/read"), handler, true, "POST")
 	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/query"), handler, true, "GET", "POST")
 	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/query_range"), handler, true, "GET", "POST")
@@ -374,7 +375,7 @@ func (a *API) RegisterQueryAPI(handler http.Handler) {
 	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/label/{name}/values"), handler, true, "GET")
 	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/series"), handler, true, "GET", "POST", "DELETE")
 	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/metadata"), handler, true, "GET")
-	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/status/buildinfo"), handler, true, "GET")
+	a.RegisterRoute(path.Join(a.cfg.PrometheusHTTPPrefix, "/api/v1/status/buildinfo"), infoHandler, true, "GET")
 
 	// Register Legacy Routers
 	a.RegisterRoute(path.Join(a.cfg.LegacyHTTPPrefix, "/api/v1/read"), handler, true, "POST")
@@ -385,7 +386,7 @@ func (a *API) RegisterQueryAPI(handler http.Handler) {
 	a.RegisterRoute(path.Join(a.cfg.LegacyHTTPPrefix, "/api/v1/label/{name}/values"), handler, true, "GET")
 	a.RegisterRoute(path.Join(a.cfg.LegacyHTTPPrefix, "/api/v1/series"), handler, true, "GET", "POST", "DELETE")
 	a.RegisterRoute(path.Join(a.cfg.LegacyHTTPPrefix, "/api/v1/metadata"), handler, true, "GET")
-	a.RegisterRoute(path.Join(a.cfg.LegacyHTTPPrefix, "/api/v1/status/buildinfo"), handler, true, "GET")
+	a.RegisterRoute(path.Join(a.cfg.LegacyHTTPPrefix, "/api/v1/status/buildinfo"), infoHandler, true, "GET")
 }
 
 // RegisterQueryFrontend registers the Prometheus routes supported by the

pkg/api/handlers.go

@@ -2,12 +2,14 @@ package api
 
 import (
 	"context"
+	"encoding/json"
 	"html/template"
 	"net/http"
 	"path"
 	"sync"
 
 	"github.com/go-kit/log"
+	"github.com/go-kit/log/level"
 	"github.com/gorilla/mux"
 	"github.com/grafana/regexp"
 	"github.com/pkg/errors"
@@ -282,3 +284,36 @@ func NewQuerierHandler(
 	// Track execution time.
 	return stats.NewWallTimeMiddleware().Wrap(router)
 }
+
+type buildInfoHandler struct {
+	logger log.Logger
+}
+
+type buildInfoResponse struct {
+	Status string                `json:"status"`
+	Data   *v1.PrometheusVersion `json:"data"`
+}
+
+func (h *buildInfoHandler) ServeHTTP(writer http.ResponseWriter, _ *http.Request) {
+	infoResponse := buildInfoResponse{
+		Status: "success",
+		Data: &v1.PrometheusVersion{
+			Version:   version.Version,
+			Branch:    version.Branch,
+			Revision:  version.Revision,
+			BuildUser: version.BuildUser,
+			BuildDate: version.BuildDate,
+			GoVersion: version.GoVersion,
+		},
+	}
+	output, err := json.Marshal(infoResponse)
+	if err != nil {
+		level.Error(h.logger).Log("msg", "marshal build info response", "error", err)
+		http.Error(writer, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	writer.WriteHeader(http.StatusOK)
+	if _, err := writer.Write(output); err != nil {
+		level.Error(h.logger).Log("msg", "write build info response", "error", err)
+	}
+}

pkg/cortex/modules.go

@@ -448,7 +448,6 @@ func (t *Cortex) initQueryFrontendTripperware() (serv services.Service, err erro
 	}
 
 	instantQueryMiddlewares, err := instantquery.Middlewares(util_log.Logger, t.Overrides)
-
 	if err != nil {
 		return nil, err
 	}

pkg/querier/tripperware/queryrange/query_range_middlewares_test.go

@@ -50,6 +50,7 @@ func TestRoundTrip(t *testing.T) {
 		nil,
 		nil,
 	)
+	require.NoError(t, err)
 
 	tw := tripperware.NewQueryTripperware(log.NewNopLogger(),
 		nil,
@@ -60,10 +61,6 @@ func TestRoundTrip(t *testing.T) {
 		nil,
 	)
 
-	if err != nil {
-		t.Fatal(err)
-	}
-
 	for i, tc := range []struct {
 		path, expectedBody string
 	}{

pkg/querier/tripperware/roundtrip.go

@@ -122,6 +122,7 @@ func NewQueryTripperware(
 			return RoundTripFunc(func(r *http.Request) (*http.Response, error) {
 				isQuery := strings.HasSuffix(r.URL.Path, "/query")
 				isQueryRange := strings.HasSuffix(r.URL.Path, "/query_range")
+
 				op := "query"
 				if isQueryRange {
 					op = "query_range"

pkg/querier/tripperware/roundtrip_test.go

@@ -95,10 +95,6 @@ func TestRoundTrip(t *testing.T) {
 		mockCodec{},
 	)
 
-	if err != nil {
-		t.Fatal(err)
-	}
-
 	for _, tc := range []struct {
 		path, expectedBody string
 	}{