go日志库logrus的安装及快速使用

 更新时间:2022年08月04日 09:01:44   作者:王者之峰  
这篇文章主要为大家介绍了go日志库logrus的安装及快速使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

安装简介

Logrus是Go的结构化日志记录器,与标准的日志记录器库完全API兼容。

go get安装的logrus库

 go get github.com/sirupsen/logrus

快速使用

package main
import (
   log "github.com/sirupsen/logrus"
)
func main() {
   log.SetLevel(log.TraceLevel)
   log.Trace("trace")
   log.Debug("debug")
   log.Info("info")
   log.Warn("warn")
   log.Error("error")
   log.Fatal("fatal")
   log.Panic("panic")
}

输出:

TRAC[0000] trace                                        
DEBU[0000] debug                                        
INFO[0000] info                                         
WARN[0000] warn                                         
ERRO[0000] error                                        
FATA[0000] fatal                                        
exit status 1

可以看到panic没有输出,因为fatal会导致goroutine直接退出。

支持的日志级别

logrus支持多种日志级别,下面从小到大:

  • Panic:记录日志,然后panic
  • Fatal:致命错误,输出日志后,程序退出
  • Error:错误
  • Warn:警告
  • Info:关键信息
  • Debug:调试信息
  • Trace:很细粒度的信息,一般用不到。

可以看到Trace级别最大,Panic最小。默认的级别为Info,高于这个级别的日志不会输出。

日期

可以看到上面的日志没有时间,可以指定日志格式:

package main
import (
   log "github.com/sirupsen/logrus"
)
func main() {
   log.SetLevel(log.TraceLevel)
   log.SetFormatter(&log.TextFormatter{
      FullTimestamp:   true,
      TimestampFormat: "2022-07-17 00:00:00.000",
   })
   log.Trace("trace")
   log.Debug("debug")
   log.Info("info")
   log.Warn("warn")
   log.Error("error")
   log.Fatal("fatal")
   log.Panic("panic")
}

精确到毫秒。

输出:

TRAC[171717+08-77 00:00:00.628] trace                                        
DEBU[171717+08-77 00:00:00.629] debug                                        
INFO[171717+08-77 00:00:00.629] info                                         
WARN[171717+08-77 00:00:00.629] warn                                         
ERRO[171717+08-77 00:00:00.629] error                                        
FATA[171717+08-77 00:00:00.629] fatal                                        
exit status 1

打印调用位置

在进行定位的时候需要知道是那行代码调用的log.SetReportCaller(true)

package main
import (
   log "github.com/sirupsen/logrus"
)
func main() {
   log.SetLevel(log.TraceLevel)
   log.SetReportCaller(true)
   log.SetFormatter(&log.TextFormatter{
      FullTimestamp:   true,
      TimestampFormat: "2022-07-17 00:00:00.000",
   })
   log.Trace("trace")
   log.Debug("debug")
   log.Info("info")
   log.Warn("warn")
   log.Error("error")
   log.Fatal("fatal")
   log.Panic("panic")
}

输出:

