由于最近開始做一些go寫的外圍程序,因此開始關注go的日志,畢竟自帶的logger模塊功能較少。簡單看了一些資料以后最開始使用seelog,性能感覺也不錯,可以通過配置文件做很多額外處理。
但是由于協程的使用,需要日志標明協程號來方便日志查詢請求應答。在一番嘗試以后仍然沒有解決,只能看看有沒有其他日志庫備選,因此選擇了logrus(github上同類星星最多)
其實一開始看介紹時就看見過logrus這個庫,但是之所以沒有一開始考慮它, 是因為許多介紹都說它無法顯示文件名和行號。不過時代是發展的,現在的logrus版本已經支持該設置。
logrus的基本使用這里就不再多說了,可以移步 http://www.ythuaji.com.cn/article/69876.html
1)設置行號
1
2
3
4
5
|
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 |
設置行號通過SetRportCaller實現,但是發現一個問題默認的設置file是全路徑的,這樣實際在日志中輸出的話,日志會有很多無用數據,針對于我自己的需求僅為需要提示go文件名以及行號和goid即可。
2)自定義格式
logrus提供了SetFormatter可以設置格式,logrus自帶的格式為(JSONFormatter,TextFormatter)
1
2
3
4
5
6
7
8
9
10
11
|
func (s *LogFormatter) Format(entry *log.Entry) ([]byte, error) { timestamp := //日期格式實現 entry.Caller //調用者信息 entry.Data //withfiled方式傳入的數據 msg := 自己想要的格式輸出內容 return []byte(msg), nil } func main() { log.SetFormatter(new(LogFormatter)) //注冊自定義格式 } |
自定義格式可選取的素材是log.Entry中提供的,具體了解需要自行查看源碼,這里僅簡單介紹。其中Caller是調用信息,有文件名,函數名,行數等信息,但是需要注意的是如果沒有設置SetRportCaller為true,這里無法獲取改信息。
entry.Data信息為WithFields傳入的map,如果需要一定的范式輸出的話,可以好好利用。此外獲取當前協程號也是在該函數中實現的,具體可以看文末的范例。定義完成后需要注冊自定義格式。
3)日志寫入文件
logrus默認是標準輸出, SetOutput方法可以更換輸出io,設置文件句柄就是寫入文件了。網上能找到很多通過改寫io.write或者hook的方式拆分文件,推送文件等等其他各種需要,總之非常強大,不過我因為沒有試過,所以就不在本文中描述了。但是統一項目的日志都是在指定目錄按日期目錄存放的,因此需要實現io.write,針對日期來劃分文件。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
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") //創建目錄 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)) } |
1
2
3
4
5
6
7
8
9
10
11
12
13
|
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("測試中文") } |
因為其他系統的日志都是gbk編碼的,因此在io.write時做了編碼轉換,如果沒有這樣需要的話最好不要做這種轉換影響性能
0329-163148.199 [main.go:11][GOID:1][INFO] A walrus appears
0329-163148.199 [main.go:12][GOID:1][INFO] 測試中文
補充知識: go使用logrus同時輸出屏幕和文件日志
我就廢話不多說了,大家還是直接看代碼吧~
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
func InitLog() { //設置輸出樣式,自帶的只有兩種樣式logrus.JSONFormatter{}和logrus.TextFormatter{} log.SetFormatter(&log.TextFormatter{}) log.SetOutput(os.Stdout) //設置output,默認為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} //同時寫文件和屏幕 fileAndStdoutWriter := io.MultiWriter(writers...) if err == nil { log.SetOutput(fileAndStdoutWriter) } else { log.Info("failed to log to file.") } //設置最低loglevel log.SetLevel(log.InfoLevel) } |
以上這篇logrus日志自定義格式操作就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持服務器之家。
原文鏈接:https://blog.csdn.net/chen09122763/article/details/105179886