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.curoverse.com/arvados.git/sdk/go/stats"
  13         "github.com/Sirupsen/logrus"
  14 )
  15
  16 type contextKey struct {
  17         name string
  18 }
  19
  20 var requestTimeContextKey = contextKey{"requestTime"}
  21
  22 // LogRequests wraps an http.Handler, logging each request and
  23 // response via logger.
  24 func LogRequests(logger logrus.FieldLogger, h http.Handler) http.Handler {
  25         if logger == nil {
  26                 logger = logrus.StandardLogger()
  27         }
  28         return http.HandlerFunc(func(wrapped http.ResponseWriter, req *http.Request) {
  29                 w := &responseTimer{ResponseWriter: WrapResponseWriter(wrapped)}
  30                 req = req.WithContext(context.WithValue(req.Context(), &requestTimeContextKey, time.Now()))
  31                 lgr := logger.WithFields(logrus.Fields{
  32                         "RequestID":       req.Header.Get("X-Request-Id"),
  33                         "remoteAddr":      req.RemoteAddr,
  34                         "reqForwardedFor": req.Header.Get("X-Forwarded-For"),
  35                         "reqMethod":       req.Method,
  36                         "reqHost":         req.Host,
  37                         "reqPath":         req.URL.Path[1:],
  38                         "reqQuery":        req.URL.RawQuery,
  39                         "reqBytes":        req.ContentLength,
  40                 })
  41                 logRequest(w, req, lgr)
  42                 defer logResponse(w, req, lgr)
  43                 h.ServeHTTP(w, req)
  44         })
  45 }
  46
  47 func logRequest(w *responseTimer, req *http.Request, lgr *logrus.Entry) {
  48         lgr.Info("request")
  49 }
  50
  51 func logResponse(w *responseTimer, req *http.Request, lgr *logrus.Entry) {
  52         if tStart, ok := req.Context().Value(&requestTimeContextKey).(time.Time); ok {
  53                 tDone := time.Now()
  54                 lgr = lgr.WithFields(logrus.Fields{
  55                         "timeTotal":     stats.Duration(tDone.Sub(tStart)),
  56                         "timeToStatus":  stats.Duration(w.writeTime.Sub(tStart)),
  57                         "timeWriteBody": stats.Duration(tDone.Sub(w.writeTime)),
  58                 })
  59         }
  60         respCode := w.WroteStatus()
  61         if respCode == 0 {
  62                 respCode = http.StatusOK
  63         }
  64         lgr.WithFields(logrus.Fields{
  65                 "respStatusCode": respCode,
  66                 "respStatus":     http.StatusText(respCode),
  67                 "respBytes":      w.WroteBodyBytes(),
  68         }).Info("response")
  69 }
  70
  71 type responseTimer struct {
  72         ResponseWriter
  73         wrote     bool
  74         writeTime time.Time
  75 }
  76
  77 func (rt *responseTimer) CloseNotify() <-chan bool {
  78         if cn, ok := rt.ResponseWriter.(http.CloseNotifier); ok {
  79                 return cn.CloseNotify()
  80         }
  81         return nil
  82 }
  83
  84 func (rt *responseTimer) WriteHeader(code int) {
  85         if !rt.wrote {
  86                 rt.wrote = true
  87                 rt.writeTime = time.Now()
  88         }
  89         rt.ResponseWriter.WriteHeader(code)
  90 }
  91
  92 func (rt *responseTimer) Write(p []byte) (int, error) {
  93         if !rt.wrote {
  94                 rt.wrote = true
  95                 rt.writeTime = time.Now()
  96         }
  97         return rt.ResponseWriter.Write(p)
  98 }