Go 1.21.0 中新增的结构化日志记录标准库 log/slog 详解

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: Go 1.21.0 中新增的结构化日志记录标准库 log/slog 详解

01

介绍

在 Go 语言项目开发中,我们通常需要查看日志来调试程序,所以日志的快捷搜索和过滤就会至关重要。

因为 Go 标准库中的 log,它不是结构化日志格式,使用上并不方便,所以在 Go 1.21.0 中,Go 标准库新增结构化日志记录包 log/slog,它支持键值对格式。

本文我们介绍 log/slog 的使用方式。

log/slog 使用方式

log/slog 的默认 logger 使用的是 log 的默认 logger,新增日志包 log/slog 和原始日志包 log 协同工作,使 log/slog 更易上手。

日志级别

log/slog 日志级别包括 InfoDebugWarnErrorlog/slog 为它们分别提供了函数。

示例代码:

func main() {
 log.Println("This is log")
 slog.Debug("This is Debug Level")
 slog.Info("This is Info Level")
 slog.Warn("This is Warn Level")
 slog.Error("This is Error Level")
}

输出结果:

2023/10/06 11:18:04 This is log
2023/10/06 11:18:04 INFO This is Info Level
2023/10/06 11:18:04 WARN This is Warn Level
2023/10/06 11:18:04 ERROR This is Error Level

阅读上面这段代码,我们可以发现 log/slog 的输出结果和 log 的输出结果非常相似,只是在日志时间和日志消息之间多了日志级别。

因为 log/slog 的默认 logger 使用的是 log 的默认 logger

除了上述 4 个不同日志级别的函数之外,还有一个函数 log,我们可以使用 log 函数替代上述 4 个函数。

示例代码:

func main() {
 slog.Log(context.Background(), -4, "This is Debug Level")
 slog.Log(context.Background(), 0, "This is Info Level")
 slog.Log(context.Background(), 4, "This is Warn Level")
 slog.Log(context.Background(), 8, "This is Error Level")
}

输出结果:

2023/10/06 11:41:47 INFO This is Info Level
2023/10/06 11:41:47 WARN This is Warn Level
2023/10/06 11:41:47 ERROR This is Error Level

阅读上面这段代码,我们可以发现,log 函数通过参数定义日志级别,数字越大,级别越严重,并且不同级别之间,预留 4 个数字,我们可以定义其他日志级别。

log 函数与 4 个分别代表不同级别的函数之间,还有另外一个区别,它的第一参数是上下文,其实 4 个分别代表不同级别的函数也对应 4 个支持第一个参数是上下文的函数,分别是 InfoContext()DebugContext()WarnContext()ErrorContext

细心的读者朋友们可能发现了,为什么输出结果没有 Debug 级别的日志输出?

因为  log/slog 的默认 logger 的默认日志级别是 Info,如果我们想要使用日志级别 Debug,可以新建 logger,并把默认日志级别设置为 Debug。

键值对

前面我们已经说过 log/slog 支持键值对格式,但是上述示例代码中并没有体现,接下来,我们以 Info 函数为例,介绍 log/slog 怎么输出键值对格式。

func main() {
 slog.Info("This is Info Level", "uid", 1001)
}

输出结果:

2023/10/06 11:58:07 INFO This is Info Level uid=1001

阅读上面这段代码,我们发现 Info 函数中,在日志消息之后新增两个参数,分别是 uid1001,它们就是键值对的 keyvalue

Logger 修改输出日志格式

因为 log/slog 默认使用 log 的默认 logger,所以输出格式就是我们上面看到的文本格式。

我们可以使用内置的 Handler NewTextHandlerNewJSONHandler创建新的 Logger,来输出新文本格式和 json 格式。

示例代码:

func main() {
 logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
 logger.Info("This is a new text Info Level", "uid", 1002)
 jsonLogger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
 jsonLogger.Info("This is a json format Info Level", "uid", 1003)
}

输出结果:

time=2023-10-06T12:19:21.676+08:00 level=INFO msg="This is a new text Info Level" uid=1002
{"time":"2023-10-06T12:19:21.676846+08:00","level":"INFO","msg":"This is a json format Info Level","uid":1003}

阅读上面这段代码,我们可以发现通过内置 Handler 创建新的 Logger,输出新的日志格式,其中 NewTextHandler 输出的所有内容都是键值对格式,NewJSONHandler 输出一个 json 对象。

此外,我们还可以自定义 Handler,通过实现 slog.Handler 接口,生成特定的输出日志格式或者 wrap 另一个 Handler 来丰富其功能。

03

总结

本文我们介绍 log/slog 的使用方式,包括日志级别和输出日志格式。

