logrus日誌框架

来源:https://www.cnblogs.com/Hollson/archive/2020/01/08/12169224.html
-Advertisement-
Play Games

[toc] logrus介紹 golang標準庫的日誌框架非常簡單，僅僅提供了print，panic和fatal三個函數。對於更精細的日誌級別、日誌文件分割，以及日誌分發等方面，並沒有提供支持。在golang的世界，流行的日誌框架包括logrus、zap、zerolog、seelog等。 logru ...


目錄


logrus介紹

golang標準庫的日誌框架非常簡單，僅僅提供了print，panic和fatal三個函數。對於更精細的日誌級別、日誌文件分割，以及日誌分發等方面，並沒有提供支持。在golang的世界，流行的日誌框架包括logrus、zap、zerolog、seelog等。


logrus配置

1. 日誌級別： logrus有7個日誌級別，依次是Trace << Debug << Info << Warning << Error << Fatal << Panic

//  只輸出不低於當前級別是日誌數據
logrus.SetLevel(logrus.DebugLevel)

2. 日誌格式： logrus內置了JSONFormatter和TextFormatter兩種格式，也可以通過Formatter介面定義日誌格式

 // TextFormatter格式
 logrus.SetFormatter(&logrus.TextFormatter{
    ForceColors:               true,
    EnvironmentOverrideColors: true,
    TimestampFormat:           "2006-01-02 15:04:05", //時間格式
    // FullTimestamp:true,
    // DisableLevelTruncation:true,
 })
 // JSONFormatter格式
 logrus.SetFormatter(&logrus.JSONFormatter{
    PrettyPrint:     false,                 //格式化
    TimestampFormat: "2006-01-02 15:04:05", //時間格式
 })

3. 輸出文件：

 logfile, _ := os.OpenFile("./app.log", os.O_CREATE|os.O_RDWR|os.O_APPEND, 0644)
 logrus.SetOutput(logfile) //預設為os.stderr

4. 日誌定位： 定位行號（如：func=main.main file="./xxx.go:38"）

logrus.SetReportCaller(true)

示例：

func init() {
   logrus.SetLevel(logrus.DebugLevel)

   logrus.SetFormatter(&logrus.JSONFormatter{
      TimestampFormat: "2006-01-02 15:04:05",
   })

   logfile, _ := os.OpenFile("./app.log", os.O_CREATE|os.O_RDWR|os.O_APPEND, 0644)
   logrus.SetOutput(logfile) //預設為os.stderr
}

//方式一：logrus函數（最終調用的是logrus.StandardLogger預設實例方法）
func main() {
   logrus.Infoln("測試數據")
}


日誌列印

FieldLogger介面： FieldLogger定義了所有日誌列印的方法

type FieldLogger interface {
   WithField(key string, value interface{}) *Entry
   WithFields(fields Fields) *Entry
   WithError(err error) *Entry

   Debugf(format string, args ...interface{})
   Infof(format string, args ...interface{})
   Printf(format string, args ...interface{})
   Warnf(format string, args ...interface{})
   Warningf(format string, args ...interface{})
   Errorf(format string, args ...interface{})
   Fatalf(format string, args ...interface{})
   Panicf(format string, args ...interface{})

   Debug(args ...interface{})
   Info(args ...interface{})
   Print(args ...interface{})
   Warn(args ...interface{})
   Warning(args ...interface{})
   Error(args ...interface{})
   Fatal(args ...interface{})
   Panic(args ...interface{})

   Debugln(args ...interface{})
   Infoln(args ...interface{})
   Println(args ...interface{})
   Warnln(args ...interface{})
   Warningln(args ...interface{})
   Errorln(args ...interface{})
   Fatalln(args ...interface{})
   Panicln(args ...interface{})
}

日誌列印1： 預設實例 (函數)，即通過logrus包提供的函數(覆蓋了FieldLogger介面的所有方法)，直接列印日誌。但其實logrus包函數是調用了logrus.Loger預設實例。

// 直接調用包函數
func main() {
   logrus.Infoln("...")
   logrus.Errorln("...")
   // ...
}

日誌列印2：Logger實例(對象)，它實現了FieldLogger介面。

func main() {
   //var loger = logrus.StandardLogger()
   var loger = logrus.New()
   loger.Formatter = &logrus.JSONFormatter{TimestampFormat: "2006-01-02 15:04:05"}
   loger.Infoln("可以創建任意數量的logrus實例")
}

日誌列印3：Entry示例(對象)，它也實現了FieldLogger介面，是最終是日誌列印入口。

  • 這裡用到了Field機制，logrus鼓勵通過Field機制進行精細化的、結構化的日誌記錄，而不是通過冗長的消息來記錄日誌。
