錯誤日誌和訪問日誌是一個服務器必須支持的功能，我們教程裏使用的服務器到目前爲止還沒有這兩個功能。正好前兩天也寫了篇介紹 logrus 日誌庫的文章，那麼今天的文章裏就給我們自己寫的服務器加上錯誤日誌和訪問日誌的功能。在介紹添加訪問日誌的時候會介紹一種通過編寫中間件獲取 HTTP 響應的 StausCode 和 Body 的方法。

Go Web 編程系列的每篇文章的源代碼都打了對應版本的軟件包，供大家參考。公衆號中回覆 gohttp11 獲取本文源代碼

初始化日誌記錄器

我們先來做一下初始化工作，在項目裏初始化記錄錯誤日誌和訪問日誌的記錄器 Logger 。 

// ./utils/vlog
package vlog

import (
    "github.com/sirupsen/logrus"
    "os"
)

var ErrorLog *logrus.Logger
var AccessLog *logrus.Logger
var errorLogFile = "./tmp/log/error.log"
var accessLogFile = "./tmp/log/access.log"
func init () {
    initErrorLog()
    initAccessLog()
}

func initErrorLog() {
    ErrorLog = logrus.New()
    ErrorLog.SetFormatter(&logrus.JSONFormatter{})
    file , err := os.OpenFile(errorLogFile, os.O_RDWR | os.O_CREATE | os.O_APPEND, 0755)
    if err != nil {
        panic(err)
    }
    ErrorLog.SetOutput(file)
}

func initAccessLog() {
    AccessLog = logrus.New()
    AccessLog.SetFormatter(&logrus.JSONFormatter{})
    file , err := os.OpenFile(accessLogFile, os.O_RDWR | os.O_CREATE | os.O_APPEND, 0755)
    if err != nil {
        panic(err)
    }
    AccessLog.SetOutput(file)
}
  • 我們新定義一個 package 在 init 函數中來初始化記錄器，這樣服務器成功啓動前就會初始化好記錄器。
  • /tmp/log 這個目錄要提前創建好，執行 init 函數時會自動創建好 access.log 和 error.log 。

添加錯誤日誌

我們創建服務器使用的 net/http 包的 Server 類型中，有一個 ErrorLog 字段供開發者設置記錄錯誤日誌用的記錄器 Logger ，默認使用的是 log 包默認的記錄器（應該是系統的標準錯誤）： 

type Server struct {
   Addr    string  // TCP address to listen on, ":http" if empty
   Handler Handler // handler to invoke, http.DefaultServeMux if nil
   ...
   // ErrorLog specifies an optional logger for errors accepting
   // connections, unexpected behavior from handlers, and
   // underlying FileSystem errors.
   // If nil, logging is done via the log package's standard logger.
   ErrorLog *log.Logger
     ...
}

我們之前在創建服務器的時候自己實現了 Server 類型的對象，那麼現在要做的就是將上面初始化好的錯誤日誌的記錄器指定給 Server 的 ErrorLog 字段。 

func main() {
  ...
  // 將`logrus`的Logger轉換爲io.Writer
    errorWriter := vlog.ErrorLog.Writer()
  // 記得關閉io.Writer
    defer errorWriter.Close()

    server := &http.Server{
        Addr:    ":8080",
        Handler: muxRouter,
    // 用記錄器轉換成的io.Writer創建log.Logger
        ErrorLog: log.New(vlog.ErrorLog.Writer(), "", 0),
    }
    ...
}

添加好錯誤日誌的記錄器後，我們找個路由處理函數，在裏面故意製造運行時錯誤驗證一下是否能記錄到錯誤。

func (*HelloHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
   ints := []int{0, 1, 2}
   fmt.Fprintf(w, "%v", ints[0:5])
}

在上面處理函數中，通過切片表達式越界故意製造了一個運行時錯誤，打開 error.log 後能看到文件裏已經記錄到這個運行時錯誤及其 Stack trace

添加訪問日誌

