从v2版本开始，glog组件将ctx上下文变量作为日志打印的必需参数。
自定义CtxKeys
日志组件支持自定义的键值打印，通过ctx上下文变量中读取。
使用配置
| Code Block | ||
|---|---|---|
| ||
# 日志组件配置 logger: Path: "/var/log/my-app" Level: "all" Stdout: falsetrue CtxKeys: ["RequestId", "UserId"] |
其中CtxKeys用于配置需要从context.Context接口对象中读取并输出的键名。
日志输出
使用上述配置，然后在输出日志的时候，通过Ctx链式操作方法指定输出的context.Context接口对象，例如：接口对象，请注意不要使用自定义类型作为Key，否则无法输出到日志文件中，例如：
| Code Block | ||
|---|---|---|
| ||
package main
import (
"context"
"github.com/gogf/gf/v2/frame/g"
)
func main() {
var ctx = context.Background()
// 可以直接使用String作为Key
ctx = context.WithValue(ctx, "RequestId", "123456789")
// 如需将Key提取为公共变量，可以使用gctx.StrKey类型，或直接使用string类型
const userIdKey gctx.StrKey = "UserId" // or const userIdKey = "UserId"
ctx = context.WithValue(ctx, userIdKey, "10000")
// 不能自定义类型
type notPrintKeyType string
const notPrintKey notPrintKeyType = "UserId"NotPrintKey"
ctx = context.WithValue(ctx, notPrintKey, "10000notPrintValue") // 不会打印 notPrintValue
g.Log().Error(ctx, "runtime error")
} |
执行后，终端输出：
| Code Block | ||
|---|---|---|
| ||
2024-0109-1726 2111:1245:1233.182790 [ERRO] {123456789, 10000} runtime error Stack: 1. main.main /Users/txqiangguoteemo/WorkspaceGolandProjects/gogf/gf/example/os/log/ctx_keys/demo/main.go:1324 |
日志示例
传递给Handler
如果开发者自定义了日志对象的Handler，那么每个日志打印传递的ctx上下文变量将会传递给Handler中。关于日志Handler的介绍请参考章节：日志组件-Handler
链路跟踪支持
glog组件支持OpenTelemetry标准的链路跟踪特性，该支持是内置的，无需开发者做任何设置，具体请参考章节：服务链路跟踪
| Panel | ||
|---|---|---|
| ||
|