glog 是通用的高性能日志管理模块，实现了强大易用的日志管理功能，是 GoFrame 开发框架的核心组件之一。

基本介绍

使用方式：

  1. import "github.com/gogf/gf/v2/os/glog"

接口文档：

https://pkg.go.dev/github.com/gogf/gf/v2/os/glog

简要说明：

  1. glog 模块固定日志文件名称格式为 *.log，即固定使用 .log 作为日志文件名后缀。
  2. glog 支持文件输出、日志级别、日志分类、调试管理、调用跟踪、链式操作、滚动切分等等丰富特性。
  3. 可以使用 glog.New 方法创建 glog.Logger 对象用于自定义日志打印，也可以并推荐使用 glog 默认提供的包方法来打印日志。
  4. 当使用包方法修改模块配置时，注意任何的 glog.Set* 设置方法都将会 全局生效。
  5. 日志内容默认时间格式为 时间 [级别] 内容 换行，其中 时间 精确到毫秒级别， 级别 为可选输出， 内容 为调用端的参数输入， 换行 为可选输出(部分方法自动为日志内容添加换行符号)，日志内容示例： 2018-10-10 12:00:01.568 [ERRO] 产生错误。
  6. Print*/Debug*/Info* 方法输出日志内容到标准输出( stdout)，为防止日志的错乱， Notice*/Warning*/Error*/Critical*/Panic*/Fatal* 方法也是将日志内容输出到标准输出( stdout)。
  7. Panic* 方法在输出日志信息后会引发 panic 错误方法
  8. Fatal* 方法在输出日志信息之后会停止进程运行，并返回进程状态码值为 1(正常程序退出状态码为 0)。

组件特性

glog 组件具有以下显著特性：

  • 使用简便，功能强大
  • 支持配置管理，使用统一的配置组件
  • 支持日志级别
  • 支持颜色打印
  • 支持链式操作
  • 支持指定输出日志文件/目录
  • 支持链路跟踪
  • 支持异步输出
  • 支持堆栈打印
  • 支持调试信息开关
  • 支持自定义 Writer 输出接口
  • 支持自定义日志 Handler 处理
  • 支持自定义日志 CtxKeys 键值
  • 支持 JSON 格式打印
  • 支持 Flags 特性
  • 支持 Rotate 滚动切分特性

单例对象

日志组件支持单例模式，使用 g.Log(单例名称) 获取不同的单例日志管理对象。提供单例对象的目的在于针对不同业务场景可以使用不同配置的日志管理对象。我们推荐使用 g.Log() 方法获取单例对象来进行日志操作，该方法内部会自动读取配置文件并初始化单例对象，该初始化操作仅会执行一次。

glog.Print 和 g.Log().Print 区别

  • glog 是日志组件的包名， g.Log() 是一个日志组件单例对象。
  • g.Log() 单例对象通过对象管理组件 g 包来维护，对象初始化时会自动读取日志配置，使用简便，大多数场景下推荐使用这种方式使用日志组件。
  • glog 通过独立组件的形式使用，默认情况下会直接输出日志到终端。也可以通过配置管理方法设置全局配置，或者通过 New 创建独立的日志对象使用。

日志组件 - 图1提示

网友：为什么会有两种日志打印方式？我应该用哪种方式呢？

回答：

由于框架的每个组件都是 解耦化设计 的，框架是 可以作为独立的工具库使用 的。比如项目只需要使用日志组件，那么可以直接使用 glog 包的方法即可，不会引入其他的组件。但在项目工程化使用中，工具库的使用方式会较为繁琐，往往会涉及到配置和组件初始化（大部分场景会引起二次封装），因此框架也提供了一个 耦合包 叫做 g 包，这个包下面默认加载了一些常用的组件。 g.Log() 就是其中的日志组件，它会自动按照工程规范读取并初始化配置对象，快速初始化日志对象并实现单例管理，极大简化工程化下的日志使用。更多的介绍请参考： 对象管理

相关文档

📄️ 日志组件-配置管理GoFrame框架中日志组件的配置管理功能，包括如何通过配置文件和配置方法管理Logger对象。日志组件支持多种配置格式，模块化设计使其能独立地进行日志输出配置。配置项涵盖日志路径、输出级别和终端显示等，日志级别支持多种模式，确保灵活记录各级别信息。

