golang日志框架之logrus的安裝使用教程

更新時(shí)間：2023年08月02日 09:58:54 作者：database

logrus是一個(gè)非常強(qiáng)大的日志框架,具有靈活的功能和易于使用的API,適合處理各種類型的日志需求,這篇文章主要介紹了golang日志框架之logrus的安裝使用,需要的朋友可以參考下

一、介紹

logrus是一個(gè)Golang的優(yōu)秀日志框架，可以同時(shí)輸出不同的日志等級(jí)和格式，支持hook機(jī)制，可以方便地配合其他服務(wù)使用，例如日志遠(yuǎn)程推送、郵件提醒等。

在這篇文章中，我們將討論如何使用logrus。我們將了解基本的概念、常用的用法，并講解一些常用的hook機(jī)制。

二、安裝

你可以使用如下命令安裝logrus：

go get github.com/sirupsen/logrus

三、基本用法

輸出日志

使用logrus輸出日志非常簡(jiǎn)單。只需要選擇你想要的日志級(jí)別，然后打印出來(lái)就可以了。

package main
import (
    "github.com/sirupsen/logrus"
)
func main() {
    logrus.Info("This is an informational message")
    logrus.Warn("This is a warning message")
    logrus.Error("This is an error message")
}

以上例子會(huì)輸出如下內(nèi)容：

INFO[0000] This is an informational message
WARN[0000] This is a warning message
ERRO[0000] This is an error message

注意，logrus會(huì)自動(dòng)輸出時(shí)間戳，日志級(jí)別等信息。

選擇輸出格式

logrus提供了多種格式的輸出。這些格式在logrus庫(kù)中以“Formatter”表示。當(dāng)然，你也可以自己創(chuàng)建一個(gè)自定義格式化器。

以JSON形式輸出日志：

package main
import (
    "github.com/sirupsen/logrus"
)
func main() {
    logrus.SetFormatter(&logrus.JSONFormatter{})
    logrus.Info("This is an informational message")
    logrus.Warn("This is a warning message")
    logrus.Error("This is an error message")
}

輸出的結(jié)果如下：

{"level":"info","msg":"This is an informational message","time":"2020-07-18T16:54:09+08:00"}
{"level":"warning","msg":"This is a warning message","time":"2020-07-18T16:54:09+08:00"}
{"level":"error","msg":"This is an error message","time":"2020-07-18T16:54:09+08:00"}

以Text形式輸出日志：

package main
import (
    "github.com/sirupsen/logrus"
)
func main() {
    logrus.SetFormatter(&logrus.TextFormatter{})
    logrus.Info("This is an informational message")
    logrus.Warn("This is a warning message")
    logrus.Error("This is an error message")
}

輸出的結(jié)果如下：

time="2020-07-18T16:58:01+08:00" level=info msg="This is an informational message"
time="2020-07-18T16:58:01+08:00" level=warning msg="This is a warning message"
time="2020-07-18T16:58:01+08:00" level=error msg="This is an error message"

特別提示：

在輸出時(shí)，logrus會(huì)默認(rèn)將結(jié)果輸出到Stdout（標(biāo)準(zhǔn)輸出）。

如果需要將日志輸出到指定的文件或者其他地方，可以使用logrus支持的hook機(jī)制實(shí)現(xiàn)。

四、Hook機(jī)制

logrus提供了hook機(jī)制，可以將日志輸出到多個(gè)地方。這些地方可以是本地文件、數(shù)據(jù)庫(kù)、ELK等。

以將日志輸出到本地文件為例：

package main
import (
    "os"
    "github.com/sirupsen/logrus"
    "github.com/spf13/viper"
)
func main() {
    // Read configuration from file
    viper.SetConfigType("yaml")
    viper.SetConfigName("config")
    viper.AddConfigPath(".")
    err := viper.ReadInConfig()
    if err != nil {
        logrus.Fatal("Failed to read configuration file")
    }
    // Create a file hook
    file, err := os.OpenFile(viper.GetString("log.path"), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0666)
    if err == nil {
        logrus.AddHook(&logrus.FileHook{file})
    } else {
        logrus.Warn("Failed to initialize file hook")
    }
    // Log a message
    logrus.Info("This is a message")
}

將以上代碼放到一個(gè)文件中，然后創(chuàng)建一個(gè)config.yaml文件，將下面的內(nèi)容復(fù)制到其中：