glog

README

glog

Log package for Golang.

Documentation

Index

• Constants
• func BasicOption(level LogLevel, toConsole bool, toFile bool, fileInfo bool) *basicOption
• func DefaultOption(debugToFile bool, infoToFile bool) *defaultOption
• func Flush()
• func FolderOption(folder string) *folderOption
• func UtcOption(utc float32) *utcOption
• type LogLevel
  • func (l LogLevel) String() string
• type Logger
  • func GetLogger(folder string, loggerName string, level LogLevel, callByStruct bool, ...) *Logger
  • func (l *Logger) CheckCaller(skip int) uintptr
  • func (l *Logger) CheckCallers()
  • func (l *Logger) Debug(message string, a ...any)
  • func (l *Logger) Error(message string, a ...any)
  • func (l *Logger) Flush()
  • func (l *Logger) Info(message string, a ...any)
  • func (l *Logger) Logout(level LogLevel, message string) error
  • func (l *Logger) SetBufferSize(size uint16)
  • func (l *Logger) SetLogLevel(level LogLevel)
  • func (l *Logger) SetOptions(options ...Option)
  • func (l *Logger) SetShiftCondition(shiftType ShiftType, times int64, size int64)
  • func (l *Logger) SetSizeLimit(size int64)
  • func (l *Logger) Warn(message string, a ...any)
• type Option
• type ShiftType
  • func (st ShiftType) String() string

Constants

const (
	SecondToNano int64 = 1e9
	HourToSecond int64 = 3600
	HourToNano   int64 = HourToSecond * SecondToNano
	DayToSecond  int64 = 24 * HourToSecond
	DayToNano    int64 = 24 * HourToNano
)

==================================================================================================== 時間轉換 ====================================================================================================

const (
	KB int64 = 1024
	MB int64 = 1024 * KB
	GB int64 = 1024 * MB
	TB int64 = 1024 * GB
	PB int64 = 1024 * TB
	EB int64 = 1024 * PB
)

==================================================================================================== 檔案大小轉換(單位：Byte) ====================================================================================================

const DISPLAYTIME string = "2006/01/02 15:04:05"

時間輸出格式

const FILEINFO int = 0b0100

const FILENAMETIME string = "2006-01-02-15-04"

檔名時間格式，間隔時間類型為 Second 的設置只在開發期間使用，因此檔名時間格式精細度到分鐘即可

const LINEINFO int = 0b1000

const TOCONSOLE int = 0b0001

是否輸出到 Console 或 輸出成檔案，由低位到高位，以二進制分別表示 1. 是否輸出到 Console 2. 是否輸出成檔案 3. 是否輸出檔案資訊 3. 是否輸出行數資訊

const TOFILE int = 0b0010

Functions

func BasicOption

func BasicOption(level LogLevel, toConsole bool, toFile bool, fileInfo bool) *basicOption

func DefaultOption

func DefaultOption(debugToFile bool, infoToFile bool) *defaultOption

func Flush

func Flush()

func FolderOption

func FolderOption(folder string) *folderOption

func UtcOption

func UtcOption(utc float32) *utcOption

Types

type LogLevel

type LogLevel int

==================================================================================================== LogLevel ====================================================================================================

const (
	DebugLevel LogLevel = iota
	InfoLevel
	WarnLevel
	ErrorLevel
)

func (LogLevel) String

func (l LogLevel) String() string

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func GetLogger

func GetLogger(folder string, loggerName string, level LogLevel, callByStruct bool, options ...Option) *Logger

func (*Logger) CheckCaller

func (l *Logger) CheckCaller(skip int) uintptr

可使用 runtime.FuncForPC(ptr) 獲得進一步的資訊

func (*Logger) CheckCallers

func (l *Logger) CheckCallers()

func (*Logger) Debug

func (l *Logger) Debug(message string, a ...any)

func (*Logger) Error

func (l *Logger) Error(message string, a ...any)

func (*Logger) Flush

func (l *Logger) Flush()

func (*Logger) Info

func (l *Logger) Info(message string, a ...any)

func (*Logger) Logout

func (l *Logger) Logout(level LogLevel, message string) error

func (*Logger) SetBufferSize

func (l *Logger) SetBufferSize(size uint16)

func (*Logger) SetLogLevel

func (l *Logger) SetLogLevel(level LogLevel)

設置 Log 輸出等級

func (*Logger) SetOptions

func (l *Logger) SetOptions(options ...Option)

可在建構子之外，設置 Logger 各項參數

func (*Logger) SetShiftCondition

func (l *Logger) SetShiftCondition(shiftType ShiftType, times int64, size int64)

func (*Logger) SetSizeLimit

func (l *Logger) SetSizeLimit(size int64)

設置每個 Log 檔的大小，超過後更新輸出位置

func (*Logger) Warn

func (l *Logger) Warn(message string, a ...any)

type Option

type Option interface {
	SetOption(*Logger)
}

type ShiftType

type ShiftType byte

==================================================================================================== ShiftType ====================================================================================================

const (
	ShiftNone ShiftType = iota
	ShiftSecond
	ShiftHour
	ShiftDay
	ShiftSize
	ShiftSecondAndSize
	ShiftHourAndSize
	ShiftDayAndSize
)

func (ShiftType) String

func (st ShiftType) String() string