logx

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

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

type LogConf struct {
	// ServiceName represents the service name.
	ServiceName string `config:",optional"`
	// Mode represents the logging mode, default is `console`.
	// console: log to console.
	// file: log to file.
	// volume: used in k8s, prepend the hostname to the log file name.
	Mode string `config:",default=console,options=[console,file,volume]"`
	// Encoding represents the encoding type, default is `json`.
	// json: json encoding.
	// plain: plain text encoding, typically used in development.
	Encoding string `config:",default=json,options=[json,plain]"`
	// TimeFormat represents the time format, default is `2006-01-02T15:04:05.000Z07:00`.
	TimeFormat string `config:",optional"`
	// Path represents the log file path, default is `logs`.
	Path string `config:",default=logs"`
	// Level represents the log level, default is `info`.
	Level string `config:",default=info,options=[debug,info,error,severe]"`
	// MaxContentLength represents the max content bytes, default is no limit.
	MaxContentLength uint32 `config:",optional"`
	// Compress represents whether to compress the log file, default is `false`.
	Compress bool `config:",optional"`
	// Stat represents whether to log statistics, default is `true`.
	Stat bool `config:",default=true"`
	// KeepDays represents how many days the log files will be kept. Default to keep all files.
	// Only take effect when Mode is `file` or `volume`, both work when Rotation is `daily` or `size`.
	KeepDays int `config:",optional"`
	// StackCooldownMillis represents the cooldown time for stack logging, default is 100ms.
	StackCooldownMillis int `config:",default=100"`
	// MaxBackups represents how many backup log files will be kept. 0 means all files will be kept forever.
	// Only take effect when RotationRuleType is `size`.
	// Even though `MaxBackups` sets 0, log files will still be removed
	// if the `KeepDays` limitation is reached.
	MaxBackups int `config:",default=0"`
	// MaxSize represents how much space the writing log file takes up. 0 means no limit. The unit is `MB`.
	// Only take effect when RotationRuleType is `size`
	MaxSize int `config:",default=0"`
	// Rotation represents the type of log rotation rule. Default is `daily`.
	// daily: daily rotation.
	// size: size limited rotation.
	Rotation string `config:",default=daily,options=[daily,size]"`
	// FileTimeFormat represents the time format for file name, default is `2006-01-02T15:04:05.000Z07:00`.
	FileTimeFormat string `config:",optional"`
	// FieldKeys represents the field keys.
	FieldKeys fieldKeyConf `config:",optional"`
}

type LogField struct {
	Key   string
	Value any
}

type LogOption func(options *logOptions)

type Logger interface {
	// Debug logs a message at debug level.
	Debug(...any)
	// Debugf logs a message at debug level.
	Debugf(string, ...any)
	// Debugfn logs a message at debug level.
	Debugfn(func() any)
	// Debugv logs a message at debug level.
	Debugv(any)
	// Debugw logs a message at debug level.
	Debugw(string, ...LogField)
	// Error logs a message at error level.
	Error(...any)
	// Errorf logs a message at error level.
	Errorf(string, ...any)
	// Errorfn logs a message at error level.
	Errorfn(func() any)
	// Errorv logs a message at error level.
	Errorv(any)
	// Errorw logs a message at error level.
	Errorw(string, ...LogField)
	// Info logs a message at info level.
	Info(...any)
	// Infof logs a message at info level.
	Infof(string, ...any)
	// Infofn logs a message at info level.
	Infofn(func() any)
	// Infov logs a message at info level.
	Infov(any)
	// Infow logs a message at info level.
	Infow(string, ...LogField)
	// Slow logs a message at slow level.
	Slow(...any)
	// Slowf logs a message at slow level.
	Slowf(string, ...any)
	// Slowfn logs a message at slow level.
	Slowfn(func() any)
	// Slowv logs a message at slow level.
	Slowv(any)
	// Sloww logs a message at slow level.
	Sloww(string, ...LogField)
	// WithCallerSkip returns a new logger with the given caller skip.
	WithCallerSkip(skip int) Logger
	// WithContext returns a new logger with the given context.
	WithContext(ctx context.Context) Logger
	// WithDuration returns a new logger with the given duration.
	WithDuration(d time.Duration) Logger
	// WithFields returns a new logger with the given fields.
	WithFields(fields ...LogField) Logger
}

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

type RotateRule interface {
	BackupFileName() string
	MarkRotated()
	OutdatedFiles() []string
	ShallRotate(size int64) bool
}

type Sensitive interface {
	// MaskSensitive masks sensitive information in the log.
	MaskSensitive() any
}

type SizeLimitRotateRule struct {
	DailyRotateRule
	// contains filtered or unexported fields
}

type Writer interface {
	// Alert sends an alert message, if your writer implemented alerting functionality.
	Alert(v any)
	// Close closes the writer.
	Close() error
	// Debug logs a message at debug level.
	Debug(v any, fields ...LogField)
	// Error logs a message at error level.
	Error(v any, fields ...LogField)
	// Info logs a message at info level.
	Info(v any, fields ...LogField)
	// Severe logs a message at severe level.
	Severe(v any)
	// Slow logs a message at slow level.
	Slow(v any, fields ...LogField)
	// Stack logs a message at error level.
	Stack(v any)
	// Stat logs a message at stat level.
	Stat(v any, fields ...LogField)
}