log

Documentation

Index

• func AppendZapFieldToCtx(ctx context.Context, newFields ...zap.Field) context.Context
• func InitLogger(cfg *Config) error
• func IsRedactLogEnabled() bool
• func Props() *pclog.ZapProperties
• func RedactString(arg string) string
• func SetLevel(level zapcore.Level) zapcore.Level
• func SetRedactLog(enabled bool)
• func ShortError(err error) zap.Field
• func WrapStringerField(message string, object fmt.Stringer) zap.Field
• func ZapRedactString(key, arg string) zap.Field
• type Config
  • func (cfg *Config) Adjust()
• type Logger
  • func L() Logger
  • func With(fields ...zap.Field) Logger
  • func WithCtx(ctx context.Context) Logger
  • func (l Logger) ErrorFilterContextCanceled(msg string, fields ...zap.Field)
  • func (l Logger) WithFields(fields ...zap.Field) Logger

Functions

func AppendZapFieldToCtx

func AppendZapFieldToCtx(ctx context.Context, newFields ...zap.Field) context.Context

AppendZapFieldToCtx attaches new fields to the context, which can be then used with log.WithCtx().

func InitLogger

func InitLogger(cfg *Config) error

InitLogger initializes DM's and also the TiDB library's loggers.

func IsRedactLogEnabled

func IsRedactLogEnabled() bool

IsRedactLogEnabled indicates whether the log desensitization is enabled.

func Props

func Props() *pclog.ZapProperties

Props returns the current logger's props.

func RedactString

func RedactString(arg string) string

RedactString receives string argument and return omitted information if redact log enabled.

func SetLevel

func SetLevel(level zapcore.Level) zapcore.Level

SetLevel modifies the log level of the global logger. Returns the previous level.

func SetRedactLog

func SetRedactLog(enabled bool)

SetRedactLog sets enabledRedactLog.

func ShortError

func ShortError(err error) zap.Field

ShortError contructs a field which only records the error message without the verbose text (i.e. excludes the stack trace).

In DM, all errors are almost always propagated back to `main()` where the error stack is written. Including the stack in the middle thus usually just repeats known information. You should almost always use `ShortError` instead of `zap.Error`, unless the error is no longer propagated upwards.

func WrapStringerField

func WrapStringerField(message string, object fmt.Stringer) zap.Field

WrapStringerField returns a wrap stringer field.

func ZapRedactString

func ZapRedactString(key, arg string) zap.Field

ZapRedactString receives string argument and return omitted information in zap.Field if redact log enabled.

Types

type Config

type Config struct {
	// Log level.
	Level string `toml:"level" json:"level"`
	// the format of the log, "text" or "json"
	Format string `toml:"format" json:"format"`
	// Log filename, leave empty to disable file log.
	File string `toml:"file" json:"file"`
	// Max size for a single file, in MB.
	FileMaxSize int `toml:"max-size" json:"max-size"`
	// Max log keep days, default is never deleting.
	FileMaxDays int `toml:"max-days" json:"max-days"`
	// Maximum number of old log files to retain.
	FileMaxBackups int `toml:"max-backups" json:"max-backups"`
}

Config serializes log related config in toml/json.

func (*Config) Adjust

func (cfg *Config) Adjust()

Adjust adjusts config.

type Logger

type Logger struct {
	*zap.Logger
}

Logger is a simple wrapper around *zap.Logger which provides some extra methods to simplify DM's log usage.

func L

func L() Logger

L returns the current logger for DM.

func With

func With(fields ...zap.Field) Logger

With creates a child logger from the global logger and adds structured context to it.

func WithCtx

func WithCtx(ctx context.Context) Logger

WithCtx adds fields from ctx to the logger.

func (Logger) ErrorFilterContextCanceled

func (l Logger) ErrorFilterContextCanceled(msg string, fields ...zap.Field)

ErrorFilterContextCanceled wraps Logger.Error() and will filter error log when error is context.Canceled.

func (Logger) WithFields

func (l Logger) WithFields(fields ...zap.Field) Logger

WithFields return new Logger with specified fields.