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

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

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

回答：

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

相关文档


Content Menu

  • No labels

5 Comments

  1. 杨延庆

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


    1. 郭强

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

    2. 张金富

      参考这里：日志组件-Handler

  2. coldwinter

    最近使用glog的功能，有一个小的功能建议。

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

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

  3. fzxbl

    可以支持结构化日志嘛，比如下面这样的日志，message只输入一条，其他的信息通过ctx传入或调用输出时追加；并且一个函数内多次打印日志时可以把通用字段使用AddAllLevel字段加入，不管日志级别，都不需要额外再记录这些字段。至于trace信息，可以在fork ctx的时候保留

    另外glog所有的字段都是使用了类型断言来转换为文本，这里的性能消耗是否需要考虑？

    NOTICE: 2023-06-21 15:00:34 application/onlinerate/online_rate_alarm.go:384 taskID[c01fa0b6-f22e-45e5-84a9-7ce0485218db] cluster[bj] app[xxx] logid[2754639720] user_ip[127.0.0.1] status[{"MinUsable":95,"CurrentUsable":17}] message[get instance status success]

    log.AddAllLevel(ctxOfApp, log.String("taskID", uuid.New().String()))
    log.AddAllLevel(ctxOfApp, log.String("cluster", cluster))
    log.AddAllLevel(ctxOfApp, log.String("app", app))

    resource.LoggerOnlineRate.Notice(ctxOfApp, "get instance status success",log.AutoField("status",status))


    func String(key string, value string) Field {
    return &field{
    fieldType: StringType,
    key: key,
    value: value,
    }
    }