Skip to end of metadata
Go to start of metadata

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

基本介绍

使用方式

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.Printg.Log().Print区别

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

相关文档


Content Menu

  • No labels

3 Comments

  1. 日志需要发送到 ES 做统一分析,以往是使用纯 json 格式输出,这样 LogStash 就可以很方便的转换到 ES 的字段,检索精准效率高。没找到 gf 日志模块的这个配置,请问日志标准化有什么最佳实践吗? 郭强 


    1. 下个版本v1.17有自定义日志处理Handler的特性,开发者可以自己自定义输出内容格式。

  2. 最近使用glog的功能,有一个小的功能建议。

    因为我在项目中,希望每15分钟拆分出一个日志文件,使用现有的命名方式不能达到所需的目的。

    能否将日志文件命名的部分,增加一个可扩展的函数,使得可以自定义 func (l *Logger) getFilePath(now time.Time) string 的返回值。