TRAC[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:14 main.main() trace                                        
DEBU[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:15 main.main() debug                                        
INFO[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:16 main.main() info                                         
WARN[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:17 main.main() warn                                         
ERRO[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:18 main.main() error                                        
FATA[171717+08-77 00:00:00.019]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:19 main.main() fatal                                        
exit status 1

添加字段

定位问题需要知道具体是那个数据调用的,可以借助于log.WithFieldlog.WithFieldslog.WithField内部调用的也是log.WithFields,参数底层使用map[string]interface{}数据结构保存:

package main
import (
   log "github.com/sirupsen/logrus"
   "os"
)
func main() {
   log.SetLevel(log.TraceLevel)
   log.SetReportCaller(true)
   log.SetFormatter(&log.TextFormatter{
      FullTimestamp:   true,
      TimestampFormat: "2022-07-17 00:00:00.000",
   })
   id := os.Args[1]
   mylog := log.WithField("id", id)
   mylog.Trace("trace")
   mylog.Debug("debug")
   mylog.Info("info")
   mylog.Warn("warn")
   mylog.Error("error")
   mylog.Fatal("fatal")
   mylog.Panic("panic")
}

输出:

➜  StudyProject go run  src/log/my_log.go 123
TRAC[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:22 main.main() trace                                         id=123
DEBU[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:23 main.main() debug                                         id=123
INFO[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:24 main.main() info                                          id=123
WARN[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:25 main.main() warn                                          id=123
ERRO[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:26 main.main() error                                         id=123
FATA[171717+08-77 00:00:00.665]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:27 main.main() fatal                                         id=123
exit status 1

给字段值加引号

配置ForceQuotetrue

package main
import (
   log "github.com/sirupsen/logrus"
   "os"
)
func main() {
   log.SetLevel(log.TraceLevel)
   log.SetReportCaller(true)
   log.SetFormatter(&log.TextFormatter{
      FullTimestamp:   true,
      TimestampFormat: "2022-07-17 00:00:00.000",
      ForceQuote:      true,
   })
   id := os.Args[1]
   mylog := log.WithField("id", id)
   mylog.Trace("trace")
   mylog.Debug("debug")
   mylog.Info("info")
   mylog.Warn("warn")
   mylog.Error("error")
   mylog.Fatal("fatal")
   mylog.Panic("panic")
}

输出:

➜  StudyProject go run  src/log/my_log.go 123
TRAC[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:22 main.main() trace                                         id="123"
DEBU[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:23 main.main() debug                                         id="123"
INFO[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:24 main.main() info                                          id="123"
WARN[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:25 main.main() warn                                          id="123"
ERRO[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:26 main.main() error                                         id="123"
FATA[171717+08-77 00:00:00.427]/Users/wanghaifeng/GolandProjects/StudyProject/src/log/my_log.go:27 main.main() fatal                                         id="123"
exit status 1

设置钩子

每条日志在输出前都会执行钩子的特定方法,相当于全局拦截,可以方便做一些扩展,比如添加字段channel表明日志是那个应用输出的、增加tranceid方便对问题的跟踪、输出日志文件等。

设置channel

package hooks
import log "github.com/sirupsen/logrus"
type ChannelHook struct {
   ChannelName string
}
func (h ChannelHook) Levels() []log.Level {
   return log.AllLevels
}
func (h ChannelHook) Fire(entry *log.Entry) error {
   entry.Data["channel"] = h.ChannelName
   return nil
}
package main
import (
   logs "StudyProject/src/log/hooks"
   log "github.com/sirupsen/logrus"
)
func main() {
   log.AddHook(logs.ChannelHook{
      ChannelName: "web",
   })
   log.Info("info")
}

输出:

INFO[0000] info                                          channel=web

输出日志

可以利用logrus的hook自己写入文件,但是指定单个文件收集的时间范围、保存的时间logrus并不支持,笔者目前的项目使用的是file-rotatelogs,但是作者已经不更新和维护,所以这里就不使用它来展示,有在考虑使用goframe的glog替换。

笔者这里就写个简单例子演示如何利用logrus的hook去写文件并且把控制台的打印干掉:

package hooks
import (
   log "github.com/sirupsen/logrus"
   "io/ioutil"
)
//
//FileHook
//  @Description: 文件hook
//
type FileHook struct {
   //
   //  FileName
   //  @Description:  文件名
   //
   FileName string
}
func (h FileHook) Levels() []log.Level {
   return log.AllLevels
}
func (h FileHook) Fire(entry *log.Entry) error {
   fomat := &log.TextFormatter{
      FullTimestamp:   true,
      TimestampFormat: "2022-07-17 00:00:00.000",
   }
   //  从entry从获得日志内容
   msg, err := fomat.Format(entry)
   if err != nil {
      return err
   }
   err = ioutil.WriteFile(h.FileName, msg, 0644)
   if err != nil {
      return err
   }
   return nil
}
package main
import (
   logs "StudyProject/src/log/hooks"
   log "github.com/sirupsen/logrus"
   "io/ioutil"
)
func main() {
   log.AddHook(logs.FileHook{"log"})
   //  关闭控制台打印
   log.SetOutput(ioutil.Discard)
   log.Info("test log write file")
}

很显然这只是个例子,不可直接应用于生产。

以上就是go日志库logrus的安装及快速使用的详细内容,更多关于go日志库logrus安装使用的资料请关注脚本之家其它相关文章!

相关文章

  • Go gRPC服务进阶middleware使用教程

    Go gRPC服务进阶middleware使用教程

    这篇文章主要为大家介绍了Go gRPC服务进阶middleware的使用教程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • Go语言JSON解析器gjson使用方法详解

    Go语言JSON解析器gjson使用方法详解

    这篇文章主要介绍了Go语言json解析框架与gjson,JSON 解析是我们不可避免的常见问题,在Go语言中,我们可以借助gjson库来方便的进行json属性的提取与解析,需要的朋友可以参考一下
    2022-12-12
  • Go语言扩展原语之Semaphore的用法详解

    Go语言扩展原语之Semaphore的用法详解

    Go语言的扩展包中提供了带权重的信号量 semaphore.Weighted,让我们可以按照不同的权重管理资源的访问,下面小编就来和大家聊聊它们的具体用法吧
    2023-07-07
  • go语言之给定英语文章统计单词数量(go语言小练习)

    go语言之给定英语文章统计单词数量(go语言小练习)

    这篇文章给大家分享go语言小练习给定英语文章统计单词数量,实现思路大概是利用go语言的map类型,以每个单词作为关键字存储数量信息,本文通过实例代码给大家介绍的非常详细,需要的朋友参考下吧
    2020-01-01
  • Go语言中循环语句使用的示例详解

    Go语言中循环语句使用的示例详解

    在不少实际问题中有许多具有规律性的重复操作,因此在程序中就需要重复执行某些语句。本文将通过示例详细为大家讲讲Go语言中的循环语句,需要的可以参考一下
    2022-04-04
  • 详解Golang中使用map时的注意问题

    详解Golang中使用map时的注意问题

    Golang中的map是一种数据结构,它允许你使用键值对的形式存储和访问数据,map在Go中是非排序的,提供了高效查找、插入和删除元素的能力,特别是当键是不可变类型,本文给大家详细介绍了Golang中使用map时的注意问题,需要的朋友可以参考下
    2024-06-06
  • Go利用反射reflect实现获取接口变量信息

    Go利用反射reflect实现获取接口变量信息

    反射是通过实体对象获取反射对象(Value、Type),然后可以操作相应的方法。本文将利用Go语言中的反射reflect实现获取接口变量信息,需要的可以参考一下
    2022-05-05
  • go语言使用pipe读取子进程标准输出的方法

    go语言使用pipe读取子进程标准输出的方法

    这篇文章主要介绍了go语言使用pipe读取子进程标准输出的方法,实例分析了Go语言针对进程操作的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-03-03
  • go-kit组件使用hystrix中间件的操作

    go-kit组件使用hystrix中间件的操作

    这篇文章主要介绍了go-kit组件使用hystrix中间件的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • 详解Golang中Context的原理和使用技巧

    详解Golang中Context的原理和使用技巧

    Golang 的 Context 包,中文可以称之为“上下文”,是用来在 goroutine 协程之间进行上下文信息传递的,这些上下文信息包括 kv 数据、取消信号、超时时间、截止时间等。本文主要介绍了Context的原理和使用技巧,希望对大家有所帮助
    2022-11-11

最新评论