v2版本开始,glog组件将ctx上下文变量作为日志打印的必需参数。

自定义CtxKeys

日志组件支持自定义的键值打印,通过ctx上下文变量中读取。

使用配置

  1. # 日志组件配置
  2. logger:
  3. Level: "all"
  4. Stdout: true
  5. CtxKeys: ["RequestId", "UserId"]

其中CtxKeys用于配置需要从context.Context接口对象中读取并输出的键名。

日志输出

使用上述配置,然后在输出日志的时候,通过Ctx链式操作方法指定输出的context.Context接口对象,例如:

  1. package main
  2. import (
  3. "context"
  4. "github.com/gogf/gf/v2/frame/g"
  5. )
  6. func main() {
  7. var ctx = context.Background()
  8. ctx = context.WithValue(ctx, "RequestId", "123456789")
  9. ctx = context.WithValue(ctx, "UserId", "10000")
  10. g.Log().Error(ctx, "runtime error")
  11. }

执行后,终端输出:

  1. 2024-01-17 21:12:12.182 [ERRO] {123456789, 10000} runtime error
  2. Stack:
  3. 1. main.main
  4. /Users/txqiangguo/Workspace/gogf/gf/example/os/log/ctx_keys/main.go:13

日志示例

日志组件-Context - 图1

传递给Handler

如果开发者自定义了日志对象的Handler,那么每个日志打印传递的ctx上下文变量将会传递给Handler中。关于日志Handler的介绍请参考章节:日志组件-Handler

链路跟踪支持

glog组件支持OpenTelemetry标准的链路跟踪特性,该支持是内置的,无需开发者做任何设置,具体请参考章节:服务链路跟踪

日志组件-Context - 图2