golang结构化日志log/slog包之LogValuer的用法简介

 更新时间:2023年10月18日 08:41:17   作者:路多辛  
这篇文章主要为大家详细介绍了golang结构化日志log/slog包中 LogValuer 和日志记录函数的正确包装方法,感兴趣的小伙伴可以跟随小编一起了解一下

上一篇文章讲解了 log/slog 包中的分组、上下文和属性值类型,本文讲解下 LogValuer 和日志记录函数的正确包装方法。

slog.LogValuer

如果想改变或者自定义一个类型的日志记录行为,可以通过实现 slog.LogValuer 接口来实现,slog.LogValuer 接口的定义如下:

type LogValuer interface {
    LogValue() Value
}

定义了一个 LogValue 方法,返回一个 Value 类型的对象。如果一个类型实现了 LogValuer 接口,那么从它的 LogValue 方法返回的 Value 将被用于日志记录,可以用来控制该类型的值在日志中的显示方式。看个简单示例:

package main
 
import (
    "log/slog"
    "os"
)
 
type Token string
 
// 实现 slog.LogValuer 接口
// 避免泄露 token
func (Token) LogValue() slog.Value {
    return slog.StringValue("******")
}
 
func main() {
    t := Token("shhhh!")
    logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
    logger.Info("生成 token", "用户", "路多辛的博客", "token", t)
}

输出内容如下:

time=2023-10-15T15:06:58.253+08:00 level=INFO msg="生成 token" 用户=路多辛的博客 token=******

从安全角度看,密码或者token 等敏感信息是不能被记录在日志里面的,可以使用自定义的并且实现了 LogValue 的类型来避免这种情况产生。在这个例子中,当记录 token 日志时,token 会被转换为“******”后记录在日志里面。再看一个结合字段分组使用的示例:

package main
 
import (
    "log/slog"
)
 
type Name struct {
    First, Last string
}
 
func (n Name) LogValue() slog.Value {
    return slog.GroupValue(
        slog.String("first", n.First),
        slog.String("last", n.Last))
}
 
func main() {
    n := Name{"路多辛的博客", "路多辛的所思所想"}
    slog.Info("任务结束", "agent", n)
}

输出内容如下:

2023/10/15 15:06:09 INFO 任务结束 agent.first=路多辛的博客 agent.last=路多辛的所思所想

包装输出函数

日志记录函数使用调用堆栈上的反射来查找应用程序中日志记录调用的文件名和行号,这可能会导致包装 slog 的函数记录错误的的源信息。举个例子,如果在 mylog.go 中定义了一个日志记录函数 Infof,然后在 main.go 中调用了此函数,这种情况下,日志会将把源文件记录为 mylog.go 而不是 main.go。正确实现 Infof 函数的方式是将获取的源信息传递给 NewRecord 函数,示例代码如下:

package main
 
import (
	"context"
	"fmt"
	"log/slog"
	"os"
	"path/filepath"
	"runtime"
	"time"
)
 
func Infof(logger *slog.Logger, format string, args ...any) {
	if !logger.Enabled(context.Background(), slog.LevelInfo) {
		return
	}
	var pcs [1]uintptr
	runtime.Callers(2, pcs[:]) // skip [Callers, Infof]
	r := slog.NewRecord(time.Now(), slog.LevelInfo, fmt.Sprintf(format, args...), pcs[0])
	_ = logger.Handler().Handle(context.Background(), r)
}
 
func main() {
	replace := func(groups []string, a slog.Attr) slog.Attr {
		// Remove time.
		if a.Key == slog.TimeKey && len(groups) == 0 {
			return slog.Attr{}
		}
		// Remove the directory from the source's filename.
		if a.Key == slog.SourceKey {
			source := a.Value.Any().(*slog.Source)
			source.File = filepath.Base(source.File)
		}
		return a
	}
	logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{AddSource: true, ReplaceAttr: replace}))
	Infof(logger, "message, %s", "formatted")
}

到此这篇关于golang结构化日志log/slog包之LogValuer的用法简介的文章就介绍到这了,更多相关go slog内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go语言中的Web框架:从Gin到Echo

    Go语言中的Web框架:从Gin到Echo

    文章介绍了Go语言中流行的Web框架Gin、Echo、Fiber和Beego,分别从框架简介、安装、基本使用、中间件、路由参数等方面进行阐述,并进行了框架对比,同时,还提供了最佳实践、项目结构和部署方式等内容,帮助开发者选择合适的Web框架并构建高效可靠的Web应用
    2026-04-04
  • golang中的jwt使用教程流程分析

    golang中的jwt使用教程流程分析

    这篇文章主要介绍了golang中的jwt使用教程,接下来我们需要讲解一下Claims该结构体存储了token字符串的超时时间等信息以及在解析时的Token校验工作,需要的朋友可以参考下
    2023-05-05
  • golang中defer执行时机的案例分析

    golang中defer执行时机的案例分析

    这篇文章主要来通过一些案例和大家一起探讨一下golang中defer的执行时机,文中的示例代码讲解详细,对我们深入了解golang有一定的帮助,感兴趣的可以跟随小编一起学习一下
    2023-11-11
  • 一文详解Golang 定时任务库 gron 设计和原理

    一文详解Golang 定时任务库 gron 设计和原理

    这篇文章主要介绍了一文详解Golang 定时任务库 gron 设计和原理,gron是一个比较小巧、灵活的定时任务库,可以执行定时的、周期性的任务。gron提供简洁的、并发安全的接口
    2022-08-08
  • Go语言操作etcd的示例详解

    Go语言操作etcd的示例详解

    etcd是使用Go语言开发的一个开源的、高可用的分布式key—value存储系统,可以用于配置共享和服务的注册和发现,下面我们就来看看Go语言是如何操作etcd的吧
    2024-03-03
  • golang中http请求的context传递到异步任务的坑及解决

    golang中http请求的context传递到异步任务的坑及解决

    这篇文章主要介绍了golang中http请求的context传递到异步任务的坑及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • Go中最强大的权限控制库(Casbin)的实现

    Go中最强大的权限控制库(Casbin)的实现

    Casbin是一个强大的、高效的开源访问控制框架,支持ACL、RBAC、ABAC 等多种经典访问控制模型,通过配置文件即可灵活定义权限规则,具有一定的参考价值,感兴趣的可以了解一下
    2026-03-03
  • Go语言二进制文件的读写操作

    Go语言二进制文件的读写操作

    本文主要介绍了Go语言二进制文件的读写操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • 利用Go语言搭建WebSocket服务端方法示例

    利用Go语言搭建WebSocket服务端方法示例

    这篇文章主要给大家介绍了利用Go语言搭建WebSocket服务端方法,文中通过示例代码介绍的非常详细,需要的朋友们可以参考借鉴,下面来一起看看吧。
    2017-04-04
  • Golang分布式锁详细介绍

    Golang分布式锁详细介绍

    分布式锁是控制分布式系统之间同步访问共享资源的一种方式。如果不同的系统或是同一个系统的不同主机之间共享了一个或一组资源,那么访问这些资源时,需要通过一些互斥手段来防止彼此之间的干扰以保证一致性,在这种情况下,就需要使用分布式锁了
    2022-10-10

最新评论