golang高性能日志庫zap配置示例

zap是uber開源的Go高性能日志庫，gitlab地址

安裝

go get -u go.uber.org/zap

請注意，zap僅支持兩個最新的Go版本。

示例

簡單示例

格式化輸出

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),
    )
}

格式化輸出打印結果：

2019-01-02T15:01:13.923+0800    INFO    spikeProxy/main.go:17   failed to fetch URL {"url": "http://www.baidu.com", "attempt": 3, "backoff": "1s"}

json 序列化輸出

package main

import (
    "go.uber.org/zap"
    "time"
)

func main() {
   // 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),
    )
}

json序列化輸出打印結果：

{"level":"info","ts":1546413239.1466308,"caller":"spikeProxy/main.go:16","msg":"無法獲取網址","url":"http://www.baidu.com","attempt":3,"backoff":1}

自定義示例

選擇一個日志庫除了高性能是考量的一個標准，高擴展也非常重要，例如：json key 自定義、時間格式化、日志級別等。

package main

import (
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
    "fmt"
    "time"
)

func main() {
    encoderConfig := zapcore.EncoderConfig{
        TimeKey:        "time",
        LevelKey:       "level",
        NameKey:        "logger",
        CallerKey:      "caller",
        MessageKey:     "msg",
        StacktraceKey:  "stacktrace",
        LineEnding:     zapcore.DefaultLineEnding,
        EncodeLevel:    zapcore.LowercaseLevelEncoder,  // 小寫編碼器
        EncodeTime:     zapcore.ISO8601TimeEncoder,     // ISO8601 UTC 時間格式
        EncodeDuration: zapcore.SecondsDurationEncoder,
        EncodeCaller:   zapcore.FullCallerEncoder,      // 全路徑編碼器
    }

    // 設置日志級別
    atom := zap.NewAtomicLevelAt(zap.DebugLevel)

    config := zap.Config{
        Level:            atom,                                                // 日志級別
        Development:      true,                                                // 開發模式，堆棧跟蹤
        Encoding:         "json",                                              // 輸出格式 console 或 json
        EncoderConfig:    encoderConfig,                                       // 編碼器配置
        InitialFields:    map[string]interface{}{"serviceName": "spikeProxy"}, // 初始化字段，如：添加一個服務器名稱
        OutputPaths:      []string{"stdout", "./logs/spikeProxy.log"},         // 輸出到指定文件 stdout（標准輸出，正常顏色） stderr（錯誤輸出，紅色）
        ErrorOutputPaths: []string{"stderr"},
    }

    // 構建日志
    logger, err := config.Build()
    if err != nil {
        panic(fmt.Sprintf("log 初始化失敗: %v", err))
    }
    logger.Info("log 初始化成功")

    logger.Info("無法獲取網址",
        zap.String("url", "http://www.baidu.com"),
        zap.Int("attempt", 3),
        zap.Duration("backoff", time.Second),
    )
}

打印結果：

{"level":"info","time":"2019-01-02T15:38:33.778+0800","caller":"/Users/lcl/go/src/spikeProxy/main.go:54","msg":"log 初始化成功","serviceName":"spikeProxy"}
{"level":"info","time":"2019-01-02T15:38:33.778+0800","caller":"/Users/lcl/go/src/spikeProxy/main.go:56","msg":"無法獲取網址","serviceName":"spikeProxy","url":"http://www.baidu.com","attempt":3,"backoff":1}

寫入歸檔文件示例

安裝 lumberjack

go get gopkg.in/natefinch/lumberjack.v2

lumberjack介紹

Lumberjack是一個Go包，用於將日志寫入滾動文件。
zap 不支持文件歸檔，如果要支持文件按大小或者時間歸檔，需要使用lumberjack，lumberjack也是zap官方推薦的。

示例

package main

import (
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
    "time"
    "gopkg.in/natefinch/lumberjack.v2"
    "os"
)

func main() {
    hook := lumberjack.Logger{
        Filename:   "./logs/spikeProxy1.log", // 日志文件路徑
        MaxSize:    128,                      // 每個日志文件保存的最大尺寸 單位：M
        MaxBackups: 30,                       // 日志文件最多保存多少個備份
        MaxAge:     7,                        // 文件最多保存多少天
        Compress:   true,                     // 是否壓縮
    }

    encoderConfig := zapcore.EncoderConfig{
        TimeKey:        "time",
        LevelKey:       "level",
        NameKey:        "logger",
        CallerKey:      "linenum",
        MessageKey:     "msg",
        StacktraceKey:  "stacktrace",
        LineEnding:     zapcore.DefaultLineEnding,
        EncodeLevel:    zapcore.LowercaseLevelEncoder,  // 小寫編碼器
        EncodeTime:     zapcore.ISO8601TimeEncoder,     // ISO8601 UTC 時間格式
        EncodeDuration: zapcore.SecondsDurationEncoder, //
        EncodeCaller:   zapcore.FullCallerEncoder,      // 全路徑編碼器
        EncodeName:     zapcore.FullNameEncoder,
    }

    // 設置日志級別
    atomicLevel := zap.NewAtomicLevel()
    atomicLevel.SetLevel(zap.InfoLevel)

    core := zapcore.NewCore(
        zapcore.NewJSONEncoder(encoderConfig),                                           // 編碼器配置
        zapcore.NewMultiWriteSyncer(zapcore.AddSync(os.Stdout), zapcore.AddSync(&hook)), // 打印到控制台和文件
        atomicLevel,                                                                     // 日志級別
    )

    // 開啟開發模式，堆棧跟蹤
    caller := zap.AddCaller()
    // 開啟文件及行號
    development := zap.Development()
    // 設置初始化字段
    filed := zap.Fields(zap.String("serviceName", "serviceName"))
    // 構造日志
    logger := zap.New(core, caller, development, filed)

    logger.Info("log 初始化成功")
    logger.Info("無法獲取網址",
        zap.String("url", "http://www.baidu.com"),
        zap.Int("attempt", 3),
        zap.Duration("backoff", time.Second))
}

控制台打印結果：

{"level":"info","time":"2019-01-02T16:14:43.608+0800","linenum":"/Users/lcl/go/src/spikeProxy/main.go:56","msg":"log 初始化成功","serviceName":"serviceName"}
{"level":"info","time":"2019-01-02T16:14:43.608+0800","linenum":"/Users/lcl/go/src/spikeProxy/main.go:57","msg":"無法獲取網址","serviceName":"serviceName","url":"http://www.baidu.com","attempt":3,"backoff":1}

文件打印結果：

{"level":"info","time":"2019-01-02T16:14:43.608+0800","linenum":"/Users/lcl/go/src/spikeProxy/main.go:56","msg":"log 初始化成功","serviceName":"serviceName"}
{"level":"info","time":"2019-01-02T16:14:43.608+0800","linenum":"/Users/lcl/go/src/spikeProxy/main.go:57","msg":"無法獲取網址","serviceName":"serviceName","url":"http://www.baidu.com","attempt":3,"backoff":1}

結語

目前關於zap的資料很少，都需要自己動手總結，在使用過程中有更多的使用方式我也會持續更新，有問題請在下方留言，我會盡快回復的。