func main() {
   logrus.SetFormatter(&logrus.JSONFormatter{TimestampFormat: "2006-01-02 15:04:05"})

   // Entry實例
   entry := logrus.WithFields(logrus.Fields{
      "global": "全局欄位",
   })

   entry.WithFields(logrus.Fields{"module": "用戶模塊"}).
      Info("測試ok")
}


HOOK機制

  • hook即鉤子，攔截器。它為logrus提供了強大的功能擴展，如將日誌分發到任意地方，如本地文件系統、logstash、es等，或者切割日誌、定義日誌內容和格式等。hook介面原型如下：
type Hook interface {
   Levels() []Level   //日誌級別
   Fire(*Entry) error //列印入口（Entry對象）
}

Hook - 日誌切割：

import (
   "github.com/lestrrat-go/file-rotatelogs"
   "github.com/rifflock/lfshook"
   "github.com/sirupsen/logrus"
   "time"
)

//  說明：按時間切割日誌文件（2秒創建一個日誌文件）
func main() {
   hook := NewLfsHook("app_hook", time.Second*2, 5)
   logrus.AddHook(hook)

   logrus.Infoln("測試開始")
   log := logrus.WithFields(logrus.Fields{"module": "用戶模塊"})

   for i := 0; i < 10; i++ {
      log.Infoln("成功", i)
      time.Sleep(time.Second)
   }
}

// 日誌鉤子(日誌攔截，並重定向)
func NewLfsHook(logName string, rotationTime time.Duration, leastDay uint) logrus.Hook {
   writer, err := rotatelogs.New(
      // 日誌文件
      logName+".%Y%m%d%H%M%S",

      // 日誌周期(預設每86400秒/一天旋轉一次)
      rotatelogs.WithRotationTime(rotationTime),

      // 清除歷史 (WithMaxAge和WithRotationCount只能選其一)
      //rotatelogs.WithMaxAge(time.Hour*24*7), //預設每7天清除下日誌文件
      rotatelogs.WithRotationCount(leastDay), //只保留最近的N個日誌文件
   )
   if err != nil {
      panic(err)
   }

   // 可設置按不同level創建不同的文件名
   lfsHook := lfshook.NewHook(lfshook.WriterMap{
      logrus.DebugLevel: writer,
      logrus.InfoLevel:  writer,
      logrus.WarnLevel:  writer,
      logrus.ErrorLevel: writer,
      logrus.FatalLevel: writer,
      logrus.PanicLevel: writer,
   }, &logrus.JSONFormatter{TimestampFormat: "2006-01-02 15:04:05"})

   return lfsHook
}

Hook - Redis重定向： 即將日誌輸出到redis

import (
   logredis "github.com/rogierlommers/logrus-redis-hook"
   "io/ioutil"
   "github.com/sirupsen/logrus"
)

func init() {
   hookConfig := logredis.HookConfig{
      Host:     "localhost",
      Key:      "test",
      Format:   "v1",
      App:      "my_app_name",
      Port:     6379,
      Hostname: "my_app_hostname", 
      DB:       0, // optional
      TTL:      3600,
   }

   hook, err := logredis.NewHook(hookConfig)
   if err == nil {
      logrus.AddHook(hook)
   } else {
      logrus.Errorf("logredis error: %q", err)
   }
}

func main() {
   logrus.WithFields(logrus.Fields{
      "module": "user"}).
      Info("user login")

   // If you want to disable writing to stdout, use setOutput
   logrus.SetOutput(ioutil.Discard)
   logrus.Info("log to Redis")
}

// 測試：
// 1.啟動redis服務： redis-server
// 2.監控redis數據： redis-cli monitor

其他Hook：


Gin日誌

  • 將gin框架的日誌定向到logrus日誌文件
func init() {
   // 輸出格式
   logrus.SetFormatter(&logrus.JSONFormatter{TimestampFormat: "2006-01-02 15:04:05"})

   // 輸出路徑
   logfile, _ := os.OpenFile("./app.log", os.O_CREATE|os.O_RDWR|os.O_APPEND, 0644)
   logrus.SetOutput(logfile)

   // Gin日誌重定向
   gin.DisableConsoleColor()                              //不需要顏色
   gin.DefaultWriter = io.MultiWriter(os.Stdout, logfile) //os.Stdout
}

//測試：curl 0.0.0.0:8080/index
func main() {
   log := logrus.WithFields(logrus.Fields{
      "module": "用戶模塊",
   })

   r := gin.Default()
   r.GET("/index", func(c *gin.Context) {
      log.Warnln("gin日誌數據")
      c.String(200, "ok")
   })
   _ = r.Run()
}


