优雅地配置 Logger，并实现日志轮转的方法详解

怎么入门Golang编程？需要学习哪些知识点？这是新手们刚接触编程时常见的问题；下面golang学习网就来给大家整理分享一些知识点，希望能够给初学者一些帮助。本篇文章就来介绍《优雅地配置 Logger，并实现日志轮转的方法详解》，涉及到，有需要的可以收藏一下

问题描述

• 功能：test1()是官方文档推荐的日志轮转和切割库ngopkg.in/natefinch/lumberjack.v2。
• 功能：test2()是一个logger，根据官方文档中的基本配置，使用yaml读取配置。

执行完main函数后，

在控制台输出：

2023-05-15t08:49:16.555+0800 |信息|记录器构建成功：来自 yaml 的配置 | {“app”：“jpz”}

在日志文件foo.log中输出：

{"level":"info","ts":1684111756.5545945,"msg":"记录器构建成功:lumberjack.logger"}

这两个日志肯定是不同的。

我当前的要求：

1. 两者都支持使用配置文件config_log_zap.yaml让所有配置生效，并让lumberjack完成日志轮转和拆分工作。

2. 控制台和日志文件的输出应该是相同的，这样我就可以通过配置文件快速应用所需的内容。之所以需要控制台和日志文件，是因为我在开发过程中需要关注并记录过去的输出消息。

   在控制台输出：

   2023-05-15t08:49:16.555+0800 |信息|记录器构建成功：来自 yaml 的配置 | {“app”：“jpz”}

   在日志文件foo.log中输出：

   2023-05-15t08:49:16.555+0800 |信息|记录器构建成功：来自 yaml 的配置 | {“app”：“jpz”}

3. 如何将 test1() 和 test2() 合并为一个函数 test0() 以满足上述两个要求？

请给我一些帮助，我已经研究了很长时间了。

main.go

package main

import (
    "gopkg.in/yaml.v3"
    "os"

    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
    "gopkg.in/natefinch/lumberjack.v2"
)

func test1() {
    // lumberjack.logger is already safe for concurrent use, so we don't need to
    // lock it.
    w := zapcore.addsync(&lumberjack.logger{
        filename:   "./foo.log",
        maxsize:    500, // megabytes
        maxbackups: 3,
        maxage:     28, // days
    })
    core := zapcore.newcore(
        zapcore.newjsonencoder(zap.newproductionencoderconfig()),
        w,
        zap.infolevel,
    )
    logger := zap.new(core)
    logger.info("logger construction succeeded:lumberjack.logger")
}

func test2() {
    var cfg zap.config
    yamlfile, _ := os.readfile("./config_log_zap.yaml")
    if err := yaml.unmarshal(yamlfile, &cfg); err != nil {
        panic(err)
    }

    logger := zap.must(cfg.build())
    defer logger.sync()

    logger.info("logger construction succeeded:config from yaml")
}

func main() {
    test1()
    test2()
}

config_log_zap.yaml

# For the full description for the configuration, see
# https://github.com/uber-go/zap/blob/382e2511e51cda8afde24f9e6e741f934308edfa/config.go#L58-L94
level: 'debug'
development: true
disableCaller: true
disableStacktrace: false
sampling:
  initial: 100
  thereafter: 100
encoding: 'console'
encoderConfig:
  messageKey: 'msg'
  levelKey: 'level'
  timeKey: 'ts'
  nameKey: 'logger'
  callerKey: 'caller'
  functionKey: 'function'
  stacktraceKey: 'stacktrace'
  skipLineEnding: false
  lineEnding: "\n"
  levelEncoder: 'capital'
  timeEncoder: 'iso8601'
  durationEncoder: 'string'
  callerEncoder: 'full'
  nameEncoder: 'full'
  consoleSeparator: ' | '
outputPaths:
  - 'stdout'
  - './foo.log'
errorOutputPaths:
  - 'stderr'
  - './error_logs'
initialFields:
  app: 'jpz'

正确答案

使用 zap.registersink 将 lumberjack 记录器注册为新水槽：

package main

import (
    "net/url"
    "os"
    "strconv"
    "strings"

    "gopkg.in/yaml.v3"

    "go.uber.org/zap"
    "gopkg.in/natefinch/lumberjack.v2"
)

type lumberjacksink struct {
    lumberjack.logger
}

func (l *lumberjacksink) sync() error {
    return nil
}

func parsenumber(s string, fallback int) int {
    v, err := strconv.atoi(s)
    if err == nil {
        return v
    }
    return fallback
}

func test0() {
    if err := zap.registersink("lumberjack", func(u *url.url) (zap.sink, error) {
        // read parameters from url:
        // lumberjack://localhost/foo.log?maxsize=500&maxbackups=3&maxage=28
        filename := strings.trimleft(u.path, "/")
        if filename == "" {
            filename = "foo.log"
        }
        q := u.query()
        l := &lumberjacksink{
            logger: lumberjack.logger{
                filename:   filename,
                maxsize:    parsenumber(q.get("maxsize"), 500),
                maxbackups: parsenumber(q.get("maxbackups"), 3),
                maxage:     parsenumber(q.get("maxage"), 28),
            },
        }
        return l, nil
    }); err != nil {
        panic(err)
    }

    var cfg zap.config
    yamlfile, _ := os.readfile("./config_log_zap.yaml")
    if err := yaml.unmarshal(yamlfile, &cfg); err != nil {
        panic(err)
    }

    logger := zap.must(cfg.build())
    defer logger.sync()

    logger.info("logger construction succeeded:config from yaml")
}

func main() {
    test0()
}

并修改配置文件以设置 outputpaths 如下：

outputPaths:
  - stdout
  - lumberjack://localhost/foo.log?maxSize=500&maxBackups=3&maxAge=28

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《优雅地配置 Logger，并实现日志轮转的方法详解》文章吧，也可关注golang学习网公众号了解相关技术文章。