2. 程式人生 > 其它 >go語言web開發系列之五:gin用zap+file-rotatelogs實現日誌記錄及按日期切分日誌

go語言web開發系列之五:gin用zap+file-rotatelogs實現日誌記錄及按日期切分日誌

阿新 • • 發佈：2020-12-18

技術標籤：用go做web開發gogolangwebapilog4j2

一，安裝需要用到的庫:

1，安裝zap日誌庫:

[email protected]:/data/liuhongdi/zaplog$ go get -u go.uber.org/zap

2,安裝go-file-rotatelogs庫

[email protected]:/data/liuhongdi/zaplog2$ go get -u github.com/lestrrat/go-file-rotatelogs

說明：劉巨集締的go森林是一個專注golang的部落格，
地址：https://blog.csdn.net/weixin_43881017

說明：作者:劉巨集締 郵箱: [email protected]

二，演示專案的相關資訊

1,專案地址:

https://github.com/liuhongdi/digv05

2,專案的功能：整合zap和go-file-rotatelogs實現記錄日誌和日誌切分

3,專案結構：如圖:

三，go程式碼說明：

1,config/config.yaml

Database:
  DBType: mysql
  UserName: root
  Password: password
  Host: 127.0.0.1:3306
  DBName: dig
  Charset: utf8
  ParseTime: True
  MaxIdleConns: 10
  MaxOpenConns: 30
Server:
  RunMode: debug
  HttpPort: 8000
  ReadTimeout: 60
  WriteTimeout: 60
Log:
  LogFilePath: /data/gologs/logs
  LogInfoFileName: info
  LogWarnFileName: warn
  LogFileExt: log

2,global/logger.go

package global

import (
	"github.com/liuhongdi/digv05/pkg/zaplog"
	"go.uber.org/zap"
)

var (
	Logger *zap.SugaredLogger
)

//建立logger
func SetupLogger() (error) {
	var err error
	filepath:= LogSetting.LogFilePath
	infofilename:= LogSetting.LogInfoFileName
	warnfilename:= LogSetting.LogWarnFileName
	fileext:= LogSetting.LogFileExt

	//infofilename,warnfilename,fileext string
    Logger,err = zaplog.GetInitLogger(filepath,infofilename,warnfilename,fileext)

	if err != nil {
		return err
	}
	defer Logger.Sync()
    return nil
}

3，pkg/zaplog/zaplog.go

package zaplog

import (
	rotatelogs "github.com/lestrrat/go-file-rotatelogs"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"io"
	"time"
)

//get logger
func GetInitLogger(filepath,infofilename,warnfilename,fileext string) (*zap.SugaredLogger,error) {
	encoder := getEncoder()
	//兩個判斷日誌等級的interface
	//warnlevel以下屬於info
	infoLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
		return lvl < zapcore.WarnLevel
	})
	//warnlevel及以上屬於warn
	warnLevel := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
		return lvl >= zapcore.WarnLevel
	})

	infoWriter,err := getLogWriter(filepath+"/"+infofilename,fileext)
	if (err != nil) {
		return nil,err
	}
	warnWriter,err2 := getLogWriter(filepath+"/"+warnfilename,fileext)
	if (err2 != nil) {
		return nil,err2
	}
	//建立具體的Logger
	core := zapcore.NewTee(
		zapcore.NewCore(encoder, infoWriter, infoLevel),
		zapcore.NewCore(encoder, warnWriter, warnLevel),
	)
	loggerres := zap.New(core, zap.AddCaller())
	return loggerres.Sugar(),nil
}
//Encoder
func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	//encoderConfig := zap.NewDevelopmentEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	return zapcore.NewConsoleEncoder(encoderConfig)
}

//LogWriter
func getLogWriter(filePath,fileext string) (zapcore.WriteSyncer,error) {
	warnIoWriter,err := getWriter(filePath,fileext)
	if (err != nil) {
		return nil,err
	}
	return zapcore.AddSync(warnIoWriter),nil
}

//日誌檔案切割，按天
func getWriter(filename,fileext string) (io.Writer,error) {
	// 儲存30天內的日誌，每24小時(整點)分割一次日誌
		hook, err := rotatelogs.New(
			filename+"_%Y%m%d."+fileext,
			rotatelogs.WithLinkName(filename),
			rotatelogs.WithMaxAge(time.Hour*24*30),
			rotatelogs.WithRotationTime(time.Hour*24),
		)
	/*
	//供測試用，儲存30天內的日誌，每1分鐘(整點)分割一次日誌
	hook, err := rotatelogs.New(
		filename+"_%Y%m%d%H%M.log",
		rotatelogs.WithLinkName(filename),
		rotatelogs.WithMaxAge(time.Hour*24*30),
		rotatelogs.WithRotationTime(time.Minute*1),
	)
	*/
	if err != nil {
		//panic(err)
		return nil,err
	}
	return hook,nil
}

