golang带堆栈跟踪和对象转储功能的日志记录插件库go-log的使用

介绍

go-log是一个Golang日志库，提供了带堆栈跟踪和对象转储功能的日志记录功能。

使用示例

下面是一个完整的go-log使用示例：

package main

import (
    "errors"
    "github.com/pieterclaerhout/go-log"
)

// 模拟一个返回错误的函数
func funcWithError() error {
    return errors.New("something went wrong")
}

func main() {
    // 配置日志参数
    log.DebugMode = true      // 启用调试模式
    log.PrintTimestamp = true // 打印时间戳
    log.PrintColors = true    // 启用颜色输出
    log.TimeFormat = "2006-01-02 15:04:05.000" // 时间格式

    // 定义一个测试变量
    myVar := map[string]string{"hello": "world"}

    // 调试级别日志
    log.Debug("arg1", "arg2")                     // 调试日志
    log.Debugf("arg1 %d", 1)                      // 格式化调试日志
    log.DebugDump(myVar, "prefix")                // 调试输出变量内容
    log.DebugSeparator("title")                   // 调试分隔线

    // 信息级别日志
    log.Info("arg1", "arg2")                      // 信息日志
    log.Infof("arg1 %d", 1)                       // 格式化信息日志
    log.InfoDump(myVar, "prefix")                 // 信息输出变量内容
    log.InfoSeparator("title")                    // 信息分隔线

    // 警告级别日志
    log.Warn("arg1", "arg2")                      // 警告日志
    log.Warnf("arg1 %d", 1)                       // 格式化警告日志
    log.WarnDump(myVar, "prefix")                 // 警告输出变量内容
    log.WarnSeparator("title")                    // 警告分隔线

    // 错误级别日志
    log.Error("arg1", "arg2")                     // 错误日志
    log.Errorf("arg1 %d", 1)                      // 格式化错误日志
    log.ErrorDump(myVar, "prefix")                // 错误输出变量内容
    log.ErrorSeparator("title")                   // 错误分隔线

    // 致命错误日志(会终止程序)
    // log.Fatal("arg1", "arg2")                   // 致命错误日志
    // log.Fatalf("arg1 %d", 1)                    // 格式化致命错误日志

    // 错误处理
    err1 := funcWithError()
    log.StackTrace(err1)                          // 打印错误堆栈跟踪

    err2 := funcWithError()
    log.CheckError(err2)                          // 检查错误并打印
}

环境变量配置

可以通过环境变量来配置go-log的默认行为：

• DEBUG: 控制log.DebugMode，启用或禁用调试模式
• PRINT_TIMESTAMP: 控制log.PrintTimestamp，启用或禁用时间戳打印

功能说明

1. 日志级别：支持Debug、Info、Warn、Error和Fatal多种日志级别
2. 格式化输出：提供类似fmt.Printf的格式化日志方法(如Debugf、Infof等)
3. 变量转储：可以方便地转储变量内容(DebugDump、InfoDump等方法)
4. 分隔线：可以输出带标题的分隔线(DebugSeparator、InfoSeparator等方法)
5. 错误处理：提供StackTrace和CheckError方法来处理错误并打印堆栈跟踪
6. 自定义配置：可以配置时间格式、颜色输出等参数

这个库非常适合需要详细日志记录和调试信息的Golang项目。