logger

package

v0.1.6 Latest Latest Go to latest Published: Apr 14, 2025 License: BSD-3-Clause Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bobacgo/kit

Links

Open Source Insights

Documentation ¶

Index ¶

func InitSlog(h slog.Handler)
func InitZapLogger(conf Config)
func SetLevel(l LogLevel)
type Config
- func New(appName string, logCfg Config) Config
- func NewConfig(opts ...Option) Config
type LogLevel
- func StringToLevel(level string) LogLevel
- func (l LogLevel) String() string
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func InitSlog ¶

func InitSlog(h slog.Handler)

func InitZapLogger ¶

func InitZapLogger(conf Config)

func SetLevel ¶ added in v0.1.2

func SetLevel(l LogLevel)

Types ¶

type Config ¶

type Config struct {
	Level LogLevel `mapstructure:"level" validate:"omitempty,oneof=debug info error"`
	// 监听日志级别变化
	LevelCh    chan LogLevel `mapstructure:"-" json:"-" yaml:"-"`
	TimeFormat string        `mapstructure:"timeFormat" yaml:"timeFormat" default:"2006-01-02 15:04:05"`

	// 完整的文件路径名
	Filepath        string `mapstructure:"filepath"`
	Filename        string `mapstructure:"filename" default:"server"`
	FilenameSuffix  string `mapstructure:"filenameSuffix" yaml:"filenameSuffix" default:"2006-01-02-150405"`
	FileExtension   string `mapstructure:"fileExtension" yaml:"fileExtension" default:"log"`
	FileJsonEncoder bool   `mapstructure:"fileJsonEncoder" yaml:"fileJsonEncoder"`

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

func New ¶ added in v0.1.3

func New(appName string, logCfg Config) Config

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 日志时间格式

Source Files ¶

View all Source files

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