4,router/router.go

package router

import (
	"github.com/gin-gonic/gin"
	"github.com/liuhongdi/digv05/controller"
	"github.com/liuhongdi/digv05/global"
	"github.com/liuhongdi/digv05/pkg/result"
	"runtime/debug"
)

func Router() *gin.Engine {
	router := gin.Default()
	//處理異常
	router.NoRoute(HandleNotFound)
	router.NoMethod(HandleNotFound)
	router.Use(Recover)


	// 路徑對映
	articlec:=controller.NewArticleController()
	router.GET("/article/getone/:id", articlec.GetOne);
	router.GET("/article/list", articlec.GetList);
	return router
}

//404
func HandleNotFound(c *gin.Context) {
	global.Logger.Errorf("handle not found: %v", c.Request.RequestURI)
	//global.Logger.Errorf("stack: %v",string(debug.Stack()))
	result.NewResult(c).Error(404,"資源未找到")
	return
}

//500
func Recover(c *gin.Context) {
	defer func() {
		if r := recover(); r != nil {
			//列印錯誤堆疊資訊
			//log.Printf("panic: %v\n", r)
			global.Logger.Errorf("panic: %v", r)
			//log stack
			global.Logger.Errorf("stack: %v",string(debug.Stack()))
			//print stack
			debug.PrintStack()
			//return
			result.NewResult(c).Error(500,"伺服器內部錯誤")
		}
	}()
	//繼續後續介面呼叫
	c.Next()
}

5,global/setting.go

package global

import (
	"fmt"
	"github.com/liuhongdi/digv05/pkg/setting"
	"time"
)
//伺服器配置
type ServerSettingS struct {
	RunMode      string
	HttpPort     string
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
}
//資料庫配置
type DatabaseSettingS struct {
	DBType       string
	UserName     string
	Password     string
	Host         string
	DBName       string
	Charset      string
	ParseTime    bool
	MaxIdleConns int
	MaxOpenConns int
}
//日誌配置
type LogSettingS struct {
	LogFilePath     string    //儲存到的目錄
	LogInfoFileName string    //info級日誌檔案的名字
	LogWarnFileName string    //warn級日誌檔案的名字
	LogFileExt      string    //檔案的副檔名
}
//定義全域性變數
var (
	ServerSetting   *ServerSettingS
	DatabaseSetting *DatabaseSettingS
	LogSetting *LogSettingS
)

//讀取配置到全域性變數
func SetupSetting() error {
	s, err := setting.NewSetting()
	if err != nil {
		return err
	}
	err = s.ReadSection("Database", &DatabaseSetting)
	if err != nil {
		return err
	}

	err = s.ReadSection("Server", &ServerSetting)
	if err != nil {
		return err
	}

	err = s.ReadSection("Log", &LogSetting)
	if err != nil {
		return err
	}

	fmt.Println("setting:")
	fmt.Println(ServerSetting)
	fmt.Println(DatabaseSetting)
	fmt.Println(LogSetting)
	return nil
}

6,main.go

package main

import (
	"github.com/gin-gonic/gin"
	_ "github.com/jinzhu/gorm/dialects/mysql"
	"github.com/liuhongdi/digv05/global"
	"github.com/liuhongdi/digv05/router"
	"log"
)

//init
func init() {
	//setting
	err := global.SetupSetting()
	if err != nil {
		log.Fatalf("init.setupSetting err: %v", err)
	}

	//logger
	err = global.SetupLogger()
	if err != nil {
		log.Fatalf("init.SetupLogger err: %v", err)
	}

	//db
	err = global.SetupDBLink()
	if err != nil {
		log.Fatalf("init.SetupLogger err: %v", err)
		global.Logger.Fatalf("init.setupDBEngine err: %v", err)
	}

	global.Logger.Infof("------應用init結束")
}

func main() {
	global.Logger.Infof("------應用main函式開始")
	//設定執行模式
	gin.SetMode(global.ServerSetting.RunMode)
	//引入路由
	r := router.Router()
	//run
	r.Run(":"+global.ServerSetting.HttpPort)
}

7,其他相關程式碼請參見github

四，測試效果

1,檢視info級日誌:

啟用應用後:

[email protected]:/data/gologs/logs# more info
2020-12-16T14:37:45.666+0800	INFO	digv05/main.go:32	------應用init結束
2020-12-16T14:37:45.667+0800	INFO	digv05/main.go:36	------應用main函式開始

