sdk/go/httpserver/logger.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package httpserver
   6
   7 import (
   8         "context"
   9         "net/http"
  10         "time"
  11
  12         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  13         "git.arvados.org/arvados.git/sdk/go/stats"
  14         "github.com/sirupsen/logrus"
  15 )
  16
  17 type contextKey struct {
  18         name string
  19 }
  20
  21 var (
  22         requestTimeContextKey = contextKey{"requestTime"}
  23 )
  24
  25 // HandlerWithContext returns an http.Handler that changes the request
  26 // context to ctx (replacing http.Server's default
  27 // context.Background()), then calls next.
  28 func HandlerWithContext(ctx context.Context, next http.Handler) http.Handler {
  29         return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  30                 next.ServeHTTP(w, r.WithContext(ctx))
  31         })
  32 }
  33
  34 // LogRequests wraps an http.Handler, logging each request and
  35 // response.
  36 func LogRequests(h http.Handler) http.Handler {
  37         return http.HandlerFunc(func(wrapped http.ResponseWriter, req *http.Request) {
  38                 w := &responseTimer{ResponseWriter: WrapResponseWriter(wrapped)}
  39                 lgr := ctxlog.FromContext(req.Context()).WithFields(logrus.Fields{
  40                         "RequestID":       req.Header.Get("X-Request-Id"),
  41                         "remoteAddr":      req.RemoteAddr,
  42                         "reqForwardedFor": req.Header.Get("X-Forwarded-For"),
  43                         "reqMethod":       req.Method,
  44                         "reqHost":         req.Host,
  45                         "reqPath":         req.URL.Path[1:],
  46                         "reqQuery":        req.URL.RawQuery,
  47                         "reqBytes":        req.ContentLength,
  48                 })
  49                 ctx := req.Context()
  50                 ctx = context.WithValue(ctx, &requestTimeContextKey, time.Now())
  51                 ctx = ctxlog.Context(ctx, lgr)
  52                 req = req.WithContext(ctx)
  53
  54                 logRequest(w, req, lgr)
  55                 defer logResponse(w, req, lgr)
  56                 h.ServeHTTP(rewrapResponseWriter(w, wrapped), req)
  57         })
  58 }
  59
  60 // Rewrap w to restore additional interfaces provided by wrapped.
  61 func rewrapResponseWriter(w http.ResponseWriter, wrapped http.ResponseWriter) http.ResponseWriter {
  62         if hijacker, ok := wrapped.(http.Hijacker); ok {
  63                 return struct {
  64                         http.ResponseWriter
  65                         http.Hijacker
  66                 }{w, hijacker}
  67         } else {
  68                 return w
  69         }
  70 }
  71
  72 func Logger(req *http.Request) logrus.FieldLogger {
  73         return ctxlog.FromContext(req.Context())
  74 }
  75
  76 func logRequest(w *responseTimer, req *http.Request, lgr *logrus.Entry) {
  77         lgr.Info("request")
  78 }
  79
  80 func logResponse(w *responseTimer, req *http.Request, lgr *logrus.Entry) {
  81         if tStart, ok := req.Context().Value(&requestTimeContextKey).(time.Time); ok {
  82                 tDone := time.Now()
  83                 writeTime := w.writeTime
  84                 if !w.wrote {
  85                         // Empty response body. Header was sent when
  86                         // handler exited.
  87                         writeTime = tDone
  88                 }
  89                 lgr = lgr.WithFields(logrus.Fields{
  90                         "timeTotal":     stats.Duration(tDone.Sub(tStart)),
  91                         "timeToStatus":  stats.Duration(writeTime.Sub(tStart)),
  92                         "timeWriteBody": stats.Duration(tDone.Sub(writeTime)),
  93                 })
  94         }
  95         respCode := w.WroteStatus()
  96         if respCode == 0 {
  97                 respCode = http.StatusOK
  98         }
  99         fields := logrus.Fields{
 100                 "respStatusCode": respCode,
 101                 "respStatus":     http.StatusText(respCode),
 102                 "respBytes":      w.WroteBodyBytes(),
 103         }
 104         if respCode >= 400 {
 105                 fields["respBody"] = string(w.Sniffed())
 106         }
 107         lgr.WithFields(fields).Info("response")
 108 }
 109
 110 type responseTimer struct {
 111         ResponseWriter
 112         wrote     bool
 113         writeTime time.Time
 114 }
 115
 116 func (rt *responseTimer) CloseNotify() <-chan bool {
 117         if cn, ok := rt.ResponseWriter.(http.CloseNotifier); ok {
 118                 return cn.CloseNotify()
 119         }
 120         return nil
 121 }
 122
 123 func (rt *responseTimer) WriteHeader(code int) {
 124         if !rt.wrote {
 125                 rt.wrote = true
 126                 rt.writeTime = time.Now()
 127         }
 128         rt.ResponseWriter.WriteHeader(code)
 129 }
 130
 131 func (rt *responseTimer) Write(p []byte) (int, error) {
 132         if !rt.wrote {
 133                 rt.wrote = true
 134                 rt.writeTime = time.Now()
 135         }
 136         return rt.ResponseWriter.Write(p)
 137 }