Documentation
¶
Index ¶
- Constants
- Variables
- func BgLogger() *zap.Logger
- func Event(ctx context.Context, event string)
- func Eventf(ctx context.Context, format string, args ...interface{})
- func Hex(msg proto.Message) fmt.Stringer
- func InitLogger(cfg *LogConfig, opts ...zap.Option) error
- func Logger(ctx context.Context) *zap.Logger
- func ReplaceLogger(cfg *LogConfig, opts ...zap.Option) error
- func SetLevel(level string) error
- func SetTag(ctx context.Context, key string, value interface{})
- func WithConnID(ctx context.Context, connID uint64) context.Context
- func WithKeyValue(ctx context.Context, key, value string) context.Context
- func WithTraceLogger(ctx context.Context, connID uint64) context.Context
- type FileLogConfig
- type LogConfig
Constants ¶
const ( // DefaultLogMaxSize is the default size of log files. DefaultLogMaxSize = 300 // MB // DefaultLogFormat is the default format of the log. DefaultLogFormat = "text" // DefaultSlowThreshold is the default slow log threshold in millisecond. DefaultSlowThreshold = 300 // DefaultSlowTxnThreshold is the default slow txn log threshold in ms. DefaultSlowTxnThreshold = 0 // DefaultQueryLogMaxLen is the default max length of the query in the log. DefaultQueryLogMaxLen = 4096 // DefaultRecordPlanInSlowLog is the default value for whether enable log query plan in the slow log. DefaultRecordPlanInSlowLog = 1 // DefaultTiDBEnableSlowLog enables TiDB to log slow queries. DefaultTiDBEnableSlowLog = true )
const ( // SlowLogTimeFormat is the time format for slow log. SlowLogTimeFormat = time.RFC3339Nano // OldSlowLogTimeFormat is the first version of the the time format for slow log, This is use for compatibility. OldSlowLogTimeFormat = "2006-01-02-15:04:05.999999999 -0700" )
const TraceEventKey = "event"
TraceEventKey presents the TraceEventKey in span log.
Variables ¶
var CtxLogKey = ctxLogKeyType{}
CtxLogKey indicates the context key for logger public for test usage.
var EmptyFileLogConfig = FileLogConfig{}
EmptyFileLogConfig is an empty FileLogConfig.
var SlowQueryLogger = log.L()
SlowQueryLogger is used to log slow query, InitLogger will modify it according to config file.
Functions ¶
func Hex ¶
Hex defines a fmt.Stringer for proto.Message. We can't define the String() method on proto.Message, but we can wrap it.
func InitLogger ¶
InitLogger initializes a logger with cfg.
func Logger ¶
Logger gets a contextual logger from current context. contextual logger will output common fields from context.
func ReplaceLogger ¶
ReplaceLogger replace global logger instance with given log config.
func WithConnID ¶
WithConnID attaches connId to context.
func WithKeyValue ¶
WithKeyValue attaches key/value to context.
Types ¶
type FileLogConfig ¶
type FileLogConfig struct {
log.FileLogConfig
}
FileLogConfig serializes file log related config in toml/json.
func NewFileLogConfig ¶
func NewFileLogConfig(maxSize uint) FileLogConfig
NewFileLogConfig creates a FileLogConfig.
type LogConfig ¶
type LogConfig struct {
log.Config
// SlowQueryFile filename, default to File log config on empty.
SlowQueryFile string
}
LogConfig serializes log related config in toml/json.
func NewLogConfig ¶
func NewLogConfig(level, format, slowQueryFile string, fileCfg FileLogConfig, disableTimestamp bool, opts ...func(*log.Config)) *LogConfig
NewLogConfig creates a LogConfig.
Source Files
Directories