注意：info檔案其實是一個符號連結，指向到當前目錄下的/data/gologs/logs/info_20201216.log

[email protected]:/data/gologs/logs# ll info
lrwxrwxrwx 1 liuhongdi liuhongdi 35 12月 16 14:37 info -> /data/gologs/logs/info_20201216.log

2，檢視錯誤日誌:

訪問:

http://127.0.0.1:8000/article/getone/100

引發一次內部錯誤:我們在程式碼中故意添加了一個除0操作用來引發異常

頁面返回:

檢視錯誤日誌:

[email protected]:/data/gologs/logs# more warn
2020-12-16T14:45:37.533+0800	ERROR	router/router.go:40	panic: runtime error: integer divide by zero
2020-12-16T14:45:37.533+0800	ERROR	router/router.go:42	stack: goroutine 8 [running]:
runtime/debug.Stack(0xc0000112e8, 0xaf3002, 0xba2225)
	/usr/local/soft/go/src/runtime/debug/stack.go:24 +0x9f
github.com/liuhongdi/digv05/router.Recover.func1(0xc0002d4000)
	/data/liuhongdi/digv05/router/router.go:42 +0xdb
panic(0xaf30a0, 0x100e790)
	/usr/local/soft/go/src/runtime/panic.go:969 +0x1b9
github.com/liuhongdi/digv05/controller.(*ArticleController).GetOne(0x1053de8, 0xc0002d4000)
	/data/liuhongdi/digv05/controller/articleController.go:30 +0x1ff
