log

package module

Go to main page

Versions in this module

v1

v1.6.0

Jan 7, 2026

Changes in this version

+ const ConfigKey

v1.5.2

Dec 14, 2025

v1.5.1

Sep 14, 2025

v1.5.0

Aug 28, 2025

Changes in this version

+ const DefaultConsoleOutput

type Builder

+ func (b *Builder) ConsoleOutput(enable bool) *Builder

type Options

+ ConsoleOutput bool

+ func (opt *Options) WithConsoleOutput(enable bool) *Options

v1.4.0

Aug 27, 2025

Changes in this version

+ const DefaultEnableSampling

+ const DefaultSampleInitial

+ const DefaultSampleThereafter

+ const FormatConsole

+ const FormatJSON

+ const LevelDebug

+ const LevelInfo

+ var ErrInvalidDirectory = errors.New("无效的日志目录")

+ var ErrInvalidFilename = errors.New("无效的文件名")

+ var ErrInvalidFormat = errors.New("无效的日志格式")

+ var ErrInvalidLevel = errors.New("无效的日志级别")

+ var ErrInvalidMaxBackups = errors.New("无效的最大备份数量")

+ var ErrInvalidMaxSize = errors.New("无效的最大文件大小")

+ var ErrInvalidSampling = errors.New("无效的采样配置")

+ var ErrInvalidTimeLayout = errors.New("无效的时间格式")

+ var ErrPermissionDenied = errors.New("权限被拒绝")

+ func HTTPMiddleware(logger Logger) func(http.Handler) http.Handler

+ func IsConfigError(err error) bool

+ type Builder struct

+ func NewBuilder() *Builder

+ func (b *Builder) Build() *Log

+ func (b *Builder) Compress(compress bool) *Builder

+ func (b *Builder) Development() *Builder

+ func (b *Builder) Directory(dir string) *Builder

+ func (b *Builder) DisableCaller(disable bool) *Builder

+ func (b *Builder) DisableSplitError(disable bool) *Builder

+ func (b *Builder) DisableStacktrace(disable bool) *Builder

+ func (b *Builder) Filename(filename string) *Builder

+ func (b *Builder) Format(format string) *Builder

+ func (b *Builder) Level(level string) *Builder

+ func (b *Builder) MaxBackups(backups int) *Builder

+ func (b *Builder) MaxSize(size int) *Builder

+ func (b *Builder) Prefix(prefix string) *Builder

+ func (b *Builder) Production() *Builder

+ func (b *Builder) Sampling(enable bool, initial, thereafter int) *Builder

+ func (b *Builder) Testing() *Builder

+ func (b *Builder) TimeLayout(layout string) *Builder

+ type ConfigError struct

+ Field string

+ Reason string

+ Value any

+ Wrapped error

+ func GetConfigErrors(err error) []*ConfigError

+ func NewConfigError(field string, value any, reason string, wrapped error) *ConfigError

+ func (e *ConfigError) Error() string

+ func (e *ConfigError) Unwrap() error

type Log

+ func FromConfigFile(configPath string) (*Log, error)

+ func Quick() *Log

+ func WithPreset(preset *Preset) *Log

type Options

+ EnableSampling bool

+ SampleInitial int

+ SampleThereafter int

+ func LoadFromFile(configPath string) (*Options, error)

+ func LoadFromJSON(jsonPath string) (*Options, error)

+ func LoadFromTOML(tomlPath string) (*Options, error)

+ func LoadFromYAML(yamlPath string) (*Options, error)

+ func RecoverFromConfigError(err error) *Options

+ func ValidateAndFixOptions(opts *Options) *Options

+ func ValidateOptions(opts *Options) (*Options, error)

+ func (opt *Options) WithSampling(enable bool, initial, thereafter int) *Options

+ type Preset struct

+ func DevelopmentPreset() *Preset

+ func ProductionPreset() *Preset

+ func TestingPreset() *Preset

+ func (p Preset) Apply(opts *Options)

+ func (p Preset) Description() string

+ func (p Preset) Name() string

v1.3.0

Aug 26, 2025

Changes in this version

+ const DefaultFilename

+ type Log struct

+ func NewLog(opts *Options) *Log

+ func (l *Log) Debug(args ...any)

+ func (l *Log) Debugf(template string, args ...any)

+ func (l *Log) Debugln(args ...any)

+ func (l *Log) Debugw(msg string, keysAndValues ...any)

+ func (l *Log) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error)

+ func (l *Log) Error(args ...any)

+ func (l *Log) Errorf(template string, args ...any)

+ func (l *Log) Errorln(args ...any)

+ func (l *Log) Errorw(msg string, keysAndValues ...any)

+ func (l *Log) Fatal(args ...any)

+ func (l *Log) Fatalf(template string, args ...any)

+ func (l *Log) Fatalln(args ...any)

+ func (l *Log) Fatalw(msg string, keysAndValues ...any)

+ func (l *Log) Info(args ...any)

+ func (l *Log) Infof(template string, args ...any)

+ func (l *Log) Infoln(args ...any)

+ func (l *Log) Infow(msg string, keysAndValues ...any)

+ func (l *Log) Panic(args ...any)

+ func (l *Log) Panicf(template string, args ...any)

+ func (l *Log) Panicln(args ...any)

+ func (l *Log) Panicw(msg string, keysAndValues ...any)

+ func (l *Log) Sync()

+ func (l *Log) Warn(args ...any)

+ func (l *Log) Warnf(template string, args ...any)

+ func (l *Log) Warnln(args ...any)

+ func (l *Log) Warnw(msg string, keysAndValues ...any)

type Options

+ Filename string

+ func (opt *Options) WithFilename(filename string) *Options

v1.2.0

Jul 20, 2025

Changes in this version

