logger

package
v0.4.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// LevelDebug is logger debug level.
	LevelDebug = Level(-1)
	// LevelInfo is logger info level.
	LevelInfo = Level(0)
	// LevelWarn is logger warn level.
	LevelWarn = Level(1)
	// LevelError is logger error level.
	LevelError = Level(2)
	// LevelFatal is logger fatal level.
	LevelFatal = Level(3)
)
View Source
const (
	LogEncodingConsole = LogEncoding("console")
	LogEncodingJSON    = LogEncoding("json")
)
View Source
const LevelKey = "level"

LevelKey is logger level key.

Variables

View Source
var DefaultLogger = NewStdLogger(log.Writer())

DefaultLogger is default logger.

View Source
var DefaultMessageKey = "msg"

DefaultMessageKey default message key.

Functions

func Debug

func Debug(ctx context.Context, a ...interface{})

Debug logs a message at debug level.

func Debugf

func Debugf(ctx context.Context, format string, a ...interface{})

Debugf logs a message at debug level.

func Debugw

func Debugw(ctx context.Context, keyvals ...interface{})

Debugw logs a message at debug level.

func Error

func Error(ctx context.Context, a ...interface{})

Error logs a message at error level.

func Errorf

func Errorf(ctx context.Context, format string, a ...interface{})

Errorf logs a message at error level.

func Errorw

func Errorw(ctx context.Context, keyvals ...interface{})

Errorw logs a message at error level.

func Fatal

func Fatal(ctx context.Context, a ...interface{})

Fatal logs a message at fatal level.

func Fatalf

func Fatalf(ctx context.Context, format string, a ...interface{})

Fatalf logs a message at fatal level.

func Fatalw

func Fatalw(ctx context.Context, keyvals ...interface{})

Fatalw logs a message at fatal level.

func Info

func Info(ctx context.Context, a ...interface{})

Info logs a message at info level.

func Infof

func Infof(ctx context.Context, format string, a ...interface{})

Infof logs a message at info level.

func Infow

func Infow(ctx context.Context, keyvals ...interface{})

Infow logs a message at info level.

func Log

func Log(ctx context.Context, level Level, keyvals ...interface{})

Log Print log by level and keyvals.

func SetLogger

func SetLogger(logger Logger)

SetLogger should be called before any other log call. And it is NOT THREAD SAFE.

func Warn

func Warn(ctx context.Context, a ...interface{})

Warn logs a message at warn level.

func Warnf

func Warnf(ctx context.Context, format string, a ...interface{})

Warnf logs a message at warnf level.

func Warnw

func Warnw(ctx context.Context, keyvals ...interface{})

Warnw logs a message at warnf level.

Types

type Helper

type Helper struct {
	// contains filtered or unexported fields
}

Helper is a logger helper.

func NewHelper

func NewHelper(logger Logger, opts ...Option) *Helper

NewHelper new a logger helper.

func (*Helper) Debug

func (h *Helper) Debug(ctx context.Context, a ...interface{})

Debug logs a message at debug level.

func (*Helper) Debugf

func (h *Helper) Debugf(ctx context.Context, format string, a ...interface{})

Debugf logs a message at debug level.

func (*Helper) Debugw

func (h *Helper) Debugw(ctx context.Context, keyvals ...interface{})

Debugw logs a message at debug level.

func (*Helper) Error

func (h *Helper) Error(ctx context.Context, a ...interface{})

Error logs a message at error level.

func (*Helper) Errorf

func (h *Helper) Errorf(ctx context.Context, format string, a ...interface{})

Errorf logs a message at error level.

func (*Helper) Errorw

func (h *Helper) Errorw(ctx context.Context, keyvals ...interface{})

Errorw logs a message at error level.

func (*Helper) Fatal

func (h *Helper) Fatal(ctx context.Context, a ...interface{})

Fatal logs a message at fatal level.

func (*Helper) Fatalf