github.com/gin-gonic/gin.(*Context).Next(0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/context.go:161 +0x3b
github.com/liuhongdi/digv05/router.Recover(0xc0002d4000)
	/data/liuhongdi/digv05/router/router.go:50 +0x4e
github.com/gin-gonic/gin.(*Context).Next(0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/context.go:161 +0x3b
github.com/gin-gonic/gin.RecoveryWithWriter.func1(0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/recovery.go:83 +0x65
github.com/gin-gonic/gin.(*Context).Next(0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/context.go:161 +0x3b
github.com/gin-gonic/gin.LoggerWithConfig.func1(0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/logger.go:241 +0xe5
github.com/gin-gonic/gin.(*Context).Next(0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/context.go:161 +0x3b
github.com/gin-gonic/gin.(*Engine).handleHTTPRequest(0xc0002b8000, 0xc0002d4000)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/gin.go:409 +0x67a
github.com/gin-gonic/gin.(*Engine).ServeHTTP(0xc0002b8000, 0xc84a20, 0xc0002b61c0, 0xc000398900)
	/home/liuhongdi/go/pkg/mod/github.com/gin-gonic/[email protected]/gin.go:367 +0x14d
net/http.serverHandler.ServeHTTP(0xc0002b60e0, 0xc84a20, 0xc0002b61c0, 0xc000398900)
	/usr/local/soft/go/src/net/http/server.go:2843 +0xa3
net/http.(*conn).serve(0xc00035d720, 0xc86e20, 0xc000396040)
	/usr/local/soft/go/src/net/http/server.go:1925 +0x8ad
created by net/http.(*Server).Serve
	/usr/local/soft/go/src/net/http/server.go:2969 +0x36c
...

五，檢視各庫的版本:

module github.com/liuhongdi/digv05

go 1.15

require (
	github.com/gin-gonic/gin v1.6.3
	github.com/go-playground/universal-translator v0.17.0
	github.com/go-playground/validator/v10 v10.2.0
	github.com/jinzhu/gorm v1.9.16
	github.com/lestrrat/go-file-rotatelogs v0.0.0-20180223000712-d3151e2a480f
	github.com/lestrrat/go-strftime v0.0.0-20180220042222-ba3bf9c1d042 // indirect
	github.com/magiconair/properties v1.8.4 // indirect
	github.com/mitchellh/mapstructure v1.3.3 // indirect
	github.com/pelletier/go-toml v1.8.1 // indirect
	github.com/pkg/errors v0.9.1 // indirect
	github.com/spf13/afero v1.4.1 // indirect
	github.com/spf13/cast v1.3.1 // indirect
	github.com/spf13/jwalterweatherman v1.1.0 // indirect
	github.com/spf13/pflag v1.0.5 // indirect
	github.com/spf13/viper v1.7.1
	go.uber.org/multierr v1.6.0 // indirect
	go.uber.org/zap v1.16.0
	golang.org/x/sys v0.0.0-20201119102817-f84b799fce68 // indirect
	golang.org/x/text v0.3.4 // indirect
	gopkg.in/ini.v1 v1.62.0 // indirect
	gopkg.in/yaml.v2 v2.3.0 // indirect
)

相關推薦

go語言web開發系列之五:gin用zap+file-rotatelogs實現日誌記錄及按日期切分日誌

技術標籤：用go做web開發gogolangwebapilog4j2 一，安裝需要用到的庫: 1，安裝zap日誌庫:

go語言web開發系列之十七:用go-redis+lua實現順序自增的唯一id發號器

技術標籤：用go做web開發gogolangluaredisapi 一，安裝go-redis 1,從命令列執行: [email protected]:~$ go get -u github.com/go-redis/redis/v8

第五模組 WEB開發基礎之CSS

1 CSS介紹 CSS: cascading style sheet 用來控制網頁樣式, 並允許將樣式程式碼與網頁內容分離的一種標記性語言.

第五模組 WEB開發基礎之JavaScript

1. JavaScript介紹 　　ECMAScript是一種語言標準, JavaScript是對ECMAScript的一種實現. 　　可以將ECMAScript看作JavaScript.

第五模組 WEB開發基礎之DOM

1. 快速認識DOM <!DOCTYPE html> <html> <head> <title>DOM</title> </head>

微信開發系列之七 - 使用Redis儲存微信聊天記錄

In the second blog Wechat development series 2 – development Q&A service using nodejs of this series, we have developed a kind of Q&A service in Wechat which leverages a free Tuning Restful s

Web開發初探之JavaScript 快速入門

本文改編和學習自 A JavaScript Primer For Meteor 和 MDN Web教程 前文 Web開發初探 概述

OCS部署實驗系列之五——outlook與oc整合

進入管理控制檯 為使用者新增郵箱新增 新增好使用者郵箱後 在一臺加入域的客戶機上以管理員身份登入

Go語言_通神路五耀篇(3)

>>> 1、Reader io包指定了io.Reader介面，它表示從資料流的末尾進行讀取。 Reader介面包含的方法

Web開發基礎之HTML

　　1，前端語言介紹 　　HTML 提供頁面上的內容（結構和內容） 　　CSS 對網頁進行美化（樣式）

Web開發基礎之CSS

　　什麼是CSS 　　CSS(Cascading Style Sheets)，通常稱為 CSS 樣式表或層疊樣式表（級聯樣式表）

Web開發基礎之Django

　　一，Django相關介紹 　　1，什麼是Django 　　web框架，指為解決一個開放性的問題而設計的具有一定約束性的架構。

Web開發基礎之Django三

　　一，ORM概念 　　1，ORM介紹 　　物件關係對映 用於實現面向物件程式語言裡不同型別系統資料之間的轉換。

C# 9.0新特性詳解系列之五：記錄(record)和with表示式

1 背景與動機 傳統面向物件程式設計的核心思想是一個物件有著唯一標識，表現為物件引用，封裝著隨時可變的屬性狀態，如果你改變了一個屬性的狀態，這個物件還是原來那個物件，就是物件引用沒有因為狀態的改變而改變，

Web開發基礎之CMDB系統開發之三

　　一，資產主機模組 　　1，資產主機模型設計 　　主機展示資訊表 　　常規性的收集：

動態規劃系列之五打家劫舍

題目 打家劫舍 你是一個專業的小偷，計劃偷竊沿街的房屋。每間房內都藏有一定的現金，影響你偷竊的唯一制約因素就是相鄰的房屋裝有相互連通的防盜系統，如果兩間相鄰的房屋在同一晚上被小偷闖入，系統會自動報警。

vue2.x搭建saas專案系列之五：svg icon統一管理

技術標籤：vue2.xvuesaas專案架構 此篇幅主要介紹、我們是如何做svg icon的統一管理，如有不足和建議請留言，在此感謝，專案目前階段還處在少年，一直在迭代

ClickHouse學習系列之五【系統庫system說明】

背景 　　之前介紹過ClickHouse相關的系列文章，現在ClickHouse已經能正常使用起來了，包括副本和分片。因為ClickHouse已經可以提供服務了，現在需要關心的就是服務期間該資料庫的各項效能指標的情況，如CPU、記憶體

2.GO語言的開發工具

1. VS Code+ Go外掛 不再像以前那麼霸道蠻橫, 微軟這麼多年也算做了不少挽回人心的事, 而VSCode的推出, 就算其中一件. 這個開發工具簡直太好用了, 簡單,輕快, 開放式, 幾乎沒辦法說VSCode有什麼缺點, 特別是你不喜歡

GO語言的基本語法之變數，常量，條件語句，迴圈語句

GO語言的基本語法之變數，常量，條件語句，迴圈語句 作為慕課網得筆記自己看