限于篇幅,还有一些进阶用法没有介绍,比如 LogAttrs 函数,以及 NewTextHandlerNewJSONHandler 的方法。

感兴趣的读者朋友们,可以阅读标准库 log/slog[1] 文档了解更多。


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
打赏
0
2
3
0
8
分享
相关文章
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
997 31
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
什么是Apache日志?为什么Apache日志分析很重要?
Apache是全球广泛使用的Web服务器软件,支持超过30%的活跃网站。它通过接收和处理HTTP请求,与后端服务器通信,返回响应并记录日志,确保网页请求的快速准确处理。Apache日志分为访问日志和错误日志,对提升用户体验、保障安全及优化性能至关重要。EventLog Analyzer等工具可有效管理和分析这些日志,增强Web服务的安全性和可靠性。
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log、原理、写入过程;binlog与redolog区别、update语句的执行流程、两阶段提交、主从复制、三种日志的使用场景;查询日志、慢查询日志、错误日志等其他几类日志
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log
图解MySQL【日志】——Redo Log
Redo Log(重做日志)是数据库中用于记录数据页修改的物理日志,确保事务的持久性和一致性。其主要作用包括崩溃恢复、提高性能和保证事务一致性。Redo Log 通过先写日志的方式,在内存中缓存修改操作,并在适当时候刷入磁盘,减少随机写入带来的性能损耗。WAL(Write-Ahead Logging)技术的核心思想是先将修改操作记录到日志文件中,再择机写入磁盘,从而实现高效且安全的数据持久化。Redo Log 的持久化过程涉及 Redo Log Buffer 和不同刷盘时机的控制参数(如 `innodb_flush_log_at_trx_commit`),以平衡性能与数据安全性。
16 5
图解MySQL【日志】——Redo Log
|
3月前
|
用 Zap 轻松搞定 Go 语言中的结构化日志
在现代应用程序开发中,日志记录至关重要。Go 语言中有许多日志库,而 Zap 因其高性能和灵活性脱颖而出。本文详细介绍如何在 Go 项目中使用 Zap 进行结构化日志记录,并展示如何定制日志输出,满足生产环境需求。通过基础示例、SugaredLogger 的便捷使用以及自定义日志配置,帮助你在实际开发中高效管理日志。
105 1
MySQL事务日志-Undo Log工作原理分析
事务的持久性是交由Redo Log来保证,原子性则是交由Undo Log来保证。如果事务中的SQL执行到一半出现错误,需要把前面已经执行过的SQL撤销以达到原子性的目的,这个过程也叫做"回滚",所以Undo Log也叫回滚日志。
MySQL事务日志-Undo Log工作原理分析
图解MySQL【日志】——Undo Log
Undo Log(回滚日志)是 MySQL 中用于实现事务原子性和一致性的关键机制。在默认的自动提交模式下,MySQL 隐式开启事务,每条增删改语句都会记录到 Undo Log 中。其主要作用包括:
15 0
用 Go 基于 epoll 实现一个最小化的IO库
Go 语言社区中存在多个异步网络框架,如 evio、nbio、gnet 和 netpoll 等。这些框架旨在解决标准库 netpoll 的低效问题,如一个连接占用一个 goroutine 导致的资源浪费。easyio 是一个最小化的 IO 框架,核心代码不超过 500 行,仅实现 Linux 下的 epoll 和 TCP 协议。它通过 Worker Pool、Buffer 等优化提高了性能,并提供了简单的事件处理机制。
什么是事件日志管理系统?事件日志管理系统有哪些用处?
事件日志管理系统是IT安全的重要工具,用于集中收集、分析和解释来自组织IT基础设施各组件的事件日志,如防火墙、路由器、交换机等,帮助提升网络安全、实现主动威胁检测和促进合规性。系统支持多种日志类型,包括Windows事件日志、Syslog日志和应用程序日志,通过实时监测、告警及可视化分析,为企业提供强大的安全保障。然而,实施过程中也面临数据量大、日志管理和分析复杂等挑战。EventLog Analyzer作为一款高效工具,不仅提供实时监测与告警、可视化分析和报告功能,还支持多种合规性报告,帮助企业克服挑战,提升网络安全水平。
118 2
|
3月前
|
go-carbon v2.5.0 发布,轻量级、语义化、对开发者友好的 golang 时间处理库
carbon 是一个轻量级、语义化、对开发者友好的 Golang 时间处理库,提供了对时间穿越、时间差值、时间极值、时间判断、星座、星座、农历、儒略日 / 简化儒略日、波斯历 / 伊朗历的支持。
75 4