fslog

README

fslog

方是日志包

Documentation

Index

• Constants
• func Flush()
• func GinLogger(skipPaths []string) gin.HandlerFunc
• func GinRecovery() gin.HandlerFunc
• type FileOutputOpt
  • func WithCompress(compress bool) FileOutputOpt
  • func WithFilename(filename string) FileOutputOpt
  • func WithLocalTime(localTime bool) FileOutputOpt
  • func WithMaxAge(maxAge int) FileOutputOpt
  • func WithMaxBackups(maxBackups int) FileOutputOpt
  • func WithMaxSize(maxSize int) FileOutputOpt
• type Level
  • func Lv() Level
• type Logger
  • func Debug(msg string, vs ...any) *Logger
  • func Error(vs ...any) *Logger
  • func Info(msg string, vs ...any) *Logger
  • func New(opts ...LoggerOption) *Logger
  • func NewFileOutput(opts ...FileOutputOpt) *Logger
  • func NewOutput(writer io.Writer) *Logger
  • func SetLogger(logger *Logger) *Logger
  • func SetLv(lv Level) *Logger
  • func Warn(msg string, vs ...any) *Logger
  • func With(k string, v any) *Logger
  • func (l *Logger) AddCore(core ...zapcore.Core)
  • func (l *Logger) Debug(msg string, vs ...any)
  • func (l *Logger) Error(vs ...any)
  • func (l *Logger) Flush()
  • func (l *Logger) Info(msg string, vs ...any)
  • func (l *Logger) Lv() Level
  • func (l *Logger) NewFileOutput(opts ...FileOutputOpt)
  • func (l *Logger) NewOutput(writer io.Writer)
  • func (l *Logger) SetLv(lv Level)
  • func (l *Logger) Warn(msg string, vs ...any)
  • func (l *Logger) With(k string, v any) *Logger
• type LoggerOption
  • func WithSkipCaller(skip int) LoggerOption

Constants

const (
	DebugLv = Level(zapcore.DebugLevel)
	InfoLv  = Level(zapcore.InfoLevel)
	WarnLv  = Level(zapcore.WarnLevel)
	ErrorLv = Level(zapcore.ErrorLevel)
)

Functions

func Flush

func Flush()

Flush 见 Logger.Flush

func GinLogger

func GinLogger(skipPaths []string) gin.HandlerFunc

func GinRecovery

func GinRecovery() gin.HandlerFunc

Types

type FileOutputOpt

type FileOutputOpt func(*outFileConfig)

FileOutputOpt 文件输出选项

func WithCompress

func WithCompress(compress bool) FileOutputOpt

func WithFilename

func WithFilename(filename string) FileOutputOpt

func WithLocalTime

func WithLocalTime(localTime bool) FileOutputOpt

func WithMaxAge

func WithMaxAge(maxAge int) FileOutputOpt

func WithMaxBackups

func WithMaxBackups(maxBackups int) FileOutputOpt

func WithMaxSize

func WithMaxSize(maxSize int) FileOutputOpt

type Level

type Level zapcore.Level

func Lv

func Lv() Level

Lv 见 Logger.Lv

type Logger

type Logger struct {
	// 日志打印用
	Logger zap.SugaredLogger
	// contains filtered or unexported fields
}

Logger 是对 zap.SugaredLogger 的封装，简化其对外使用的接口， 并且针对于 Logger 所有配置都是支持运行时动态修改，且并发安全。 Logger 也支持了针对于 zapcore.Core 的扩展，调用 Logger.AddCore 即可，

构建该对象请使用 New 进行创建，在该操作中会对部分必要属性进行初始化， 直接使用结构体创建会导致结构体不可用（甚至panic）。

如非深度定制化扩展，非必要不建议使用 Logger.AddCore 进行扩展，该操作会 导致客户端应用程序对zap包编译依赖，不保证fslog切换内部日志实现。

var Log *Logger

func Debug

func Debug(msg string, vs ...any) *Logger

Debug 见 Logger.Debug

func Error

func Error(vs ...any) *Logger

Error 见 Logger.Error

func Info

func Info(msg string, vs ...any) *Logger

Info 见 Logger.Info

func New

func New(opts ...LoggerOption) *Logger

func NewFileOutput

func NewFileOutput(opts ...FileOutputOpt) *Logger

NewFileOutput 见 Logger.NewFileOutput

func NewOutput

func NewOutput(writer io.Writer) *Logger

NewOutput 见 Logger.NewOutput

func SetLogger

func SetLogger(logger *Logger) *Logger

SetLogger 替换fslog包默认的log对象 Logger 支持了zapcore级别的底层配置，见 Logger

func SetLv

func SetLv(lv Level) *Logger

SetLv 见 Logger.SetLv

func Warn

func Warn(msg string, vs ...any) *Logger

Warn 见 Logger.Warn

func With

func With(k string, v any) *Logger

With 见 Logger.With

func (*Logger) AddCore

func (l *Logger) AddCore(core ...zapcore.Core)

AddCore 添加Core

func (*Logger) Debug

func (l *Logger) Debug(msg string, vs ...any)

Debug 格式化打印调试级别日志 不同于zap内部可变参数逻辑，该可变参数是用于，字符串格式化的

func (*Logger) Error

func (l *Logger) Error(vs ...any)

Error 打印错误级别日志 该方法具有两种传参形式：

1. error类型：会直接格式化打印%+v日志
2. 信息(格式化)
3. error+格式化信息：error会作为 With 格式存在，且依旧以%+v格式输出

func (*Logger) Flush

func (l *Logger) Flush()

Flush 将缓冲区日志刷新至目标

func (*Logger) Info

func (l *Logger) Info(msg string, vs ...any)

Info 格式化打印信息级别日志 不同于zap内部可变参数逻辑，该可变参数是用于，字符串格式化的

func (*Logger) Lv

func (l *Logger) Lv() Level

Lv 获取当前日志打印级别

func (*Logger) NewFileOutput

func (l *Logger) NewFileOutput(opts ...FileOutputOpt)

NewFileOutput 新增日志输出文件配置

func (*Logger) NewOutput

func (l *Logger) NewOutput(writer io.Writer)

NewOutput 新增日志输出位置

func (*Logger) SetLv

func (l *Logger) SetLv(lv Level)

SetLv 设置当前日志打印级别

func (*Logger) Warn

func (l *Logger) Warn(msg string, vs ...any)

Warn 格式化打印警告级别日志 不同于zap内部可变参数逻辑，该可变参数是用于，字符串格式化的

func (*Logger) With

func (l *Logger) With(k string, v any) *Logger

With 拼接自定义信息 主要用于打印当前环境快照信息(变量或其他自定义信息) 打印后，该信息会跟随日志一起打印

type LoggerOption

type LoggerOption func(*loggerConfig)

func WithSkipCaller

func WithSkipCaller(skip int) LoggerOption