logrusKit

Documentation

Index

• Variables
• func DisableQuote(logger *logrus.Logger)
• func DisableQuoteTemporarily(logger *logrus.Logger, callback func(logger *logrus.Logger))
• func DisposeLogger(logger *logrus.Logger) error
• func EnableQuote(logger *logrus.Logger)
• func MustSetUp(config *Config)
• func NewFileLogger(filePath string, options ...LoggerOption) (*logrus.Logger, error)
• func NewLogger(options ...LoggerOption) *logrus.Logger
• func NewTextFormatter(timestampFormat string) *logrus.TextFormatter
• func ParseLevel(str string) (logrus.Level, error)
• func PrintBasicDetails(logger *logrus.Logger)
• func SetUp(config *Config) error
• type Config
• type LoggerOption
  • func WithFormatter(formatter logrus.Formatter) LoggerOption
  • func WithLevel(level logrus.Level) LoggerOption
  • func WithOutput(output io.Writer) LoggerOption
  • func WithReportCaller(reportCaller bool) LoggerOption

Variables

var (
	DefaultTextFormatter = NewTextFormatter("")
)

Functions

func DisableQuote

func DisableQuote(logger *logrus.Logger)

DisableQuote

PS: 输出中存在 换行字符\n 的话，只有禁掉双引号才会生效.

func DisableQuoteTemporarily

func DisableQuoteTemporarily(logger *logrus.Logger, callback func(logger *logrus.Logger))

DisableQuoteTemporarily 临时禁用双引号(")

@param logger (1) 可以为nil（此时将采用logrus.StandardLogger()）

(2) 只有当formatter为 *logrus.TextFormatter 类型，DisableQuote才会生效

func DisposeLogger

func DisposeLogger(logger *logrus.Logger) error

DisposeLogger 释放资源（主要针对文件日志）

func EnableQuote

func EnableQuote(logger *logrus.Logger)

func MustSetUp

func MustSetUp(config *Config)

func NewFileLogger

func NewFileLogger(filePath string, options ...LoggerOption) (*logrus.Logger, error)

NewFileLogger 输出到文件(not rotatable).

func NewLogger

func NewLogger(options ...LoggerOption) *logrus.Logger

NewLogger

PS: (1) 如果希望 输出到文件 且 rotatable，可以使用 WithOutput()，详见下例.

@param options 可以什么都不配置（此时输出到控制台）

func NewTextFormatter

func NewTextFormatter(timestampFormat string) *logrus.TextFormatter

NewTextFormatter

PS: 外部在调用此方法后，建议调用: Logger.SetReportCaller(true)!!!

@param timestampFormat 可以为""（将采用默认值）

e.g. 日志输出 time=2023-03-23 16:46:23.398+08:00 level=info msg=[CHIMERA, PROCESS] pid: [8579]. func=PrintBasicDetails(logrusKit/basicDetails.go:17) time=2023-03-23 16:46:23.398+08:00 level=info msg=[CHIMERA, OS] os: [darwin]. func=PrintBasicDetails(logrusKit/basicDetails.go:20) time=2023-03-23 16:46:23.398+08:00 level=info msg=[CHIMERA, OS] arch: [arm64]. func=PrintBasicDetails(logrusKit/basicDetails.go:21)

func ParseLevel

func ParseLevel(str string) (logrus.Level, error)

ParseLevel string => logrus.Level

PS: 默认日志级别 Debug.

func PrintBasicDetails

func PrintBasicDetails(logger *logrus.Logger)

PrintBasicDetails 输出服务器的基本信息（以便于甩锅）

func SetUp

func SetUp(config *Config) error

SetUp

PS: 可以多次调用.

@param config 可以为nil（采用默认值）

Types

type Config

type Config struct {
	Level      string `json:"level,default=debug" yaml:"level"`
	PrintBasic bool   `json:"printBasic,default=false" yaml:"printBasic"`
}

type LoggerOption

type LoggerOption func(opts *loggerOptions)

func WithFormatter

func WithFormatter(formatter logrus.Formatter) LoggerOption

func WithLevel

func WithLevel(level logrus.Level) LoggerOption

func WithOutput

func WithOutput(output io.Writer) LoggerOption

func WithReportCaller

func WithReportCaller(reportCaller bool) LoggerOption