rlog

Documentation

Index

• Constants
• func Debug(a ...any)
• func Error(a ...any)
• func Finish()
• func GetLogPrevLength() uint
• func GetLogRankConsole() uint
• func GetLogRankFile() uint
• func Info(a ...any)
• func InitConfig(c Config)
• func Panic(a ...any)
• func SetAutoRemoveLogFile(logDir string, day uint)
• func SetLogFilePath(debugFile, infoFile, warnFile, errorFile, panicFile string, maxByte uint64)
• func SetLogPrevLength(length uint)
• func SetLogRank(prevLength, consoleRank, fileRank uint)
• func SetPrevTime(format string)
• func Warn(a ...any)
• type Config

Constants

const (
	LogDebug    = iota //调试 0
	LogInfo            //信息 1
	LogWarn            //警告 2
	LogError           //错误 3
	LogPanic           //恐慌 4
	LogNotPrint        //不打印 5
)

const MustPrintAll noFilePath = 2 //必须打印控制台日志&文件日志，并且不打印路径

const MustPrintConsole noFilePath = 3 //必须打印控制台日志，并且不打印路径

const MustPrintFile noFilePath = 4 //必须打印文件日志，并且不打印路径

const NoFilePath noFilePath = 1 //不打印路径

Functions

func Debug

func Debug(a ...any)

func Error

func Error(a ...any)

func Finish

func Finish()

Finish 为了保证所有日志打印完毕，建议在程序结束前，运行这个。

func GetLogPrevLength

func GetLogPrevLength() uint

GetLogPrevLength 返回打印日志，文件路径前面省略字节数

func GetLogRankConsole

func GetLogRankConsole() uint

GetLogRankConsole 获取打印到控制台的日志等级

func GetLogRankFile

func GetLogRankFile() uint

GetLogRankFile 获取打印到文件的日志等级

func Info

func Info(a ...any)

func InitConfig

func InitConfig(c Config)

InitConfig 初始化日志打印配置，为了保证所有日志输出完毕，请在程序终止前，执行 rlog.Finish() 函数。 初始化的目的，是为了打印日志到文件，如果不打印到文件。则不需要执行本函数的初始化。

func Panic

func Panic(a ...any)

func SetAutoRemoveLogFile

func SetAutoRemoveLogFile(logDir string, day uint)

SetAutoRemoveLogFile 设置自动删除多少天以前的日志 注意，该删除，会删除 logDir 下所有的子目录日志。 删除方式是根据文件的最后修改时间来判断，进行删除的。

func SetLogFilePath

func SetLogFilePath(debugFile, infoFile, warnFile, errorFile, panicFile string, maxByte uint64)

SetLogFilePath 设置日志文件地址，不设置地址，不打印到文件。

func SetLogPrevLength

func SetLogPrevLength(length uint)

SetLogPrevLength 设置日志打印，文件路径前面过滤多少个字符

func SetLogRank

func SetLogRank(prevLength, consoleRank, fileRank uint)

SetLogRank 设置日志打印等级 prevLength：项目地址前面省去多少字符

func SetPrevTime

func SetPrevTime(format string)

SetPrevTime 设置行首日期格式。默认 "2006/01/02·15:04:05"

func Warn

func Warn(a ...any)

Types

type Config

type Config struct {
	//PrevLength 可以通过以下代码，计算出你的项目地址，前缀长度。
	//	getwd, _ := os.Getwd()
	//	fmt.Println(len(getwd) + 1)
	//但，需要注意的是， PrevLength 必须是固定值，而不能使用动态计算前缀长度的方式。
	PrevLength  uint   `json:"prev_length"`   //日志打印地址前面省略多少个字符，0则打印完整地址。默认0。
	ConsoloRank uint   `json:"consolo_rank"`  //控制台日志打印等级
	FileRank    uint   `json:"file_rank"`     //文件日志打印等级
	MaxFileSize uint64 `json:"max_file_size"` //日志文件最大大小，1024 * 1024 * 1  为 1MB，如果该值为0，那么执行默认 1MB 。
	DebugFile   string `json:"debug_file"`    //Debug日志文件路径
	InfoFile    string `json:"info_file"`     //Info日志文件路径
	WarnFile    string `json:"warn_file"`     //Warn日志文件路径
	ErrorFile   string `json:"error_file"`    //Error日志文件路径
	PanicFile   string `json:"panic_file"`    //Panic日志文件路径
}