golang中log包自定义输出日志格式与写入到文件

 更新时间:2023年06月30日 16:07:19   作者:Json_Marz  
这篇文章主要给大家介绍了关于golang中log包自定义输出日志格式与写入到文件的相关资料,日志输出在任何项目中都极其重要,是有助于后续我们排查解决程序BUG,需要的朋友可以参考下

1.背景:

平时开发项目时打印日志用到logrus包,但是觉得logrus配置比较麻烦,于是想着直接使用go自带的log包输出日志,其提供了一些配置,比如SetPrefix(), 可以让我们自己二次封装,让自己的日志内容更鲜明些。

2.代码:

package log
 
import (
    "fmt"
    "github.com/robfig/cron/v3"
    "io"
    "log"
    "os"
    "my_log/config"
    "runtime"
    "strconv"
    "strings"
    "sync"
    "time"
)
 
var (
    debug         *log.Logger
    info          *log.Logger
    warn          *log.Logger
    error         *log.Logger
    dayChangeLock sync.RWMutex
)
 
const (
    debugLevel = iota //iota=0
    infoLevel
    warnLevel
    errorLevel
)
 
func init() {
    dayChangeLock = sync.RWMutex{}
    createLogFile()
    go logJob()
}
 
func createLogFile() {
    dayChangeLock.Lock()
    defer dayChangeLock.Unlock()
    now := time.Now()
    postFix := now.Format("20060102")
    logFile := "plume_log_" + postFix + ".log"
    logOut, err := os.OpenFile(logFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, os.ModePerm)
    if err != nil {
        panic(err)
    } else {
        multiWriter := io.MultiWriter(os.Stdout, logOut)
        debug = log.New(multiWriter, "[DEBUG] ", log.Ldate|log.Ltime)
        info = log.New(multiWriter, "[INFO] ", log.Ldate|log.Ltime)
        warn = log.New(multiWriter, "[WARN] ", log.Ldate|log.Ltime)
        error = log.New(multiWriter, "[ERROR] ", log.Ldate|log.Ltime)
    }
}
 
func Debug(format string, v ...any) {
    if config.Conf.Level <= debugLevel {
        debug.Printf(getLineNo()+format, v...)
    }
}
 
func Info(format string, v ...any) {
    if config.Conf.Level <= infoLevel {
        info.Printf(getLineNo()+format, v...)
    }
}
 
func Warn(format string, v ...any) {
    if config.Conf.Level <= warnLevel {
        warn.Printf(getLineNo()+format, v...)
    }
}
 
func Error(format string, v ...any) {
    if config.Conf.Level <= errorLevel {
        error.Printf(getLineNo()+format, v...)
    }
}
 
func getLineNo() string {
    _, file, line, ok := runtime.Caller(2)
    if ok {
        split := strings.Split(file, "/")
        file = split[len(split)-1]
        fileLine := file + ":" + strconv.Itoa(line) + " "
        return fileLine
    }
    return ""
}
 
// logJob 定时操作日志
func logJob() {
    c := cron.New(cron.WithSeconds())
    c.AddFunc("@daily", func() {
    Info("执行log定时任务。。。")
    now := time.Now()
    createLogFile()
    closeYesterdayLogFile := fmt.Sprintf("plume_log_%s.log", now.Add(-24*time.Hour).Format("20060102"))
        file, _ := os.Open(closeYesterdayLogFile)
        file.Sync()
        file.Close()
    // 删除n天前的日志
    removeLogFile := fmt.Sprintf("plume_log_%s.log", time.Now().Add(time.Duration(config.Conf.Log.KeepDays)*-24*time.Hour).Format("20060102"))
    open, err := os.Open(removeLogFile)
    if err != nil {
        Error(err.Error())
        return
    }
    go func () {
        // 设置for select 的原因是文件虽然被关闭了,但文件所占的process还在进行中,每10秒轮询一次,执行删除操作,确保文件有被删除
        loop:
            for {
                select {
                case <-time.After(10 * time.Second):
                    removeErr := os.Remove(removeLogFile)
                    if removeErr != nil {
                        Error(removeErr.Error())
                    } else {
                        Info("删除日志成功:%s", removeLogFile)
                        break loop
                    }
                }
            }
        }()
    })
    c.Start()
}
 
//var (
//    kernel32    = syscall.NewLazyDLL(`kernel32.dll`)
//    proc        = kernel32.NewProc(`SetConsoleTextAttribute`)
//    CloseHandle = kernel32.NewProc(`CloseHandle`)
//    // 给字体颜色对象赋值
//    FontColor = Color{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15}
//)
 
//type Color struct {
//    black        int // 黑色
//    blue         int // 蓝色
//    green        int // 绿色
//    cyan         int // 青色
//    red          int // 红色
//    purple       int // 紫色
//    yellow       int // 黄色
//    light_gray   int // 淡灰色(系统默认值)
//    gray         int // 灰色
//    light_blue   int // 亮蓝色
//    light_green  int // 亮绿色
//    light_cyan   int // 亮青色
//    light_red    int // 亮红色
//    light_purple int // 亮紫色
//    light_yellow int // 亮黄色
//    white        int // 白色
//}
 
