Go日志库log竟然这么小巧!

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: Go原生的log库本身比较简单,这篇文章先分析一下它的实现,为后续阅读Kitex的日志库klog做一下铺垫。

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第2天,点击查看活动详情

前言

最近在尝试阅读字节开源RPC框架Kitex的源码,看到日志库klog部分,果不其然在Go原生的log库的基础上增加了自己的设计,大体包括增加了一些格式化的输出增加一些常用的日志级别等。

一番了解后,发现有不少开源的日志库也做了类似的事情,以补充原生log库的不足。因为Go原生的log库本身也比较简单,这篇文章先分析一下它的实现,为后续阅读Kitex的日志库klog做一下铺垫。

本次分析基于:GO SDK 1.18.1 /src/log/log.go的源码。

log库的使用

image-20220530210132795

结果如下:

image-20220530210344181

第三个日志因为第二个日志打印之后,调用panic()函数,且没有调用recover(),导致程序终止。如果注释掉第二行日志即可打印出第三个日志的结果如下:

image-20220530210752882

log.xxx能直接打印日志的原因

carbon

通过观察源码,log包log.go文件中,提供了9个函数可以直接使用,3个一套,分别针对print型日志输出、panic型日志输出(可以recover)、fatal型日志输出(直接终止程序)。

并且这9个函数中频繁使用到了一个std实例,只要我们引入了log包std就会完成初始化,并且作为默认使用的log实例。

image-20220530211928675

Logger结构

既然std是默认的Logger实例,这里先看一下Logger的结构:

image-20220531123015509

  • mu:互斥锁,用于原子写入操作。
  • prefix:日志前缀/后缀。
  • flag:控制需要展示的日志内容。
  • out:描述输出。
  • buf:缓冲区。

关于flag的使用,Go定义了如下的常量:

image-20220531124125730

iota是常量计数器,从0开始自增,可以配合表达式使用,且在一系列常量声明时,可以只指定第一个位置,后续会默认初始化,这里依次初始化为1、2、4...

  • Ldata:输出当地日期,如2009/01/23。
  • Ltime:输出当地时间,如01:23:23。
  • Lmicroseconds:时间精确到微妙,如01:23:23.123123,兼并Ltime。
  • Llongfile:输出文件名全路径 + 调用行号,如/a/b/c/d.go:23。
  • Lshortfile:输出最终文件的名称 + 调用行号,如d.go:23,覆盖Llongfile
  • LUTC:如果设置了LdataLtime,则将输出UTC时间,而不是本地时区。
  • Lmsgprefix:将prefix信息从当前日志行首部移动到message之前。
  • LstdFlagsstd实例的默认值,表示Ldata | Ltime = 3

官方的注释中给出了一些介绍flag用法的例子,这里介绍一个:

如果:std.flag == Ldate | Ltime | Lmicroseconds | Llongfile == 15

则日志行输出结果为:2009/01/23 01:23:23.123123 /a/b/c/d.go:23: messagemessage为具体的日志内容。

std.Output()

回到上面9个函数打印日志,都通过调用std.Output()实现日志的输出,是log库的核心函数,看一下代码:

image-20220531122130791

  • 通过l.mu.Lock(),确保日志内容的写入是原子的。
  • 检查l.flag是否包括Lshortfile或者Llongfile标志位,如果有则需要获取文件名行数,且这一步先释放了锁,因为Caller方法的调用比较耗时(expensive),确保锁住的临界区尽可能小。
  • calldepth:0表示获取调用runtime.Caller(calldepth)的文件名和行数,1表示调用std.Output()的文件名和函数,2表示调用log.Println()的文件名和行数,3则已经用不到了,Go原生log库获取行信息用的都是2。

image-20220531141453630

  • 清空缓冲区l.buf,并格式化日志头部信息(日期、文件名、行数),将其append入`buf。
  • 最后将具体的日志信息s添加入buf,会补全末尾换行符,并调用l.out.Write(),将日志写入事先注册的输出文件。

定制自己的Logger

image-20220531135448565

log库默认使用的std实例是事先初始化好的,那么借助New方法,我们也可以定制自己的logger:

image-20220531142257578

这里指定了日志输出到文件log.txt中,并且定义了一些flag,结果如下:

image-20220531142835128

小结

通过分析,我们发现log是一个很简洁的日志库,它有三种日志输出方式printpanicfatal,且可以自己定制日志的输出格式。但是熟悉其他语言开发的同学可能会对日志级别有更多的需求,且log的格式化用起来比较复杂。

因此会衍生出很多基于log的二次封装的日志库,下一篇文章将讲解字节跳动RPC框架Kitex的日志库klog的实现。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
13天前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
121 30
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
10天前
|
安全 Go
用 Zap 轻松搞定 Go 语言中的结构化日志
在现代应用程序开发中,日志记录至关重要。Go 语言中有许多日志库,而 Zap 因其高性能和灵活性脱颖而出。本文详细介绍如何在 Go 项目中使用 Zap 进行结构化日志记录,并展示如何定制日志输出,满足生产环境需求。通过基础示例、SugaredLogger 的便捷使用以及自定义日志配置,帮助你在实际开发中高效管理日志。
26 1
|
1月前
|
XML JSON Java
Logback 与 log4j2 性能对比:谁才是日志框架的性能王者?
【10月更文挑战第5天】在Java开发中,日志框架是不可或缺的工具,它们帮助我们记录系统运行时的信息、警告和错误,对于开发人员来说至关重要。在众多日志框架中,Logback和log4j2以其卓越的性能和丰富的功能脱颖而出,成为开发者们的首选。本文将深入探讨Logback与log4j2在性能方面的对比,通过详细的分析和实例,帮助大家理解两者之间的性能差异,以便在实际项目中做出更明智的选择。
225 3
|
15天前
|
存储 Cloud Native Shell
go库介绍:Golang中的Viper库
Viper 是 Golang 中的一个强大配置管理库,支持环境变量、命令行参数、远程配置等多种配置来源。本文详细介绍了 Viper 的核心特点、应用场景及使用方法,并通过示例展示了其强大功能。无论是简单的 CLI 工具还是复杂的分布式系统,Viper 都能提供优雅的配置管理方案。
|
18天前
|
JSON 安全 网络协议
go语言使用内置函数和标准库
【10月更文挑战第18天】
13 3
|
19天前
|
JSON 监控 安全
go语言选择合适的工具和库
【10月更文挑战第17天】
11 2
|
1月前
|
存储 缓存 关系型数据库
MySQL事务日志-Redo Log工作原理分析
事务的隔离性和原子性分别通过锁和事务日志实现,而持久性则依赖于事务日志中的`Redo Log`。在MySQL中,`Redo Log`确保已提交事务的数据能持久保存,即使系统崩溃也能通过重做日志恢复数据。其工作原理是记录数据在内存中的更改,待事务提交时写入磁盘。此外,`Redo Log`采用简单的物理日志格式和高效的顺序IO,确保快速提交。通过不同的落盘策略,可在性能和安全性之间做出权衡。
1630 14
|
1月前
|
Python
log日志学习
【10月更文挑战第9天】 python处理log打印模块log的使用和介绍
31 0
|
1月前
|
数据可视化
Tensorboard可视化学习笔记(一):如何可视化通过网页查看log日志
关于如何使用TensorBoard进行数据可视化的教程,包括TensorBoard的安装、配置环境变量、将数据写入TensorBoard、启动TensorBoard以及如何通过网页查看日志文件。
197 0
|
3月前
|
Kubernetes Ubuntu Windows
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
131 3