func (h *Helper) Fatalf(ctx context.Context, format string, a ...interface{})

Fatalf logs a message at fatal level.

func (*Helper) Fatalw

func (h *Helper) Fatalw(ctx context.Context, keyvals ...interface{})

Fatalw logs a message at fatal level.

func (*Helper) Info

func (h *Helper) Info(ctx context.Context, a ...interface{})

Info logs a message at info level.

func (*Helper) Infof

func (h *Helper) Infof(ctx context.Context, format string, a ...interface{})

Infof logs a message at info level.

func (*Helper) Infow

func (h *Helper) Infow(ctx context.Context, keyvals ...interface{})

Infow logs a message at info level.

func (*Helper) Warn

func (h *Helper) Warn(ctx context.Context, a ...interface{})

Warn logs a message at warn level.

func (*Helper) Warnf

func (h *Helper) Warnf(ctx context.Context, format string, a ...interface{})

Warnf logs a message at warnf level.

func (*Helper) Warnw

func (h *Helper) Warnw(ctx context.Context, keyvals ...interface{})

Warnw logs a message at warnf level.

type Level

type Level int8

Level is a logger level.

func ParseLevel

func ParseLevel(s string) Level

ParseLevel parses a level string into a logger Level value.

func (Level) Key

func (l Level) Key() string

func (Level) String

func (l Level) String() string

type LogConfig

type LogConfig struct {
	Level    string      `json:"level" yaml:"level" env:"DEFAULT_LOG_LEVEL"`
	Encoding LogEncoding `json:"encoding" yaml:"encoding" env:"DEFAULT_LOG_ENCODING"`

	// 日志存储配置
	Filepath string `json:"filepath" yaml:"filepath" env:"DEFAULT_LOG_FILEPATH"`
	// MaxSize is the maximum size in megabytes of the log file before it gets
	// rotated. It defaults to 100 megabytes.
	MaxSize int `json:"maxSize" yaml:"maxSize" env:"DEFAULT_LOG_MAX_SIZE"`
	// MaxAge is the maximum number of days to retain old log files based on the
	// timestamp encoded in their filename.  Note that a day is defined as 24
	// hours and may not exactly correspond to calendar days due to daylight
	// savings, leap seconds, etc. The default is not to remove old log files
	// based on age.
	MaxAge int `json:"maxAge" yaml:"maxAge" env:"DEFAULT_LOG_MAX_AGE"`
	// MaxBackups is the maximum number of old log files to retain.  The default
	// is to retain all old log files (though MaxAge may still cause them to get
	// deleted.)
	MaxBackups int `json:"maxBackups" yaml:"maxBackups" env:"DEFAULT_LOG_MAX_BACKUPS"`

	TraceProvider trace.TracerProvider `json:"-"`
}

type LogConfigOption

type LogConfigOption func(*LogConfig)

type LogEncoding

type LogEncoding string

type LogWrapper

type LogWrapper func(ctx context.Context, level Level, keyvals ...interface{}) error

func (LogWrapper) Log

func (f LogWrapper) Log(ctx context.Context, level Level, keyvals ...interface{}) error

type Logger

type Logger interface {
	Log(ctx context.Context, level Level, keyvals ...interface{}) error
}

Logger is a logger interface.

func GetLogger

func GetLogger() Logger

GetLogger returns global logger appliance as logger in current process.

func NewLogger

func NewLogger(opts ...LogConfigOption) (Logger, error)

func NewStdLogger

func NewStdLogger(w io.Writer) Logger

NewStdLogger new a logger with writer.

type Option

type Option func(*Helper)

Option is Helper option.

func WithMessageKey

func WithMessageKey(k string) Option

WithMessageKey with message key.

func WithSprint

func WithSprint(sprint func(...interface{}) string) Option

WithSprint with sprint

func WithSprintf

func WithSprintf(sprintf func(format string, a ...interface{}) string) Option

WithSprintf with sprintf

Jump to

Keyboard shortcuts

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