和 Server 對象可以設置錯誤日誌的記錄器不一樣，訪問日誌只能是我們通過自己編寫中間件的方式來實現了。在記錄訪問日誌的中間件裏我們會記錄 ip ， method ， path ， query ， request_body ， status 和 response_body 這些個字段的內容。

status 和 response_body 兩個字段來自請求對應的響應。響應在 net/http 包裏是用 http.ResponseWriter 接口表示的 

type ResponseWriter interface {
    Header() Header

    Write([]byte) (int, error)

    WriteHeader(statusCode int)
}

接口本身以及 net/http 提供的實現都沒有讓我們進行讀取的方法，所以在編寫的用於記錄訪問日誌的中間件裏需要對 net/http 庫本身實現的 ResponseWriter 做一層包裝。

利用 Go 語言結構體類型嵌套匿名類型後，結構體擁有了被嵌套類型的所有導出字段和方法的特性，我們可以很方便地對原來的 ResponseWriter 做一層包裝，然後只重新實現需要更改的方法即可： 

type ResponseWithRecorder struct {
   http.ResponseWriter
   statusCode int
   body bytes.Buffer
}

func (rec *ResponseWithRecorder) WriteHeader(statusCode int) {
   rec.ResponseWriter.WriteHeader(statusCode)
   rec.statusCode = statusCode
}

func (rec *ResponseWithRecorder) Write(d []byte) (n int, err error) {
   n, err = rec.ResponseWriter.Write(d)
   if err != nil {
      return
   }
   rec.body.Write(d)

   return
}

定義好新的類型後我們重新實現了 WriteHeader 和 Write 方法，在向原來的 ReponseWriter 中寫入後也會向 ResponseWriteRecoder.statusCode 和 ResponseWriteRecoder.body 寫入對應的數據。這樣我們就可以在中間件裏通過這兩個字段訪問響應碼和響應數據了。

記錄訪問日誌的中間件定義如下：

func AccessLogging (f http.Handler) http.Handler {

    // 創建一個新的handler包裝http.HandlerFunc
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        buf := new(bytes.Buffer)
        buf.ReadFrom(r.Body)
        logEntry := vlog.AccessLog.WithFields(logrus.Fields{
            "ip": r.RemoteAddr,
            "method": r.Method,
            "path": r.RequestURI,
            "query": r.URL.RawQuery,
            "request_body": buf.String(),

        })

        wc := &ResponseWithRecorder{
            ResponseWriter: w,
            statusCode: http.StatusOK,
            body: bytes.Buffer{},
        }

        // 調用下一個中間件或者最終的handler處理程序
        f.ServeHTTP(wc, r)

        defer logEntry.WithFields(logrus.Fields{
            "status": wc.statusCode,
            "response_body": wc.body.String(),
        }).Info()

    })
}

在 Router 上應用創建好的 AccessLogging 中間件後，就可以正常的記錄服務器的訪問日誌了。 

// router/router.go
func RegisterRoutes(r *mux.Router) {
    ...
    // apply Logging middleware
    r.Use(middleware.Logging(), middleware.AccessLogging)
    ...
}

不過有兩點需要注意一下

  • 這裏爲了演示獲取響應數據記錄了 response_body 字段，如果是接口響應內容記錄下還可以，但是如果是 HTML 還是不記錄的爲好。
  • 初始化 ResponseWithRecorder 時默認設置了 statusCode 時因爲，服務器正確返回響應時不會顯式調用 WriteHeader 方法，只有在返回 NOT_FOUND 之類的錯誤的時候纔會調用 WriteHeader 方法，針對這種情況需要在初始化的時候把 statusCode 的默認值設置爲 200 。

現在再訪問服務器後打開 access.log 會看到剛剛的訪問日誌，就能看到剛剛請求的 url ， method ，客戶端IP等信息了。 

{"ip":"......","level":"info","method":"GET","msg":"","path":"/index/","query":"","request_body":"","response_body":"Hello World1","status":200,"time":"2020-03-26T04:21:46Z"}

注意：文章只爲說明演示方便，獲取IP的方法無法獲取代理後的真實IP，請悉知。

相關文章