// 输出有颜色的字体
//func ColorPrint4Window(s, t string) {
//    switch t {
//    case "DEBUG":
//        proc.Call(uintptr(syscall.Stdout), uintptr(FontColor.light_cyan))
//        Debug(s)
//    case "INFO":
//        proc.Call(uintptr(syscall.Stdout), uintptr(FontColor.green))
//        Info(s)
//    case "WARN":
//        proc.Call(uintptr(syscall.Stdout), uintptr(FontColor.light_yellow))
//        Warn(s)
//    case "ERROR":
//        proc.Call(uintptr(syscall.Stdout), uintptr(FontColor.red))
//        Error(s)
//    default:
//        proc.Call(uintptr(syscall.Stdout), uintptr(FontColor.black))
//        Info(s)
//    }
//}

使用viper读取配置:

package config
 
import (
    "github.com/spf13/viper"
    "os"
)
 
var Conf *Config
 
type Config struct {
    Log
}
 
type Log struct {
    Level    int
    KeepDays int
    Prefix   string
}
 
func init() {
    Conf = &Config{}
    config := viper.New()
    path, _ := os.Getwd()
    config.SetConfigName("config") // 配置文件名字,注意没有扩展名
    config.SetConfigType("toml")
    config.AddConfigPath(path)
    if err := config.ReadInConfig(); err != nil {
        panic(err)
    }
    Conf.Level = config.GetInt("log.level")
    Conf.Log.KeepDays = config.GetInt("log.keep-days")
    Conf.Log.Prefix = config.GetString("log.prefix")
}
package main
 
import (
    "my_log/log"
)
 
func main() {
    log.Debug("我是debug日志")
    log.Info("我是info日志")
    log.Warn("我是warn日志")
    log.Error("我是error日志")
}

日志配置文件(config.toml):

[log]
level = 0
keep-days = 7
prefix = "test_"

控制台输出:

生成的日志文件内容:

碰到的问题:

The process cannot access the file because it is being used by another process.

// 问题的产生:
file := "test_log.log"
os.Open(file)
file.Close()
os.Remove(file)
// 因为程序还在运行中,该日志文件所占的process还未停止
// 解决办法:
// 延迟删除文件,比如time.Sleep()
// 推荐使用:label:for + select 轮询删除,删除完毕 break:label
// 示例代码:
    loop:
        for {
            select {
            case <-time.After(10 * time.Second):
                removeErr := os.Remove(file)
                if removeErr != nil {
                    Error(removeErr.Error())
                } else {
                    Info("删除日志成功:%s", file)
                    break loop
                }
            }
        }

总结

到此这篇关于golang中log包自定义输出日志格式与写入到文件的文章就介绍到这了,更多相关go log包自定义输出日志格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用go语言实现cors中间件

    使用go语言实现cors中间件

    CORS是一种浏览器安全机制,用于控制在Web应用程序中不同源(Origin)之间的资源共享,本文将给大家介绍如何使用go语言实现cors中间件,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2023-09-09
  • Go语言HTTP服务实现GET和POST请求的同时支持

    Go语言HTTP服务实现GET和POST请求的同时支持

    做第三方接口有时需要用Get或者Post请求访问,本文主要介绍了Golang发送Get和Post请求的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-05-05
  • golang 之 wire 库的使用小结

    golang 之 wire 库的使用小结

    Wire是一个用于Go语言的编译时依赖注入库,通过代码生成提高性能和可维护性,它支持编译时依赖注入、类型安全、简单易用等功能,文章通过代码示例展示了如何使用Wire进行依赖注入,并探讨了其优点如解耦、可测试和维护性,感兴趣的朋友跟随小编一起看看吧
    2025-03-03
  • 总结Golang四种不同的参数配置方式

    总结Golang四种不同的参数配置方式

    这篇文章主要介绍了总结Golang四种不同的参数配置方式,文章围绕主题展开详细的内容戒杀,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-09-09
  • Go高级特性之并发处理http详解

    Go高级特性之并发处理http详解

    Golang 作为一种高效的编程语言,提供了多种方法来实现并发发送 HTTP 请求,本文将深入探讨 Golang 中并发发送 HTTP 请求的最佳技术和实践,希望对大家有所帮助
    2024-02-02
  • golang类型断言的实现示例

    golang类型断言的实现示例

    在Go语言中,类型断言用于从接口类型获取其具体类型的值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-10-10
  • Go语言中gPRC的使用

    Go语言中gPRC的使用

    本文主要介绍了Go语言中gPRC的使用,包括Protobuf定义服务接口、HTTP/2协议与性能优势,以及流模式和发布-订阅系统的实现,具有一定的参考价值,感兴趣的可以了解一下
    2025-07-07
  • Go泛型应用工厂方法及泛型使用

    Go泛型应用工厂方法及泛型使用

    这篇文章主要介绍了Go泛型应用工厂方法及泛型使用,结合工厂方法+泛型方法来看一下泛型到底是如何在业务场景中使用的,需要的小伙伴可以参考一下
    2022-07-07
  • Golang 1.18新特性模糊测试用法详解

    Golang 1.18新特性模糊测试用法详解

    模糊测试是一种软件测试技术。其核心思想是將自动或半自动生成的随机数据输入到一个程序中,并监视程序异常,如崩溃,断言失败,以发现可能的程序错误,比如内存泄漏,本文给大家介绍了Golang 1.18 新特性模糊测试,感兴趣的同学可以参考阅读下
    2023-05-05
  • Go语言leetcode题解953验证外星语词典示例详解

    Go语言leetcode题解953验证外星语词典示例详解

    这篇文章主要为大家介绍了Go语言leetcode题解953验证外星语词典示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12

最新评论