golang有用的庫(kù)及工具 之 zap.Logger包的使用指南
更新時(shí)間：2020年12月16日 12:04:30 作者：逆月林
這篇文章主要介紹了golang有用的庫(kù)及工具 之 zap.Logger包的使用指南，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧
zap.Logger 是go語(yǔ)言中相對(duì)日志庫(kù)中性能最高的。那么如何開(kāi)始使用？
不多說(shuō)直接上代碼：
import (
"encoding/json"
"fmt"
"log"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var Logger *zap.Logger
func InitLogger() {
// 日志地址 "out.log" 自定義
lp := Conf.Common.LogPath
// 日志級(jí)別 DEBUG,ERROR, INFO
lv := Conf.Common.LogLevel
// 是否 DEBUG
isDebug := true
if Conf.Common.IsDebug != true {
isDebug = false
}
initLogger(lp, lv, isDebug)
log.SetFlags(log.Lmicroseconds | log.Lshortfile | log.LstdFlags)
}
func initLogger(lp string, lv string, isDebug bool) {
var js string
if isDebug {
js = fmt.Sprintf(`{
"level": "%s",
"encoding": "json",
"outputPaths": ["stdout"],
"errorOutputPaths": ["stdout"]
}`, lv)
} else {
js = fmt.Sprintf(`{
"level": "%s",
"encoding": "json",
"outputPaths": ["%s"],
"errorOutputPaths": ["%s"]
}`, lv, lp, lp)
}
var cfg zap.Config
if err := json.Unmarshal([]byte(js), &cfg); err != nil {
panic(err)
}
cfg.EncoderConfig = zap.NewProductionEncoderConfig()
cfg.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
var err error
Logger, err = cfg.Build()
if err != nil {
log.Fatal("init logger error: ", err)
}
}
如何使用：
func TestInitLogger(t *testing.T) {
InitLogger("out.log", "DEBUG", false)
s := []string{
"hello info",
"hello error",
"hello debug",
"hello fatal",
}
Log.Info("info:", zap.String("s", s[0]))
Log.Error("info:", zap.String("s", s[1]))
Log.Debug("info:", zap.String("s", s[2]))
Log.Fatal("info:", zap.String("s", s[3]))
}
輸出：
{"level":"info","ts":"2017-10-25 13:45:42.332","caller":"logger/logger_test.go:16","msg":"info:","s":"hello info"}
{"level":"error","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:17","msg":"info:","s":"hello error","stacktrace":"go.uber.org/zap.Stack\n\tD:/gopath/src/go.uber.org/zap/field.go:191\ngo.uber.org/zap.(*Logger).check\n\tD:/gopath/src/go.uber.org/zap/logger.go:301\ngo.uber.org/zap.(*Logger).Error\n\tD:/gopath/src/go.uber.org/zap/logger.go:202\ngithub.com/corego/hermes/logger.TestInitLogger\n\tD:/gopath/src/github.com/corego/hermes/logger/logger_test.go:17\ntesting.tRunner\n\tD:/Program Files (x86)/go/src/testing/testing.go:746"}
{"level":"debug","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:18","msg":"info:","s":"hello debug"}
{"level":"fatal","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:19","msg":"info:","s":"hello fatal","stacktrace":"go.uber.org/zap.Stack\n\tD:/gopath/src/go.uber.org/zap/field.go:191\ngo.uber.org/zap.(*Logger).check\n\tD:/gopath/src/go.uber.org/zap/logger.go:301\ngo.uber.org/zap.(*Logger).Fatal\n\tD:/gopath/src/go.uber.org/zap/logger.go:235\ngithub.com/corego/hermes/logger.TestInitLogger\n\tD:/gopath/src/github.com/corego/hermes/logger/logger_test.go:19\ntesting.tRunner\n\tD:/Program Files (x86)/go/src/testing/testing.go:746"}
拓展：Golang成長(zhǎng)之路：使用Zap來(lái)做日志服務(wù)
我們?cè)陧?xiàng)目中，經(jīng)常會(huì)記錄一些數(shù)據(jù)信息到文件中，或者日志文件。
例如nginx會(huì)有nginx訪問(wèn)請(qǐng)求日志，使用golang的時(shí)候，我也想做一個(gè)這樣的訪問(wèn)日志，所以我就找到了go的一個(gè)開(kāi)源高效的日志庫(kù)zap。
很多人也使用logrus或者go自帶的Logger(支持的東西太少，性能一般)，具體為啥最后選擇了zap，是因?yàn)楹芏嗳苏f(shuō)zap性能更高些，當(dāng)然我自己沒(méi)有測(cè)試過(guò)。
1、安裝zap
go get -u go.uber.org/zap
如果沒(méi)反應(yīng)，可能需要配置下代理，
go env -w GOPROXY=https://goproxy.cn
然后在執(zhí)行安裝的命令。
2、簡(jiǎn)單實(shí)例（默認(rèn)配置）
Zap提供了兩種類型的日志記錄器—Sugared Logger和Logger。
package main
import (
"go.uber.org/zap"
"time"
)
func main() {
// zap.NewDevelopment 格式化輸出
logger, _ := zap.NewDevelopment()
defer logger.Sync()
logger.Info("測(cè)試",
zap.String("url", "http://www.baidu.com"),
zap.Int("attempt", 3),
zap.Duration("backoff", time.Second),
)
// zap.NewProduction json序列化輸出
logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Info("測(cè)試",
zap.String("url", "http://www.baidu.com"),
zap.Int("attempt", 3),
zap.Duration("backoff", time.Second),
)
}
3、自定義配置
封裝好一個(gè)logger包
package logger
import (
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"time"
"fmt"
)
var sugarLogger *zap.SugaredLogger
//格式化日期
func formatEncodeTime(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
enc.AppendString(fmt.Sprintf("%d-%02d-%02d %02d:%02d:%02d", t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second()))
}
func InitConfig() *zap.SugaredLogger {
encoderConfig := zapcore.EncoderConfig{
TimeKey: "ts",
LevelKey: "level",
NameKey: "logger",
CallerKey: "caller",
MessageKey: "msg",
StacktraceKey: "stacktrace",
LineEnding: zapcore.DefaultLineEnding,
EncodeLevel: zapcore.LowercaseLevelEncoder, // 小寫編碼器
EncodeTime: formatEncodeTime, //時(shí)間格式
EncodeDuration: zapcore.SecondsDurationEncoder,
EncodeCaller: zapcore.FullCallerEncoder, // 全路徑編碼器
}
// 設(shè)置日志級(jí)別（默認(rèn)info級(jí)別，可以根據(jù)需要設(shè)置級(jí)別）
atom := zap.NewAtomicLevelAt(zap.InfoLevel)
config := zap.Config{
Level: atom, // 日志級(jí)別
Development: true, // 開(kāi)發(fā)模式，堆棧跟蹤
Encoding: "json", // 輸出格式 console 或 json
EncoderConfig: encoderConfig, // 編碼器配置
OutputPaths: []string{"stdout", '需要寫入文件的路徑'}, // 日志寫入文件的地址
ErrorOutputPaths: []string{"stderr", '需要寫入文件的路徑'}, // 將系統(tǒng)內(nèi)的error記錄到文件的地址
}
// 構(gòu)建日志
logger, _ := config.Build()
sugarLogger = logger.Sugar()
return sugarLogger
}
func Debug(args ...interface{}) {
sugarLogger.Debug(args...)
}
func Debugf(template string, args ...interface{}) {
sugarLogger.Debugf(template, args...)
}
func Info(args ...interface{}) {
sugarLogger.Info(args...)
}
func Infof(template string, args ...interface{}) {
sugarLogger.Infof(template, args...)
}
func Infow(template string, args ...interface{}) {
sugarLogger.Infow(template, args...)
}
func Warn(args ...interface{}) {
sugarLogger.Warn(args...)
}
func Warnf(template string, args ...interface{}) {
sugarLogger.Warnf(template, args...)
}
func Error(args ...interface{}) {
sugarLogger.Error(args...)
}
func Errorf(template string, args ...interface{}) {
sugarLogger.Errorf(template, args...)
}
func DPanic(args ...interface{}) {
sugarLogger.DPanic(args...)
}
func DPanicf(template string, args ...interface{}) {
sugarLogger.DPanicf(template, args...)
}
func Panic(args ...interface{}) {
sugarLogger.Panic(args...)
}
func Panicf(template string, args ...interface{}) {
sugarLogger.Panicf(template, args...)
}
func Fatal(args ...interface{}) {
sugarLogger.Fatal(args...)
}
func Fatalf(template string, args ...interface{}) {
sugarLogger.Fatalf(template, args...)
}
EncoderConfig配置說(shuō)明
MessageKey：輸入信息的key名
LevelKey：輸出日志級(jí)別的key名
TimeKey：輸出時(shí)間的key名
NameKey CallerKey StacktraceKey跟以上類似，看名字就知道
LineEnding：每行的分隔符?；緕apcore.DefaultLineEnding 即"\n"
EncodeLevel：基本zapcore.LowercaseLevelEncoder。將日志級(jí)別字符串轉(zhuǎn)化為小寫
EncodeTime：輸出的時(shí)間格式
EncodeDuration：一般zapcore.SecondsDurationEncoder,執(zhí)行消耗的時(shí)間轉(zhuǎn)化成浮點(diǎn)型的秒
EncodeCaller：一般zapcore.ShortCallerEncoder，以包/文件:行號(hào) 格式化調(diào)用堆棧
EncodeName：可選值。
使用案例
package main
import (
"logger"http://導(dǎo)入寫好的包（具體需要改為自己寫的路徑）
)
func main() {
//初始化日志配置
logger.InitConfig()
//寫入文件
logger.Infow("access_log",
"code", 200,
"ip", 192.168.1.1,
"Method", "POST",
"url", "www.baidu.com",
"latencyTime(ms)", 1000,
)
}
好了，這就是自己搗鼓的zap使用方法，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教。
相關(guān)文章
Go語(yǔ)言實(shí)現(xiàn)常用排序算法的示例代碼
排序算法是在生活中隨處可見(jiàn)，也是算法基礎(chǔ)，因?yàn)槠鋵?shí)現(xiàn)代碼較短,應(yīng)用較常見(jiàn)。所以在面試中經(jīng)常會(huì)問(wèn)到排序算法及其相關(guān)的問(wèn)題。本文為大家整理了一些Go語(yǔ)言中常用排序算法的實(shí)現(xiàn)，需要的可以參考一下2022-08-08
golang使用sync.Once實(shí)現(xiàn)懶加載的用法和坑點(diǎn)詳解
這篇文章主要為大家詳細(xì)介紹了golang使用sync.Once實(shí)現(xiàn)懶加載的用法和坑點(diǎn),文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-11-11
實(shí)用的Go語(yǔ)言開(kāi)發(fā)工具及使用示例
這篇文章主要為大家介紹了實(shí)用的Go語(yǔ)言開(kāi)發(fā)工具及使用示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-06-06
詳解Go語(yǔ)言如何利用上下文進(jìn)行并發(fā)計(jì)算
在Go編程中,上下文（context）是一個(gè)非常重要的概念,它包含了與請(qǐng)求相關(guān)的信息,本文主要來(lái)和大家討論一下如何在并發(fā)計(jì)算中使用上下文,感興趣的可以了解下2024-02-02
Go?Error?嵌套實(shí)現(xiàn)創(chuàng)建方式
這篇文章主要介紹了Go?Error?嵌套到底是怎么實(shí)現(xiàn)的？大家都知道創(chuàng)建error有兩種方式分別是errors.new（）另一種是fmt.errorf（），本文通過(guò)詳細(xì)例子給大家介紹，需要的朋友可以參考下2022-01-01
這篇文章主要介紹了Go語(yǔ)言中的iota關(guān)鍵字的使用的相關(guān)資料,需要的朋友可以參考下2023-08-08
Go語(yǔ)言開(kāi)發(fā)快速學(xué)習(xí)CGO編程
這篇文章主要為大家介紹了Go語(yǔ)言開(kāi)發(fā)之快速學(xué)習(xí)CGO編程，看了本文你就會(huì)發(fā)現(xiàn)CGO編程其實(shí)沒(méi)有想象的那么難，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-04-04
這篇文章主要介紹了使用Gomock進(jìn)行單元測(cè)試的方法示例，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-11-11
Go語(yǔ)言中有緩沖的通道是一種在被接收前能存儲(chǔ)一個(gè)或者多個(gè)值的通道,本文就來(lái)介紹一下Go語(yǔ)言帶緩沖的通道的使用,具有一定的參考價(jià)值,感興趣的可以了解一下2024-01-01
sublime3+Golang+代碼補(bǔ)全的實(shí)現(xiàn)
本文主要介紹了sublime3+Golang+代碼補(bǔ)全的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01