Go Web程式設計新增伺服器錯誤和存取紀錄檔

2022-06-25 14:00:38

前言

錯誤紀錄檔和存取紀錄檔是一個伺服器必須支援的功能，我們教學裡使用的伺服器到目前為止還沒有這兩個功能。正好前兩天也寫了篇介紹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(&amp;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(&amp;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 := &amp;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 := &amp;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，請悉知。

以上就是Go Web程式設計新增伺服器錯誤和存取紀錄檔的詳細內容，更多關於Go Web伺服器錯誤存取紀錄檔的資料請關注it145.com其它相關文章！

Go Web程式設計新增伺服器錯誤和存取紀錄檔

目錄

前言

初始化紀錄檔記錄器

新增錯誤紀錄檔

新增存取紀錄檔

熱門文章