Golang集成Context与Zap日志框架的灵活日志记录插件zax的使用

Zax (zap with context)

Zax是一个为Zap Logger添加上下文支持的库，它让Gopher们能够避免生成logger样板代码。通过将logger作为参数传递给函数，它增强了参数功能，避免了需要多个具有显式依赖关系的方法。

安装

go get -u github.com/yuseferi/zax/v2

使用方法

添加上下文字段

要向上下文添加内容并携带它，只需使用zap.Set：

ctx = zax.Set(ctx, []zap.Field{zap.String("trace_id", "my-trace-id")})

获取上下文中的字段

要检索存储在上下文中的zap字段，使用zax.Get：

zax.Get(ctx)  // 这会检索存储在上下文中的zap字段

记录带上下文的日志

要检索存储在上下文中的zap字段并记录它们：

logger.With(zax.Get(ctx)...).Info("just a test record")

获取特定字段

要检索上下文中的特定字段，可以使用zax.GetField：

zax.GetField(ctx, "trace_id")

之后，你可以像使用常规logger一样使用输出并执行日志记录操作：

logger.With(zax.Get(ctx)...).Info("message")
logger.With(zax.Get(ctx)...).Debug("message")

完整示例

假设你想在系统入口点生成一个追踪器，并保持它直到进程完成：

func main() {
    logger, _ := zap.NewProduction()
    ctx := context.Background()
    s := NewServiceA(logger)
    ctx = zax.Set(ctx, zap.String("trace_id", "my-trace-id"))  
    // 如果你想一次添加多个字段
    //ctx = zax.Set(ctx, []zap.Field{zap.String("trace_id", "my-trace-id"),zap.String("span_id", "my-span-id")})
    s.funcA(ctx)
}

type ServiceA struct {
logger *zap.Logger
}

func NewServiceA(logger *zap.Logger) *ServiceA {
    return &ServiceA{
        logger: logger,
    }
}

func (s *ServiceA) funcA(ctx context.Context) {
    s.logger.Info("func A") // 它不包含trace_id，你需要手动添加
    s.logger.With(zax.Get(ctx)...).Info("func A") // 它将记录"trace_id" = "my-trace-id"
}

性能基准

我们对Zax V2、V1和Zap使用相同字段进行了基准测试。以下是基准测试结果： 如你所见，V2(在上下文中仅存储字段的方法)比V1(在上下文中存储整个logger对象)具有更好的性能。

pkg: github.com/yuseferi/zax/v2
BenchmarkLoggingWithOnlyZap-10          103801226               35.56 ns/op          112 B/op          1 allocs/op
BenchmarkLoggingWithOnlyZap-10          98576570                35.56 ns/op          112 B/op          1 allocs/op
BenchmarkLoggingWithOnlyZap-10          100000000               35.24 ns/op          112 B/op          1 allocs/op
BenchmarkLoggingWithOnlyZap-10          100000000               34.85 ns/op          112 B/op          1 allocs/op
BenchmarkLoggingWithOnlyZap-10          100000000               34.98 ns/op          112 B/op          1 allocs/op
BenchmarkLoggingWithZaxV2-10            64324434                56.02 ns/op           72 B/op          2 allocs/op
BenchmarkLoggingWithZaxV2-10            63939517                56.98 ns/op           72 B/op          2 allocs/op
BenchmarkLoggingWithZaxV2-10            63374052                57.60 ns/op           72 B/op          2 allocs/op
BenchmarkLoggingWithZaxV2-10            63417358                57.37 ns/op           72 B/op          2 allocs/op
BenchmarkLoggingWithZaxV2-10            57964246                57.97 ns/op           72 B/op          2 allocs/op
BenchmarkLoggingWithZaxV1-10            54062712                66.40 ns/op          160 B/op          2 allocs/op
BenchmarkLoggingWithZaxV1-10            53155524                65.61 ns/op          160 B/op          2 allocs/op
BenchmarkLoggingWithZaxV1-10            54428521                64.19 ns/op          160 B/op          2 allocs/op
BenchmarkLoggingWithZaxV1-10            55420744                64.28 ns/op          160 B/op          2 allocs/op
BenchmarkLoggingWithZaxV1-10            55199061                64.50 ns/op          160 B/op          2 allocs/op
PASS
ok      github.com/yuseferi/zax/v2      56.919s

贡献

我们坚信开源精神❤️😊。请随时通过提出问题并提交拉取请求来贡献，使Zax变得更好！