logrus日志自定義格式操作
由于最近開始做一些go寫的外圍程序,因此開始關(guān)注go的日志,畢竟自帶的logger模塊功能較少。簡(jiǎn)單看了一些資料以后最開始使用seelog,性能感覺(jué)也不錯(cuò),可以通過(guò)配置文件做很多額外處理。
但是由于協(xié)程的使用,需要日志標(biāo)明協(xié)程號(hào)來(lái)方便日志查詢請(qǐng)求應(yīng)答。在一番嘗試以后仍然沒(méi)有解決,只能看看有沒(méi)有其他日志庫(kù)備選,因此選擇了logrus(github上同類星星最多)
其實(shí)一開始看介紹時(shí)就看見過(guò)logrus這個(gè)庫(kù),但是之所以沒(méi)有一開始考慮它, 是因?yàn)樵S多介紹都說(shuō)它無(wú)法顯示文件名和行號(hào)。不過(guò)時(shí)代是發(fā)展的,現(xiàn)在的logrus版本已經(jīng)支持該設(shè)置。
logrus的基本使用這里就不再多說(shuō)了,可以移步 http://www.dbjr.com.cn/article/168799.htm
1)設(shè)置行號(hào)
log.SetReportCaller(true) log.WithFields(log.Fields{"animal": "walrus"}).Info("A walrus appears") time="2020-03-29T15:58:09+08:00" level=info msg="A walrus appears" func=main.main file="F:/workspace/go/src/test/main.go:12" animal=walrus
設(shè)置行號(hào)通過(guò)SetRportCaller實(shí)現(xiàn),但是發(fā)現(xiàn)一個(gè)問(wèn)題默認(rèn)的設(shè)置file是全路徑的,這樣實(shí)際在日志中輸出的話,日志會(huì)有很多無(wú)用數(shù)據(jù),針對(duì)于我自己的需求僅為需要提示go文件名以及行號(hào)和goid即可。
2)自定義格式
logrus提供了SetFormatter可以設(shè)置格式,logrus自帶的格式為(JSONFormatter,TextFormatter)
func (s *LogFormatter) Format(entry *log.Entry) ([]byte, error) { timestamp := //日期格式實(shí)現(xiàn) entry.Caller //調(diào)用者信息 entry.Data //withfiled方式傳入的數(shù)據(jù) msg := 自己想要的格式輸出內(nèi)容 return []byte(msg), nil } func main() { log.SetFormatter(new(LogFormatter)) //注冊(cè)自定義格式 }
自定義格式可選取的素材是log.Entry中提供的,具體了解需要自行查看源碼,這里僅簡(jiǎn)單介紹。其中Caller是調(diào)用信息,有文件名,函數(shù)名,行數(shù)等信息,但是需要注意的是如果沒(méi)有設(shè)置SetRportCaller為true,這里無(wú)法獲取改信息。
entry.Data信息為WithFields傳入的map,如果需要一定的范式輸出的話,可以好好利用。此外獲取當(dāng)前協(xié)程號(hào)也是在該函數(shù)中實(shí)現(xiàn)的,具體可以看文末的范例。定義完成后需要注冊(cè)自定義格式。
3)日志寫入文件
logrus默認(rèn)是標(biāo)準(zhǔn)輸出, SetOutput方法可以更換輸出io,設(shè)置文件句柄就是寫入文件了。網(wǎng)上能找到很多通過(guò)改寫io.write或者h(yuǎn)ook的方式拆分文件,推送文件等等其他各種需要,總之非常強(qiáng)大,不過(guò)我因?yàn)闆](méi)有試過(guò),所以就不在本文中描述了。但是統(tǒng)一項(xiàng)目的日志都是在指定目錄按日期目錄存放的,因此需要實(shí)現(xiàn)io.write,針對(duì)日期來(lái)劃分文件。
package gotools import ( "bytes" "errors" "fmt" "os" "path/filepath" "runtime" "strconv" "strings" "time" log "github.com/sirupsen/logrus" ) //日志自定義格式 type LogFormatter struct{} //格式詳情 func (s *LogFormatter) Format(entry *log.Entry) ([]byte, error) { timestamp := time.Now().Local().Format("0102-150405.000") var file string var len int if entry.Caller != nil { file = filepath.Base(entry.Caller.File) len = entry.Caller.Line } //fmt.Println(entry.Data) msg := fmt.Sprintf("%s [%s:%d][GOID:%d][%s] %s\n", timestamp, file, len, getGID(), strings.ToUpper(entry.Level.String()), entry.Message) return []byte(msg), nil } func getGID() uint64 { b := make([]byte, 64) b = b[:runtime.Stack(b, false)] b = bytes.TrimPrefix(b, []byte("goroutine ")) b = b[:bytes.IndexByte(b, ' ')] n, _ := strconv.ParseUint(string(b), 10, 64) return n } type logFileWriter struct { file *os.File logPath string fileDate string //判斷日期切換目錄 appName string encoding string } func (p *logFileWriter) Write(data []byte) (n int, err error) { if p == nil { return 0, errors.New("logFileWriter is nil") } if p.file == nil { return 0, errors.New("file not opened") } //判斷是否需要切換日期 fileDate := time.Now().Format("20060102") if p.fileDate != fileDate { p.file.Close() err = os.MkdirAll(fmt.Sprintf("%s/%s", p.logPath, fileDate), os.ModePerm) if err != nil { return 0, err } filename := fmt.Sprintf("%s/%s/%s-%s.log", p.logPath, fileDate, p.appName, fileDate) p.file, err = os.OpenFile(filename, os.O_WRONLY|os.O_APPEND|os.O_CREATE|os.O_SYNC, 0600) if err != nil { return 0, err } } if p.encoding != "" { dataToEncode := ConvertStringToByte(string(data), p.encoding) n, e := p.file.Write(dataToEncode) return n, e } n, e := p.file.Write(data) return n, e } //初始化日志 func InitLog(logPath string, appName string, encoding string) { fileDate := time.Now().Format("20060102") //創(chuàng)建目錄 err := os.MkdirAll(fmt.Sprintf("%s/%s", logPath, fileDate), os.ModePerm) if err != nil { log.Error(err) return } filename := fmt.Sprintf("%s/%s/%s-%s.log", logPath, fileDate, appName, fileDate) file, err := os.OpenFile(filename, os.O_WRONLY|os.O_APPEND|os.O_CREATE|os.O_SYNC, 0600) if err != nil { log.Error(err) return } fileWriter := logFileWriter{file, logPath, fileDate, appName, encoding} log.SetOutput(&fileWriter) log.SetReportCaller(true) log.SetFormatter(new(LogFormatter)) }
package main import ( log "github.com/sirupsen/logrus" "sand.com/gotools" ) func main() { gotools.InitLog("./log/", "test", "gb18030") log.WithFields(log.Fields{"animal": "walrus"}).Info("A walrus appears") log.Info("測(cè)試中文") }
因?yàn)槠渌到y(tǒng)的日志都是gbk編碼的,因此在io.write時(shí)做了編碼轉(zhuǎn)換,如果沒(méi)有這樣需要的話最好不要做這種轉(zhuǎn)換影響性能
0329-163148.199 [main.go:11][GOID:1][INFO] A walrus appears
0329-163148.199 [main.go:12][GOID:1][INFO] 測(cè)試中文
補(bǔ)充知識(shí): go使用logrus同時(shí)輸出屏幕和文件日志
我就廢話不多說(shuō)了,大家還是直接看代碼吧~
func InitLog() { //設(shè)置輸出樣式,自帶的只有兩種樣式logrus.JSONFormatter{}和logrus.TextFormatter{} log.SetFormatter(&log.TextFormatter{}) log.SetOutput(os.Stdout) //設(shè)置output,默認(rèn)為stderr,可以為任何io.Writer,比如文件*os.File file, err := os.OpenFile("checkemstools.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666) writers := []io.Writer{ file, os.Stdout} //同時(shí)寫文件和屏幕 fileAndStdoutWriter := io.MultiWriter(writers...) if err == nil { log.SetOutput(fileAndStdoutWriter) } else { log.Info("failed to log to file.") } //設(shè)置最低loglevel log.SetLevel(log.InfoLevel) }
以上這篇logrus日志自定義格式操作就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
Go?實(shí)現(xiàn)?WebSockets之創(chuàng)建?WebSockets
這篇文章主要介紹了Go?實(shí)現(xiàn)?WebSockets之創(chuàng)建?WebSockets,文章主要探索?WebSockets,并簡(jiǎn)要介紹了它們的工作原理,并仔細(xì)研究了全雙工通信,想了解更多相關(guān)內(nèi)容的小伙伴可以參考一下2022-04-04分析Go錯(cuò)誤處理優(yōu)化go?recover機(jī)制缺陷
這篇文章主要為大家介紹了分析Go錯(cuò)誤處理優(yōu)化go?recover機(jī)制缺陷示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-07-07golang中值類型/指針類型的變量區(qū)別總結(jié)
golang的值類型和指針類型receiver一直是大家比較混淆的地方,下面這篇文章主要給大家總結(jié)介紹了關(guān)于golang中值類型/指針類型的變量區(qū)別的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考下。2017-12-12深入解析快速排序算法的原理及其Go語(yǔ)言版實(shí)現(xiàn)
這篇文章主要介紹了快速排序算法的原理及其Go語(yǔ)言版實(shí)現(xiàn),文中對(duì)于快速算法的過(guò)程和效率有較為詳細(xì)的說(shuō)明,需要的朋友可以參考下2016-04-04Go語(yǔ)言實(shí)現(xiàn)類似c++中的多態(tài)功能實(shí)例
Go本身不具有多態(tài)的特性,不能夠像Java、C++那樣編寫多態(tài)類、多態(tài)方法。但是,使用Go可以編寫具有多態(tài)功能的類綁定的方法。下面來(lái)一起看看吧2016-09-09