Fatal處理

  • logrus的Fatal輸出，會執行os.Exit(1)。logrus提供RegisterExitHandler方法，可以在系統異常時調用一些資源釋放api等，讓應用正確地關閉。
func main() {
   logrus.RegisterExitHandler(func() {
      fmt.Println("發生了fatal異常，執行關閉文件等工作")
   })

   logrus.Warnln("warn測試")
   logrus.Fatalln("fatal測試")
   logrus.Infoln("info測試") //不會執行
}


線程安全

  • 預設情況下，logrus的api都是線程安全的，其內部通過互斥鎖來保護併發寫。互斥鎖在調用hooks或者寫日誌的時候執行。如果不需要鎖，可以調用logger.SetNoLock()來關閉之。
    可以關閉logrus互斥鎖的情形包括：
  • 沒有設置hook，或者所有的hook都是線程安全的實現。
  • 寫日誌到logger.Out已經是線程安全的了。例如，logger.Out已經被鎖保護，或者寫文件時，文件是以O_APPEND方式打開的，並且每次寫操作都小於4k。


參考

https://blog.csdn.net/wslyk606/article/details/81670713


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 鬆軟科技Web課堂:AJAX 簡介
    AJAX AJAX 並不是編程語言。 AJAX 是一種從網頁訪問 Web 伺服器的技術。 AJAX 代表非同步 JavaScript 和 XML。 AJAX 實例解釋 HTML 頁面 這張 HTML 頁麵包含一個 <div> 和一個 <button>。 <div> 用於顯示來自伺服器的信息。 <but ...
  • 長鏈生成短鏈的思考
    一些業務場景，比如說簡訊、push需要帶上跳轉鏈接，這個時候就需要把長鏈轉換為短鏈 長鏈如何轉短鏈？其實長鏈和生成短鏈的過程是沒有任何關係的，唯一的聯繫就是生成以後做關聯 1：短鏈生成 結合實際工作中以及網上，大概兩種比較常規的方式，預設生成六位短鏈 方式一：通過移位+簡單的演算法生成一個隨機數 第一 ...
  • CDC+ETL實現數據集成方案
    數據集成有兩種方案： 一種是通過ESB介面方式進行數據集成，優點是數據的時效性高，但最大的弊端是依賴於業務系統的介面改造，往往會涉及和廠商的介面費用。另一種方式就是通過ETL方式抽取數據，並通過CDC方式實現數據實時同步，優點是不依賴於業務系統，只需要獲取業務系統資料庫許可權便可實現集成。 ...
  • 架構師，怎樣才能搞定上下游客戶？
    架構師，在開展工作的過程中需要對接老闆、產品、項目、開發、測試、安全和運營等各種崗位角色，他們都是架構需要關註和服務的內部客戶，他們的痛點就是架構工作的驅動因素。架構師就是要用專業技能“搞定”這些角色的需求，輸出大家都能接受的解決方案，大家好才是真正的好。為了達成此目的，我們必須知道不同崗位的關註點... ...
  • spring cloud微服務快速教程之（六） 應用監控 spring boot admin
    0-前言 當我們發佈了微服務後，我們希望對各個應用的各個運行狀況進行一個監控；這個時候spring boot admin，就出場了； spring boot admin：是一個監控和管理spring boot 應用的開源監控組件， 它能夠對Actuator 中的信息進行界面化的展示，也可以監控所有 ...
  • JFrame的面板結構和JPanel的使用
    JFrame圖解結構 有一視窗框架實例：JFrame win = new JFrame("視窗");在new JFrame()時，構建了JFrame實例對象，在實例中的Layered Pane層面版中，也預設構建了一個JPanel控制項面板。 使用 win.getContentPane( ); 是獲取 ...
  • Python爬蟲連載1-urllib.request和chardet包使用方式
    一、參考資料 1.《Python網路數據採集》圖靈工業出版社 2.《精通Python爬蟲框架Scrapy》人民郵電出版社 3.[Scrapy官方教程](http://scrapy-chs.readthedocs.io/zh_CN/0.24/intro/tutorial.html) 4.[Python ...
  • JSP頁面中<%!%>與<%%>與<%=%>
    1.<% %>叫做腳本片段，其中寫的內容會翻譯在Servlet的Service方法中，顯然我們可以在Service方法中定義局部變數或者調用其他方法，但是不能 在Service中再定義其他的方法，也就是我們可以在<%%>中定義局部變數或者調用方法，但不能定義方法。在jsp頁面可以有多個腳本片段，但是 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類