Skip to main content

Log

常见的功能比较完善的日志库有:

  • zerolog: 注重性能和低开销，采用结构化日志，适合对性能要求极高的场景
  • logrus: 功能丰富且易于使用，支持多种输出格式和钩子，适合快速集成
  • zap: 高性能且灵活，提供结构化日志和多种级别的日志记录，适合需要高吞吐量的应用

以上3中日志库都使用过, 综合性能和使用体验上来说 zerolog 最佳, 因此打算支持:

  • zerolog: 性能和使用体验上由于其他2个

默认配置​

[log]
  # 0 为打印日志全路径, 默认打印2层路径
  caller_deep = 3
  # 日志的级别, 默认Debug
  level = "debug"
  # 开启Trace时, 记录的TraceId名称, 默认trace_id
  trace_filed = "trace_id"

[log.console]
  enable = true
  no_color = false

[log.file]
  # 是否开启文件记录
  enable = false
  # 文件的路径
  file_path = ""
  # 单位M, 默认100M
  max_size = 100
  # 默认保存 6个文件
  max_backups = 6
  # 保存多久
  max_age = 0
  # 是否压缩
  compress = false

更详细的信息请查看源码

基本使用​

Global Logger​

package main

import (
	"github.com/infraboard/mcube/v2/ioc"
	"github.com/infraboard/mcube/v2/ioc/config/log"
)

func main() {
	ioc.DevelopmentSetup()

	gLogger := log.L()
	glog.Debug().Msg("this is global logger debug msg")
}
2023-12-24T17:44:30+08:00 DEBUG  examples/log/main.go:12 > this is global logger debug msg

Sub Logger​

package main

import (
	"github.com/infraboard/mcube/v2/ioc"
	"github.com/infraboard/mcube/v2/ioc/config/log"
)

func main() {
	ioc.DevelopmentSetup()

	subLogger := log.Sub("app1")
	sublog.Debug().Msg("this is app1 sub logger debug msg")
}
2023-12-24T17:44:30+08:00 DEBUG  examples/log/main.go:15 > this is app1 sub logger debug msg component:APP1

Trace Logger​

package main

import (
	"context"

	"github.com/infraboard/mcube/v2/ioc"
	"github.com/infraboard/mcube/v2/ioc/config/log"
)

func main() {
	ioc.DevelopmentSetup()

	gLogger := log.L()
	glog.Debug().Msg("this is global logger debug msg")

	subLogger := log.Sub("app1")
	sublog.Debug().Msg("this is app1 sub logger debug msg")

	ctx := context.Background()
	traceLogger := log.T("app1").Trace(ctx)
	tracelog.Debug().Msg("this is app1 trace logger debug msg")
}
2023-12-24T17:47:02+08:00 DEBUG  examples/log/main.go:21 > this is app1 trace logger debug msg component:APP1 trace_id:00000000000000000000000000000000