是否可以在运行时更新 zap 记录器的日志级别？

Posted 2023-02-18

【中文标题】是否可以在运行时更新 zap 记录器的日志级别？

【英文标题】：Is it possible to update the log level of a zap logger at runtime?

【发布时间】：2021-12-12 17:15:40

【问题描述】：

我用kubebuilder创建了一个记录器，它基于zap logger：

import (
    "flag"
    "github.com/gin-gonic/gin"
    "net/http"
    "os"
    "go.uber.org/zap/zapcore"
    uzap "go.uber.org/zap"
    // Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
    // to ensure that exec-entrypoint and run can make use of them.
    _ "k8s.io/client-go/plugin/pkg/client/auth"

    "k8s.io/apimachinery/pkg/runtime"
    utilruntime "k8s.io/apimachinery/pkg/util/runtime"
    clientgoscheme "k8s.io/client-go/kubernetes/scheme"
    ctrl "sigs.k8s.io/controller-runtime"
    "sigs.k8s.io/controller-runtime/pkg/healthz"
    "sigs.k8s.io/controller-runtime/pkg/log/zap"

)

var (
    scheme   = runtime.NewScheme()
    setupLog = ctrl.Log.WithName("setup")
)

var zapOpts []uzap.Option
    zapOpts = append(zapOpts, uzap.AddCaller())
    zapOpts = append(zapOpts, uzap.AddCallerSkip(1))
    zapOpts = append(zapOpts, uzap.AddStacktrace(uzap.DebugLevel))

    opts := zap.Options
        Development:     developmentFlag,
        StacktraceLevel: stacktraceLevel,
        Level:           level,
        Encoder:         encoder,
        ZapOpts:  zapOpts,
    

    opts.BindFlags(flag.CommandLine)
    flag.Parse()

    ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

现在我想在运行时将日志级别更改为zapcore.InfoLevel。我没有找到任何 SetLogLevel 或类似的 API。

我是否需要创建新选项然后设置新级别？

我还需要使用sigs.k8s.io/controller-runtime/pkg/log/zap 库设置记录器。记录器的接口来自go-logr，它实现了logr.Logger 接口。如果我尝试将其更改为zapcore.NewCore，那么我将无法再将记录器设置为ctrl.SetLogger。

我想保留更新zap.Options 的所有选项以及更改日志级别的选项，并且仍然使用来自sigs.k8s.io/controller-runtime/pkg/log/zap 的zap。

是否可以这样做 sigs.k8s.io/controller-runtime/pkg/log/zap 和sigs.k8s.io/controller-runtime?

【问题讨论】：

请问，为什么要在运行时更改日志级别？

可能是我做错了，现在我在系统中出现错误，我想将其更改为 info 以获取更多日志

【参考方案1】：

您不能在运行时更改现有记录器的日志级别。

您可以做的是使用自定义LevelEnabler 函数创建一个核心。您可以使用zap.LevelEnablerFunc 将闭包转换为zapcore.LevelEnabler。

相关文档：

LevelEnabler 决定在记录消息时是否启用给定的记录级别。

LevelEnablerFunc 是使用匿名函数实现 zapcore.LevelEnabler 的便捷方式。

然后，该函数可能会根据在运行时更改的其他一些变量返回 true 或 false：

    // will be actually initialized and changed at run time 
    // based on your business logic
    var infoEnabled bool 

    errorUnlessEnabled := zap.LevelEnablerFunc(func(level zapcore.Level) bool 
        // true: log message at this level
        // false: skip message at this level
        return level >= zapcore.ErrorLevel || infoEnabled
    )

    core := zapcore.NewCore(
        zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
        os.Stdout,
        errorUnlessEnabled,
    )
    logger := zap.New(core)

    logger.Info("foo") // not logged
    
    infoEnabled = true

    logger.Info("foo again") // logged

PS：这段代码是人为的。您的程序必须在 infoEnabled 变量上实现初始化、运行时的值更改和适当的同步（如果需要）。

您可以在 Playground 中运行此示例：https://play.golang.org/p/oT3nvnP1Bwc

【讨论】：

感谢您的帮助，我有点困惑如何通过 zap.Options Development: developmentFlag, StacktraceLevel: stacktraceLevel, Level: level, Encoder: logfmtEncoder, ZapOpts: zapOpts, ,

@user1365697 zap 在你的情况下是sigs.k8s.io/controller-runtime/pkg/log/zap，不是吗？然后您可以将errorUnlessEnabled 设置为zap.Options.Level 字段。类型和我的例子一样，zapcore.LevelEnabler

@blackgreen - 我需要使用库“sigs.k8s.io/controller-runtime/pkg/log/zap”和 ctrl“sigs.k8s.io/controller-runtime”的问题当我设置记录器而不是直接使用“go.uber.org/zap”

@user1365697 将ctrl.SetLogger 与自定义zap 记录器一起使用，看来您可以使用github.com/go-logr/zapr 包。 zapr.NewLogger 或 zapr.NewLoggerWithOptions。请让我知道这是否可行，我会更新答案