Add log request middleware for Querier (#700)

* Add log request middleware

Signed-off-by: hi-rustin <[email protected]>

* Use connect-go middleware

Signed-off-by: hi-rustin <[email protected]>

* Add tenantID,traceID and duration

Signed-off-by: hi-rustin <[email protected]>

* Add level

Signed-off-by: hi-rustin <[email protected]>

* Rename to anonymous

Signed-off-by: hi-rustin <[email protected]>

---------

Signed-off-by: hi-rustin <[email protected]>

Author: 0xPoe

pkg/api/api.go

@@ -40,6 +40,7 @@ import (
 	"github.com/grafana/phlare/pkg/querier"
 	"github.com/grafana/phlare/pkg/scheduler"
 	"github.com/grafana/phlare/pkg/scheduler/schedulerpb/schedulerpbconnect"
+	"github.com/grafana/phlare/pkg/util"
 	"github.com/grafana/phlare/pkg/util/gziphandler"
 	"github.com/grafana/phlare/pkg/validation/exporter"
 )
@@ -56,6 +57,7 @@ type API struct {
 	httpAuthMiddleware middleware.Interface
 	grpcGatewayMux     *grpcgw.ServeMux
 	grpcAuthMiddleware connect.Option
+	grpcLogMiddleware  connect.Option
 
 	cfg       Config
 	logger    log.Logger
@@ -71,6 +73,7 @@ func New(cfg Config, s *server.Server, grpcGatewayMux *grpcgw.ServeMux, logger l
 		indexPage:          NewIndexPageContent(),
 		grpcGatewayMux:     grpcGatewayMux,
 		grpcAuthMiddleware: cfg.GrpcAuthMiddleware,
+		grpcLogMiddleware:  connect.WithInterceptors(util.NewLogInterceptor(logger)),
 	}
 
 	// If no authentication middleware is present in the config, use the default authentication middleware.
@@ -217,7 +220,7 @@ func (a *API) RegisterRing(r http.Handler) {
 // RegisterQuerier registers the endpoints associated with the querier.
 func (a *API) RegisterQuerier(svc querierv1connect.QuerierServiceHandler) {
 	handlers := querier.NewHTTPHandlers(svc)
-	querierv1connect.RegisterQuerierServiceHandler(a.server.HTTP, svc, a.grpcAuthMiddleware)
+	querierv1connect.RegisterQuerierServiceHandler(a.server.HTTP, svc, a.grpcAuthMiddleware, a.grpcLogMiddleware)
 
 	a.RegisterRoute("/pyroscope/render", http.HandlerFunc(handlers.Render), true, true, "GET")
 	a.RegisterRoute("/pyroscope/render-diff", http.HandlerFunc(handlers.RenderDiff), true, true, "GET")

pkg/util/interceptor.go

@@ -5,6 +5,11 @@ import (
 	"time"
 
 	"github.com/bufbuild/connect-go"
+	"github.com/go-kit/log"
+	"github.com/go-kit/log/level"
+	"github.com/weaveworks/common/tracing"
+
+	"github.com/grafana/phlare/pkg/tenant"
 )
 
 type timeoutInterceptor struct {
@@ -39,3 +44,37 @@ func (s timeoutInterceptor) WrapStreamingHandler(next connect.StreamingHandlerFu
 		return next(ctx, shc)
 	})
 }
+
+// LogRequest logs the request parameters.
+// It logs all kinds of requests.
+func NewLogInterceptor(logger log.Logger) connect.UnaryInterceptorFunc {
+	interceptor := func(next connect.UnaryFunc) connect.UnaryFunc {
+		return connect.UnaryFunc(func(
+			ctx context.Context,
+			req connect.AnyRequest,
+		) (connect.AnyResponse, error) {
+			begin := time.Now()
+			tenantID, err := tenant.ExtractTenantIDFromContext(ctx)
+			if err != nil {
+				tenantID = "anonymous"
+			}
+			traceID, ok := tracing.ExtractTraceID(ctx)
+			if !ok {
+				traceID = "unknown"
+			}
+			defer func() {
+				level.Info(logger).Log(
+					"msg", "request parameters",
+					"route", req.Spec().Procedure,
+					"tenant", tenantID,
+					"traceID", traceID,
+					"parameters", req.Any(),
+					"duration", time.Since(begin),
+				)
+			}()
+
+			return next(ctx, req)
+		})
+	}
+	return connect.UnaryInterceptorFunc(interceptor)
+}