📄️ 日志组件-日志级别在GoFrame框架中使用日志组件来管理和设定日志级别，包括SetLevel、SetLevelStr和SetLevelPrint方法的具体用法示例。我们还讨论了如何通过不同的日志级别名称来过滤和显示日志内容，实现灵活的日志管理。

📄️ 日志组件-文件目录使用GoFrame框架中的日志组件设置日志文件的名称和目录路径。通过SetFile方法，用户可以自定义日志文件的格式并支持gtime时间格式。通过SetPath方法，用户可以将日志内容写入指定目录，并利用gfpool优化文件写入效率。

📄️ 日志组件-链式操作GoFrame框架中的glog模块，支持链式操作的日志功能。包括设置日志输出路径、日志文件分类、日志级别、开启trace打印等功能。此外，提供如何设置文件回溯值，实现异步输出日志的示例代码和应用场景。全面优化日志使用体验。

📄️ 日志组件-颜色打印在GoFrame框架中使用日志组件的颜色打印功能，以提高日志的可查看性。通过添加字体颜色来突出显示不同的日志等级，包括Debug、Info、Notice、Warning、Error等。此外，本文还提供了在配置文件以及代码中启用日志颜色打印的示例，并说明了默认情况下不同日志等级对应的颜色设置。

📄️ 日志组件-ContextGoFrame框架中glog日志组件的使用，特别是如何通过Context上下文变量实现日志打印。文章详细讲解了自定义CtxKeys的配置和使用示例，并提供了链路跟踪支持的功能。此外，还涉及了日志Handler的实现，以帮助开发者更好地集成日志功能。

📄️ 日志组件-Handler文章介绍了从v2.0版本开始，GoFrame框架的glog组件新增的可自定义日志处理的Handler特性。开发者可以通过Handler实现日志输出的自定义内容，例如将日志转为Json格式输出或者输出至第三方服务如Graylog。详细示例展示了如何在GoFrame框架中使用Handler进行日志处理。

📄️ 日志组件-JSON格式使用GoFrame框架中的glog组件以JSON格式输出日志，适合日志分析工具解析。您将学习如何通过map或struct参数实现JSON日志格式输出，以及结合gjson.MustEncode方法实现更复杂的JSON内容输出。

📄️ 日志组件-异步输出使用GoFrame框架进行日志的异步输出，以提高日志打印的效率。您可以通过SetAsync或链式方法设置异步输出，异步输出能够减少资源占用，但需注意可能导致日志乱序的问题。

📄️ 日志组件-堆栈打印GoFrame框架日志组件中堆栈打印的功能，该功能允许开发者自动打印日志调用方法的堆栈信息，并可以通过多种方法获取或打印堆栈信息。这些功能对于调试错误日志信息非常有用，特别是在处理复杂应用程序时。本文通过代码示例展示了如何使用这些功能，帮助开发者更好地理解和应用日志组件的堆栈打印特性。

📄️ 日志组件-调试信息在GoFrame框架中使用Debug/Debugf方法进行调试信息记录的方式，适用于开发和测试环境。通过代码示例演示如何使用SetDebug方法控制调试信息的输出，以及通过命令行参数和环境变量关闭调试日志的操作。

📄️ 日志组件-Writer接口在GoFrame框架中使用glog模块的Writer接口来自定义日志输出。通过实现自定义Writer对象，可以灵活地将日志输出到不同的目标如文件、标准输出和Graylog等。此外，还提供了示例代码说明如何实现日志HOOK功能，以便及时将严重错误通知到监控服务。

📄️ 日志组件-Flags特性GoFrame框架中日志组件的Flags特性，说明如何通过不同的常量组合来控制日志输出的额外特性，包括异步输出、调用行号信息打印以及多种时间格式的选择。这些特性能够帮助开发者实现更灵活的日志记录和调试。

📄️ 日志组件-Rotate特性GoFrame框架中glog组件的日志滚动切分特性，包括通过设置日志文件名称按照日期输出、通过设置RotateSize和RotateExpire进行日志滚动切分、支持日志文件压缩与备份、配置示例，以及注意事项等内容。提供详细的配置项说明和示例代码，帮助开发者更好地管理日志文件。

📄️ 日志组件-常见问题在使用GoFrame框架进行日志记录时，打印error变量的堆栈信息，而不是打印日志方法调用时的堆栈。提供了具体的Go代码示例，帮助开发者更准确地进行错误日志的记录和调试。