Go?Web編程添加服務(wù)器錯誤和訪問日志
前言
錯誤日志和訪問日志是一個服務(wù)器必須支持的功能,我們教程里使用的服務(wù)器到目前為止還沒有這兩個功能。正好前兩天也寫了篇介紹logrus
日志庫的文章,那么今天的文章里就給我們自己寫的服務(wù)器加上錯誤日志和訪問日志的功能。在介紹添加訪問日志的時候會介紹一種通過編寫中間件獲取HTTP
響應(yīng)的StausCode
和Body
的方法。
Go Web 編程系列的每篇文章的源代碼都打了對應(yīng)版本的軟件包,供大家參考。公眾號中回復(fù)gohttp11
獲取本文源代碼
初始化日志記錄器
我們先來做一下初始化工作,在項(xiàng)目里初始化記錄錯誤日志和訪問日志的記錄器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
函數(shù)中來初始化記錄器,這樣服務(wù)器成功啟動前就會初始化好記錄器。 /tmp/log
這個目錄要提前創(chuàng)建好,執(zhí)行init
函數(shù)時會自動創(chuàng)建好access.log
和error.log
。
添加錯誤日志
我們創(chuàng)建服務(wù)器使用的net/http
包的Server
類型中,有一個ErrorLog
字段供開發(fā)者設(shè)置記錄錯誤日志用的記錄器Logger
,默認(rèn)使用的是log
包默認(rèn)的記錄器(應(yīng)該是系統(tǒng)的標(biāo)準(zhǔn)錯誤):
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 ?????... }
我們之前在創(chuàng)建服務(wù)器的時候自己實(shí)現(xiàn)了Server
類型的對象,那么現(xiàn)在要做的就是將上面初始化好的錯誤日志的記錄器指定給Server
的ErrorLog
字段。
func?main()?{ ??... ? ??//?將logrus的Logger轉(zhuǎn)換為io.Writer ????errorWriter?:=?vlog.ErrorLog.Writer() ? ??//?記得關(guān)閉io.Writer ????defer?errorWriter.Close() ????server?:=?&http.Server{ ????????Addr:????":8080", ????????Handler:?muxRouter, ? ? ? ??//?用記錄器轉(zhuǎn)換成的io.Writer創(chuàng)建log.Logger ????????ErrorLog:?log.New(vlog.ErrorLog.Writer(),?"",?0), ????} ????... }
添加好錯誤日志的記錄器后,我們找個路由處理函數(shù),在里面故意制造運(yùn)行時錯誤驗(yàn)證一下是否能記錄到錯誤。
func?(*HelloHandler)?ServeHTTP(w?http.ResponseWriter,?r?*http.Request)?{ ???ints?:=?[]int{0,?1,?2} ???fmt.Fprintf(w,?"%v",?ints[0:5]) }
在上面處理函數(shù)中,通過切片表達(dá)式越界故意制造了一個運(yùn)行時錯誤,打開error.log
后能看到文件里已經(jīng)記錄到這個運(yùn)行時錯誤及其Stack trace
添加訪問日志
和Server
對象可以設(shè)置錯誤日志的記錄器不一樣,訪問日志只能是我們通過自己編寫中間件的方式來實(shí)現(xiàn)了。在記錄訪問日志的中間件里我們會記錄ip
,method
,path
,query
,request_body
,status
和response_body
這些個字段的內(nèi)容。
status
和response_body
兩個字段來自請求對應(yīng)的響應(yīng)。響應(yīng)在net/http
包里是用http.ResponseWriter
接口表示的
type?ResponseWriter?interface?{ ????Header()?Header ????Write([]byte)?(int,?error) ????WriteHeader(statusCode?int) }
接口本身以及net/http
提供的實(shí)現(xiàn)都沒有讓我們進(jìn)行讀取的方法,所以在編寫的用于記錄訪問日志的中間件里需要對net/http
庫本身實(shí)現(xiàn)的ResponseWriter
做一層包裝。
利用Go
語言結(jié)構(gòu)體類型嵌套匿名類型后,結(jié)構(gòu)體擁有了被嵌套類型的所有導(dǎo)出字段和方法的特性,我們可以很方便地對原來的ResponseWriter
做一層包裝,然后只重新實(shí)現(xiàn)需要更改的方法即可:
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 }
定義好新的類型后我們重新實(shí)現(xiàn)了WriteHeader
和Write
方法,在向原來的ReponseWriter
中寫入后也會向ResponseWriteRecoder.statusCode和ResponseWriteRecoder.body寫入對應(yīng)的數(shù)據(jù)。這樣我們就可以在中間件里通過這兩個字段訪問響應(yīng)碼和響應(yīng)數(shù)據(jù)了。
記錄訪問日志的中間件定義如下:
func?AccessLogging?(f?http.Handler)?http.Handler?{ ????//?創(chuàng)建一個新的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{}, ????????} ????????//?調(diào)用下一個中間件或者最終的handler處理程序 ????????f.ServeHTTP(wc,?r) ????????defer?logEntry.WithFields(logrus.Fields{ ????????????"status":?wc.statusCode, ????????????"response_body":?wc.body.String(), ????????}).Info() ????}) }
在Router
上應(yīng)用創(chuàng)建好的AccessLogging
中間件后,就可以正常的記錄服務(wù)器的訪問日志了。
//?router/router.go func?RegisterRoutes(r?*mux.Router)?{ ????... ????//?apply?Logging?middleware ????r.Use(middleware.Logging(),?middleware.AccessLogging) ????... }
不過有兩點(diǎn)需要注意一下
- 這里為了演示獲取響應(yīng)數(shù)據(jù)記錄了
response_body
字段,如果是接口響應(yīng)內(nèi)容記錄下還可以,但是如果是HTML
還是不記錄的為好。 - 初始化
ResponseWithRecorder
時默認(rèn)設(shè)置了statusCode
是因?yàn)?,服?wù)器正確返回響應(yīng)時不會顯式調(diào)用WriteHeader
方法,只有在返回NOT_FOUND
之類的錯誤的時候才會調(diào)用WriteHeader
方法,針對這種情況需要在初始化的時候把statusCode
的默認(rèn)值設(shè)置為200
。
現(xiàn)在再訪問服務(wù)器后打開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的方法無法獲取代理后的真實(shí)IP,請悉知。
以上就是Go Web編程添加服務(wù)器錯誤和訪問日志的詳細(xì)內(nèi)容,更多關(guān)于Go Web服務(wù)器錯誤訪問日志的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Go?實(shí)現(xiàn)?WebSockets之創(chuàng)建?WebSockets
這篇文章主要介紹了Go?實(shí)現(xiàn)?WebSockets之創(chuàng)建?WebSockets,文章主要探索?WebSockets,并簡要介紹了它們的工作原理,并仔細(xì)研究了全雙工通信,想了解更多相關(guān)內(nèi)容的小伙伴可以參考一下2022-04-04golang實(shí)現(xiàn)openssl自簽名雙向認(rèn)證的詳細(xì)步驟
這篇文章主要介紹了golang實(shí)現(xiàn)openssl自簽名雙向認(rèn)證的詳細(xì)步驟,本文分步驟給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友參考下吧2024-03-03Go語言學(xué)習(xí)之?dāng)?shù)組的用法詳解
數(shù)組是相同數(shù)據(jù)類型的一組數(shù)據(jù)的集合,數(shù)組一旦定義長度不能修改,數(shù)組可以通過下標(biāo)(或者叫索引)來訪問元素。本文將通過示例詳細(xì)講解Go語言中數(shù)組的使用,需要的可以參考一下2022-04-04Golang將Map的鍵值對調(diào)的實(shí)現(xiàn)示例
本文主要介紹了Golang將Map的鍵值對調(diào)的實(shí)現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-02-02Go到底能不能實(shí)現(xiàn)安全的雙檢鎖(推薦)
這篇文章主要介紹了Go到底能不能實(shí)現(xiàn)安全的雙檢鎖,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-05-05go浮點(diǎn)數(shù)轉(zhuǎn)字符串保留小數(shù)點(diǎn)后N位的完美解決方法
這篇文章主要介紹了go浮點(diǎn)數(shù)轉(zhuǎn)字符串保留小數(shù)點(diǎn)后N位解決辦法,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-05-05