golang有用的庫及工具 之 zap.Logger包的使用指南
更新時間：2020年12月16日 12:04:30 作者：逆月林
這篇文章主要介紹了golang有用的庫及工具 之 zap.Logger包的使用指南，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
zap.Logger 是go語言中相對日志庫中性能最高的。那么如何開始使用？
不多說直接上代碼：
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
// 日志級別 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成長之路：使用Zap來做日志服務
我們在項目中，經(jīng)常會記錄一些數(shù)據(jù)信息到文件中，或者日志文件。
例如nginx會有nginx訪問請求日志，使用golang的時候，我也想做一個這樣的訪問日志，所以我就找到了go的一個開源高效的日志庫zap。
很多人也使用logrus或者go自帶的Logger(支持的東西太少，性能一般)，具體為啥最后選擇了zap，是因為很多人說zap性能更高些，當然我自己沒有測試過。
1、安裝zap
go get -u go.uber.org/zap
如果沒反應，可能需要配置下代理，
go env -w GOPROXY=https://goproxy.cn
然后在執(zhí)行安裝的命令。
2、簡單實例（默認配置）
Zap提供了兩種類型的日志記錄器—Sugared Logger和Logger。
package main
import (
"go.uber.org/zap"
"time"
)
func main() {
// zap.NewDevelopment 格式化輸出
logger, _ := zap.NewDevelopment()
defer logger.Sync()
logger.Info("測試",
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("測試",
zap.String("url", "http://www.baidu.com"),
zap.Int("attempt", 3),
zap.Duration("backoff", time.Second),
)
}
3、自定義配置
封裝好一個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, //時間格式
EncodeDuration: zapcore.SecondsDurationEncoder,
EncodeCaller: zapcore.FullCallerEncoder, // 全路徑編碼器
}
// 設置日志級別（默認info級別，可以根據(jù)需要設置級別）
atom := zap.NewAtomicLevelAt(zap.InfoLevel)
config := zap.Config{
Level: atom, // 日志級別
Development: true, // 開發(fā)模式，堆棧跟蹤
Encoding: "json", // 輸出格式 console 或 json
EncoderConfig: encoderConfig, // 編碼器配置
OutputPaths: []string{"stdout", '需要寫入文件的路徑'}, // 日志寫入文件的地址
ErrorOutputPaths: []string{"stderr", '需要寫入文件的路徑'}, // 將系統(tǒng)內的error記錄到文件的地址
}
// 構建日志
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配置說明
MessageKey：輸入信息的key名
LevelKey：輸出日志級別的key名
TimeKey：輸出時間的key名
NameKey CallerKey StacktraceKey跟以上類似，看名字就知道
LineEnding：每行的分隔符。基本zapcore.DefaultLineEnding 即"\n"
EncodeLevel：基本zapcore.LowercaseLevelEncoder。將日志級別字符串轉化為小寫
EncodeTime：輸出的時間格式
EncodeDuration：一般zapcore.SecondsDurationEncoder,執(zhí)行消耗的時間轉化成浮點型的秒
EncodeCaller：一般zapcore.ShortCallerEncoder，以包/文件:行號 格式化調用堆棧
EncodeName：可選值。
使用案例
package main
import (
"logger"http://導入寫好的包（具體需要改為自己寫的路徑）
)
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使用方法，希望能給大家一個參考，也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方，望不吝賜教。
相關文章
排序算法是在生活中隨處可見，也是算法基礎，因為其實現(xiàn)代碼較短,應用較常見。所以在面試中經(jīng)常會問到排序算法及其相關的問題。本文為大家整理了一些Go語言中常用排序算法的實現(xiàn)，需要的可以參考一下2022-08-08
golang使用sync.Once實現(xiàn)懶加載的用法和坑點詳解
這篇文章主要為大家詳細介紹了golang使用sync.Once實現(xiàn)懶加載的用法和坑點,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2023-11-11
這篇文章主要為大家介紹了實用的Go語言開發(fā)工具及使用示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-06-06
在Go編程中,上下文（context）是一個非常重要的概念,它包含了與請求相關的信息,本文主要來和大家討論一下如何在并發(fā)計算中使用上下文,感興趣的可以了解下2024-02-02
Go?Error?嵌套實現(xiàn)創(chuàng)建方式
這篇文章主要介紹了Go?Error?嵌套到底是怎么實現(xiàn)的？大家都知道創(chuàng)建error有兩種方式分別是errors.new（）另一種是fmt.errorf（），本文通過詳細例子給大家介紹，需要的朋友可以參考下2022-01-01
這篇文章主要介紹了Go語言中的iota關鍵字的使用的相關資料,需要的朋友可以參考下2023-08-08
這篇文章主要為大家介紹了Go語言開發(fā)之快速學習CGO編程，看了本文你就會發(fā)現(xiàn)CGO編程其實沒有想象的那么難，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-04-04
這篇文章主要介紹了使用Gomock進行單元測試的方法示例，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-11-11
Go語言中有緩沖的通道是一種在被接收前能存儲一個或者多個值的通道,本文就來介紹一下Go語言帶緩沖的通道的使用,具有一定的參考價值,感興趣的可以了解一下2024-01-01
本文主要介紹了sublime3+Golang+代碼補全的實現(xiàn)，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-01-01