如何使用配置文件优雅地配置 Logger,同时支持日志轮转
php小编子墨将为大家分享如何使用配置文件来优雅地配置Logger,并实现日志轮转的方法。Logger是一个常用的日志记录工具,它可以帮助我们记录应用程序的运行状态,便于排查问题和追踪日志。在使用Logger时,通过配置文件可以灵活地定义日志的格式、输出目标和日志级别等,同时还可以配置日志轮转的规则,实现日志的自动管理和保存。通过合理的配置,我们可以实现更加灵活和高效的日志记录和管理。在本文中,我们将详细介绍如何使用配置文件来优雅地配置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"}
这两个日志肯定是不同的。
我当前的要求:
-
两者都支持使用配置文件
config_log_zap.yaml
让所有配置生效,并让lumberjack
完成日志轮转和拆分工作。 -
控制台和日志文件的输出应该是相同的,这样我就可以通过配置文件快速应用所需的内容。之所以需要控制台和日志文件,是因为我在开发过程中需要关注并记录过去的输出消息。
在控制台输出:
2023-05-15t08:49:16.555+0800 |信息|记录器构建成功:来自 yaml 的配置 | {“app”:“jpz”}
在日志文件
foo.log
中输出:2023-05-15t08:49:16.555+0800 |信息|记录器构建成功:来自 yaml 的配置 | {“app”:“jpz”}
-
如何将
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,同时支持日志轮转的详细内容,更多请关注编程网其它相关文章!
免责声明:
① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。
② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341