+ const BriefDelay

+ const MaxRetries

v1.1.0

Jul 12, 2025

Changes in this version

+ func ReplaceLogger(l *ZiwiLog)

type ZiwiLog

+ func DefaultLogger() *ZiwiLog

v1.0.0

Jul 12, 2025

Changes in this version

+ const DefaultCompress

+ const DefaultDisableCaller

+ const DefaultDisableSplitError

+ const DefaultDisableStacktrace

+ const DefaultFormat

+ const DefaultLevel

+ const DefaultMaxBackups

+ const DefaultMaxSize

+ const DefaultPrefix

+ const DefaultTimeLayout

+ var DefaultDirectory = func() string { ... }()

+ func Debug(args ...any)

+ func Debugf(template string, args ...any)

+ func Debugln(args ...any)

+ func Debugw(msg string, ksAndvs ...any)

+ func Error(args ...any)

+ func Errorf(template string, args ...any)

+ func Errorln(args ...any)

+ func Errorw(msg string, keysAndValues ...any)

+ func Fatal(args ...any)

+ func Fatalf(template string, args ...any)

+ func Fatalln(args ...any)

+ func Fatalw(msg string, ksAndvs ...any)

+ func Info(args ...any)

+ func Infof(template string, args ...any)

+ func Infoln(args ...any)

+ func Infow(msg string, ksAndvs ...any)

+ func Panic(args ...any)

+ func Panicf(template string, args ...any)

+ func Panicln(args ...any)

+ func Panicw(msg string, keysAndValues ...any)

+ func Sync()

+ func Warn(args ...any)

+ func Warnf(template string, args ...any)

+ func Warnln(args ...any)

+ func Warnw(msg string, keysAndValues ...any)

+ type Logger interface

+ Debug func(args ...any)

+ Debugf func(template string, args ...any)

+ Debugln func(args ...any)

+ Debugw func(msg string, keysAndValues ...any)

+ Error func(args ...any)

+ Errorf func(template string, args ...any)

+ Errorln func(args ...any)

+ Errorw func(msg string, keysAndValues ...any)

+ Fatal func(args ...any)

+ Fatalf func(template string, args ...any)

+ Fatalln func(args ...any)

+ Fatalw func(msg string, keysAndValues ...any)

+ Info func(args ...any)

+ Infof func(template string, args ...any)

+ Infoln func(args ...any)

+ Infow func(msg string, keysAndValues ...any)

+ Panic func(args ...any)

+ Panicf func(template string, args ...any)

+ Panicln func(args ...any)

+ Panicw func(msg string, keysAndValues ...any)

+ Sync func()

+ Warn func(args ...any)

+ Warnf func(template string, args ...any)

+ Warnln func(args ...any)

+ Warnw func(msg string, keysAndValues ...any)

+ type Options struct

+ Compress bool

+ Directory string

+ DisableCaller bool

+ DisableSplitError bool

+ DisableStacktrace bool

+ Format string

+ Level string

+ MaxBackups int

+ MaxSize int

+ Prefix string

+ TimeLayout string

+ func NewOptions() *Options

+ func (opt *Options) Validate() error

+ func (opt *Options) WithCompress(compress bool) *Options

+ func (opt *Options) WithDirectory(dir string) *Options

+ func (opt *Options) WithDisableCaller(disableCaller bool) *Options

+ func (opt *Options) WithDisableSplitError(disableSplitError bool) *Options

+ func (opt *Options) WithDisableStacktrace(disableStacktrace bool) *Options

+ func (opt *Options) WithFormat(format string) *Options

+ func (opt *Options) WithLevel(level string) *Options

+ func (opt *Options) WithMaxBackups(maxBackups int) *Options

+ func (opt *Options) WithMaxSize(maxSize int) *Options

+ func (opt *Options) WithPrefix(prefix string) *Options

+ func (opt *Options) WithTimeLayout(timeLayout string) *Options

+ type ZiwiLog struct

+ func NewLogger(opts *Options) *ZiwiLog

+ func (l *ZiwiLog) Debug(args ...any)

+ func (l *ZiwiLog) Debugf(template string, args ...any)

+ func (l *ZiwiLog) Debugln(args ...any)

+ func (l *ZiwiLog) Debugw(msg string, ksAndvs ...any)

+ func (l *ZiwiLog) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error)

+ func (l *ZiwiLog) Error(args ...any)

+ func (l *ZiwiLog) Errorf(template string, args ...any)

+ func (l *ZiwiLog) Errorln(args ...any)

+ func (l *ZiwiLog) Errorw(msg string, ksAndVs ...any)

+ func (l *ZiwiLog) Fatal(args ...any)

+ func (l *ZiwiLog) Fatalf(template string, args ...any)

+ func (l *ZiwiLog) Fatalln(args ...any)

+ func (l *ZiwiLog) Fatalw(msg string, ksAndvs ...any)

+ func (l *ZiwiLog) Info(args ...any)

+ func (l *ZiwiLog) Infof(template string, args ...any)

+ func (l *ZiwiLog) Infoln(args ...any)

+ func (l *ZiwiLog) Infow(msg string, keysAndValues ...any)

+ func (l *ZiwiLog) Panic(args ...any)

+ func (l *ZiwiLog) Panicf(template string, args ...any)

+ func (l *ZiwiLog) Panicln(args ...any)

+ func (l *ZiwiLog) Panicw(msg string, ksAndvs ...any)

+ func (l *ZiwiLog) Sync()

+ func (l *ZiwiLog) Warn(args ...any)

+ func (l *ZiwiLog) Warnf(template string, args ...any)

+ func (l *ZiwiLog) Warnln(args ...any)

+ func (l *ZiwiLog) Warnw(msg string, keysAndValues ...any)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL