logger

Documentation

Index

• type FileConfig
• type Level
• type Logger
• type Option
  • func WithConsole() Option
  • func WithFile() Option
  • func WithFileWithConfig(cfg FileConfig) Option
  • func WithLevel(level Level) Option
  • func WithMongo(db *mongo.Database) Option
  • func WithWriter(w io.Writer) Option
  • func WithWriters(w []io.Writer) Option
• type ZeroLogger
  • func Ctx(ctx context.Context) *ZeroLogger
  • func New(opts ...Option) *ZeroLogger
  • func Nop() *ZeroLogger
  • func (l *ZeroLogger) Debug(msg string, fields ...any)
  • func (l *ZeroLogger) Err(err error, msg string, fields ...any)
  • func (l *ZeroLogger) Error(msg string, fields ...any)
  • func (l *ZeroLogger) Info(msg string, fields ...any)
  • func (l *ZeroLogger) Log(level Level, msg string, fields ...any)
  • func (l *ZeroLogger) Warn(msg string, fields ...any)
  • func (l ZeroLogger) With(fields ...any) Logger
  • func (l *ZeroLogger) WithContext(ctx context.Context) context.Context

Types

type FileConfig

type FileConfig struct {
	Path       string
	Filename   string
	MaxSize    int
	MaxAge     int
	MaxBackups int
	Compress   bool
	LocalTime  bool
}

FileConfig 文件日志配置

type Level

type Level int

Level 日志级别

const (
	// DebugLevel 日志 debug 级别
	DebugLevel Level = iota
	// InfoLevel 日志 info 级别
	InfoLevel
	// WarnLevel 日志 warn 级别
	WarnLevel
	// ErrorLevel 日志 error 级别
	ErrorLevel
	// Disabled 日志禁用级别
	Disabled
)

type Logger

type Logger interface {
	// Info 记录 Info 级别日志
	Info(msg string, fields ...any)

	// Error 记录 Error 级别日志
	Error(msg string, fields ...any)

	// Debug 记录 Debug 级别日志
	Debug(msg string, fields ...any)

	// Warn 记录 Warn 级别日志
	Warn(msg string, fields ...any)

	// Err 封装 Error 错误
	Err(err error, msg string, fields ...any)

	// Log 指定级别记录日志
	Log(level Level, msg string, fields ...any)

	// WithContext 将日志实例添加到上下文中
	WithContext(ctx context.Context) context.Context

	// With 创建新的 Logger
	With(fields ...any) Logger
}

Logger 日志接口

type Option

type Option func(*ZeroLogger)

Option 日志组件配置项

func WithConsole

func WithConsole() Option

WithConsole 设置控制台输出

func WithFile

func WithFile() Option

WithFile 添加文件写入器（使用默认配置）

func WithFileWithConfig

func WithFileWithConfig(cfg FileConfig) Option

WithFileWithConfig 添加文件写入器（使用自定义配置）

func WithLevel

func WithLevel(level Level) Option

WithLevel 设置日志级别

func WithMongo

func WithMongo(db *mongo.Database) Option

WithMongo 添加MongoDB写入器

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter 添加日志写入器

func WithWriters

func WithWriters(w []io.Writer) Option

WithWriters 设置日志写入器

type ZeroLogger

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

ZeroLogger 日志组件

func Ctx

func Ctx(ctx context.Context) *ZeroLogger

Ctx 从上下文中获取日志实例

func New

func New(opts ...Option) *ZeroLogger

New 创建日志组件

func Nop

func Nop() *ZeroLogger

Nop 创建一个空日志组件

func (*ZeroLogger) Debug

func (l *ZeroLogger) Debug(msg string, fields ...any)

Debug 记录调试信息日志

func (*ZeroLogger) Err

func (l *ZeroLogger) Err(err error, msg string, fields ...any)

Err 记录包含错误信息日志

func (*ZeroLogger) Error

func (l *ZeroLogger) Error(msg string, fields ...any)

Error 记录错误信息日志

func (*ZeroLogger) Info

func (l *ZeroLogger) Info(msg string, fields ...any)

Info 记录信息日志

func (*ZeroLogger) Log

func (l *ZeroLogger) Log(level Level, msg string, fields ...any)

Log 指定级别记录日志

func (*ZeroLogger) Warn

func (l *ZeroLogger) Warn(msg string, fields ...any)

Warn 记录警告信息日志

func (ZeroLogger) With

func (l ZeroLogger) With(fields ...any) Logger

With 创建一个新的日志实例，并添加字段

func (*ZeroLogger) WithContext

func (l *ZeroLogger) WithContext(ctx context.Context) context.Context

WithContext 将日志实例添加到上下文中