logutil

Documentation

Index

• func InitFileLog(cfg *zaplog.FileLogConfig) error
• func InitLogger(cfg *zaplog.Config) error
• func LogPanic()
• func StringToLogFormatter(format string, disableTimestamp bool) log.Formatter
• func StringToLogLevel(level string) log.Level
• func StringToZapLogLevel(level string) zapcore.Level
• type FileLogConfig
• type LogConfig

Functions

func InitFileLog

func InitFileLog(cfg *zaplog.FileLogConfig) error

InitFileLog initializes file based logging options.

func InitLogger

func InitLogger(cfg *zaplog.Config) error

InitLogger initializes PD's logger.

func LogPanic

func LogPanic()

LogPanic logs the panic reason and stack, then exit the process. Commonly used with a `defer`.

func StringToLogFormatter

func StringToLogFormatter(format string, disableTimestamp bool) log.Formatter

StringToLogFormatter uses the different log formatter according to a given format name.

func StringToLogLevel

func StringToLogLevel(level string) log.Level

StringToLogLevel translates log level string to log level.

func StringToZapLogLevel

func StringToZapLogLevel(level string) zapcore.Level

StringToZapLogLevel translates log level string to log level.

Types

type FileLogConfig

type FileLogConfig struct {
	// Log filename, leave empty to disable file log.
	Filename string `toml:"filename" json:"filename"`
	// Is log rotate enabled. TODO.
	LogRotate bool `toml:"log-rotate" json:"log-rotate"`
	// Max size for a single file, in MB.
	MaxSize int `toml:"max-size" json:"max-size"`
	// Max log keep days, default is never deleting.
	MaxDays int `toml:"max-days" json:"max-days"`
	// Maximum number of old log files to retain.
	MaxBackups int `toml:"max-backups" json:"max-backups"`
}

FileLogConfig serializes file log related config in toml/json.

type LogConfig

type LogConfig struct {
	// Log level.
	Level string `toml:"level" json:"level"`
	// Log format. one of json, text, or console.
	Format string `toml:"format" json:"format"`
	// Disable automatic timestamps in output.
	DisableTimestamp bool `toml:"disable-timestamp" json:"disable-timestamp"`
	// File log config.
	File FileLogConfig `toml:"file" json:"file"`
}

LogConfig serializes log related config in toml/json.