logger

Documentation

Index

• func InitSlog(handlers ...slog.Handler)
• func InitZapLogger(conf Config)
• type Config
  • func NewConfig(opts ...Option) Config
  • func (c *Config) AddFlags(fs *pflag.FlagSet)
  • func (c *Config) SetLevel(level LogLevel)
  • func (c *Config) Validate() []error
• type LogLevel
  • func StringToLevel(level string) LogLevel
  • func (l LogLevel) String() string
• type Option
  • func WithFileCompress(compress bool) Option
  • func WithFileExtension(fileExtension string) Option
  • func WithFileJsonEncoder(isJsonEncoder bool) Option
  • func WithFileMaxAge(maxAge uint16) Option
  • func WithFileMaxSize(maxSize uint16) Option
  • func WithFilename(filename string) Option
  • func WithFilenameSuffix(filenameSuffix string) Option
  • func WithFilepath(filepath string) Option
  • func WithLevel(level LogLevel) Option
  • func WithTimeFormat(timeFormat string) Option

Functions

func InitSlog

func InitSlog(handlers ...slog.Handler)

func InitZapLogger

func InitZapLogger(conf Config)

Types

type Config

type Config struct {
	Level      string        `mapstructure:"level"`
	LevelCh    chan LogLevel `json:"-" yaml:"-"`
	TimeFormat string        `mapstructure:"timeFormat" yaml:"timeFormat"`

	// 完整的文件路径名
	Filepath        string `mapstructure:"filepath"`
	Filename        string `mapstructure:"filename"`
	FilenameSuffix  string `mapstructure:"filenameSuffix" yaml:"filenameSuffix"`
	FileExtension   string `mapstructure:"fileExtension" yaml:"fileExtension"`
	FileJsonEncoder bool   `mapstructure:"fileJsonEncoder" yaml:"fileJsonEncoder"`

	FileMaxSize  uint16 `mapstructure:"fileSizeMax" yaml:"fileSizeMax"`   // 单位是MB 默认值是 10MB
	FileMaxAge   uint16 `mapstructure:"fileAgeMax" yaml:"fileAgeMax"`     // 留存天数
	FileCompress bool   `mapstructure:"fileCompress" yaml:"fileCompress"` // 是否归档压缩
}

func NewConfig

func NewConfig(opts ...Option) Config

func (*Config) AddFlags

func (c *Config) AddFlags(fs *pflag.FlagSet)

func (*Config) SetLevel

func (c *Config) SetLevel(level LogLevel)

func (*Config) Validate

func (c *Config) Validate() []error

type LogLevel

type LogLevel string

const (
	LogLevel_Debug LogLevel = "debug" // -4
	LogLevel_Info  LogLevel = "info"  // 0
	LogLevel_Warn  LogLevel = "warn"  // 4
	LogLevel_Error LogLevel = "error" // 8
)

func StringToLevel

func StringToLevel(level string) LogLevel

func (LogLevel) String

func (l LogLevel) String() string

type Option

type Option func(*Config)

func WithFileCompress

func WithFileCompress(compress bool) Option

WithFileCompress 是否归档压缩

func WithFileExtension

func WithFileExtension(fileExtension string) Option

WithFileExtension 文件扩展名 (e.g log、txt)

func WithFileJsonEncoder

func WithFileJsonEncoder(isJsonEncoder bool) Option

WithFileJsonEncoder 输出到文件侧是否启用json格式编码

func WithFileMaxAge

func WithFileMaxAge(maxAge uint16) Option

WithFileMaxAge 文件保留时长

func WithFileMaxSize

func WithFileMaxSize(maxSize uint16) Option

WithFileMaxSize 文件最大多少MB就分割

func WithFilename

func WithFilename(filename string) Option

WithFilename 文件名(文件前缀), 随机部分 main-service-2023-11-04

func WithFilenameSuffix

func WithFilenameSuffix(filenameSuffix string) Option

WithFilenameSuffix 文件后缀名, 随机部分 main-service-2023-11-04

func WithFilepath

func WithFilepath(filepath string) Option

WithFilepath 文件目录路径

func WithLevel

func WithLevel(level LogLevel) Option

WithLevel 日志级别

func WithTimeFormat

func WithTimeFormat(timeFormat string) Option

WithTimeFormat 日志时间格式