X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/df591042778408d03d410d5c22a669d85652d1ea..9e806b0c387cf7146e0d0cf3169fd227963c19b9:/sdk/go/httpserver/logger.go diff --git a/sdk/go/httpserver/logger.go b/sdk/go/httpserver/logger.go index 569931a3ed..78a1f77adb 100644 --- a/sdk/go/httpserver/logger.go +++ b/sdk/go/httpserver/logger.go @@ -1,6 +1,6 @@ // Copyright (C) The Arvados Authors. All rights reserved. // -// SPDX-License-Identifier: AGPL-3.0 +// SPDX-License-Identifier: Apache-2.0 package httpserver @@ -9,38 +9,69 @@ import ( "net/http" "time" - "git.curoverse.com/arvados.git/sdk/go/stats" - "github.com/Sirupsen/logrus" + "git.arvados.org/arvados.git/sdk/go/ctxlog" + "git.arvados.org/arvados.git/sdk/go/stats" + "github.com/sirupsen/logrus" ) type contextKey struct { name string } -var requestTimeContextKey = contextKey{"requestTime"} +var ( + requestTimeContextKey = contextKey{"requestTime"} +) -var Logger logrus.FieldLogger = logrus.StandardLogger() +// HandlerWithContext returns an http.Handler that changes the request +// context to ctx (replacing http.Server's default +// context.Background()), then calls next. +func HandlerWithContext(ctx context.Context, next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + next.ServeHTTP(w, r.WithContext(ctx)) + }) +} // LogRequests wraps an http.Handler, logging each request and -// response via logrus. +// response. func LogRequests(h http.Handler) http.Handler { return http.HandlerFunc(func(wrapped http.ResponseWriter, req *http.Request) { w := &responseTimer{ResponseWriter: WrapResponseWriter(wrapped)} - req = req.WithContext(context.WithValue(req.Context(), &requestTimeContextKey, time.Now())) - lgr := Logger.WithFields(logrus.Fields{ + lgr := ctxlog.FromContext(req.Context()).WithFields(logrus.Fields{ "RequestID": req.Header.Get("X-Request-Id"), "remoteAddr": req.RemoteAddr, "reqForwardedFor": req.Header.Get("X-Forwarded-For"), "reqMethod": req.Method, + "reqHost": req.Host, "reqPath": req.URL.Path[1:], + "reqQuery": req.URL.RawQuery, "reqBytes": req.ContentLength, }) + ctx := req.Context() + ctx = context.WithValue(ctx, &requestTimeContextKey, time.Now()) + ctx = ctxlog.Context(ctx, lgr) + req = req.WithContext(ctx) + logRequest(w, req, lgr) defer logResponse(w, req, lgr) - h.ServeHTTP(w, req) + h.ServeHTTP(rewrapResponseWriter(w, wrapped), req) }) } +// Rewrap w to restore additional interfaces provided by wrapped. +func rewrapResponseWriter(w http.ResponseWriter, wrapped http.ResponseWriter) http.ResponseWriter { + if hijacker, ok := wrapped.(http.Hijacker); ok { + return struct { + http.ResponseWriter + http.Hijacker + }{w, hijacker} + } + return w +} + +func Logger(req *http.Request) logrus.FieldLogger { + return ctxlog.FromContext(req.Context()) +} + func logRequest(w *responseTimer, req *http.Request, lgr *logrus.Entry) { lgr.Info("request") } @@ -48,21 +79,31 @@ func logRequest(w *responseTimer, req *http.Request, lgr *logrus.Entry) { func logResponse(w *responseTimer, req *http.Request, lgr *logrus.Entry) { if tStart, ok := req.Context().Value(&requestTimeContextKey).(time.Time); ok { tDone := time.Now() + writeTime := w.writeTime + if !w.wrote { + // Empty response body. Header was sent when + // handler exited. + writeTime = tDone + } lgr = lgr.WithFields(logrus.Fields{ "timeTotal": stats.Duration(tDone.Sub(tStart)), - "timeToStatus": stats.Duration(w.writeTime.Sub(tStart)), - "timeWriteBody": stats.Duration(tDone.Sub(w.writeTime)), + "timeToStatus": stats.Duration(writeTime.Sub(tStart)), + "timeWriteBody": stats.Duration(tDone.Sub(writeTime)), }) } respCode := w.WroteStatus() if respCode == 0 { respCode = http.StatusOK } - lgr.WithFields(logrus.Fields{ + fields := logrus.Fields{ "respStatusCode": respCode, "respStatus": http.StatusText(respCode), "respBytes": w.WroteBodyBytes(), - }).Info("response") + } + if respCode >= 400 { + fields["respBody"] = string(w.Sniffed()) + } + lgr.WithFields(fields).Info("response") } type responseTimer struct {