log

package
v0.0.0-...-aaefdd0 Latest Latest
Warning

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

 Go to latest Published: May 28, 2024 License: Apache-2.0 Imports: 11 Imported by: 1

README

Logger

Usage

Structured logging
logger := logger.NewStdLogger(os.Stdout)
// fields & valuer
logger = log.With(logger,
    "service.name", "hellworld",
    "service.version", "v1.0.0",
    "ts", log.DefaultTimestamp,
    "caller", log.DefaultCaller,
)
logger.Log(log.LevelInfo, "key", "value")

// helper
helper := log.NewHelper(logger)
helper.Log(log.LevelInfo, "key", "value")
helper.Info("info message")
helper.Infof("info %s", "message")
helper.Infow("key", "value")

// filter
log := log.NewHelper(log.NewFilter(logger,
	log.FilterLevel(log.LevelInfo),
	log.FilterKey("foo"),
	log.FilterValue("bar"),
	log.FilterFunc(customFilter),
))
log.Debug("debug log")
log.Info("info log")
log.Warn("warn log")
log.Error("warn log")

Third party log library

zap
go get -u github.com/go-kratos/kratos/contrib/log/zap/v2
logrus
go get -u github.com/go-kratos/kratos/contrib/log/logrus/v2
fluent
go get -u github.com/go-kratos/kratos/contrib/log/fluent/v2
aliyun
go get -u github.com/go-kratos/kratos/contrib/log/aliyun/v2

Documentation

Index

Constants

View Source 
const LevelKey = "level"

LevelKey is logger level key.

Variables

View Source 
var (
	// DefaultCaller 打印出调用日志方法文件名和行号，例如 caller=logger/log_test.go:11
	DefaultCaller = Caller(4)

	// DefaultTimestamp 打印时间戳
	DefaultTimestamp = Timestamp(time.RFC3339)
)
View Source 
var DefaultLogger = NewStdLogger(log.Writer())
View Source 
var DefaultMessageKey = "msg"

DefaultMessageKey default message key.

Functions

func Debug 

func Debug(a ...interface{})

Debug logs a message at debug level.

func Debugf 

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

Debugf logs a message at debug level.

func Debugw 

func Debugw(keyvals ...interface{})

Debugw logs a message at debug level.

func Error 

func Error(a ...interface{})

Error logs a message at error level.

func Errorf 

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

Errorf logs a message at error level.

func Errorw 

func Errorw(keyvals ...interface{})

Errorw logs a message at error level.

func Fatal 

func Fatal(a ...interface{})

Fatal logs a message at fatal level.

func Fatalf 

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

Fatalf logs a message at fatal level.

func Fatalw 

func Fatalw(keyvals ...interface{})

Fatalw logs a message at fatal level.

func Info 

func Info(a ...interface{})

Info logs a message at info level.

func Infof 

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

Infof logs a message at info level.

func Infow 

func Infow(keyvals ...interface{})

Infow logs a message at info level.

func Log 

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

Log Print log by level and keyvals.

func NewWriter 

func NewWriter(logger Logger, opts ...WriterOptionFn) io.Writer

NewWriter return a writer wrapper.

func SetLogger 

func SetLogger(logger Logger)

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

func Trace 

func Trace(a ...interface{})

Trace logs a message at trace level.

func Tracef 

func Tracef(format string, a ...interface{})

Tracef logs a message at trace level.

func Tracew 

func Tracew(keyvals ...interface{})

Tracew logs a message at trace level.

func Value 

func Value(ctx context.Context, v interface{}) interface{}

Value return the function value.

func Warn 

func Warn(a ...interface{})

Warn logs a message at warn level.

func Warnf 

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

Warnf logs a message at warnf level.

func Warnw 

func Warnw(keyvals ...interface{})

Warnw logs a message at warnf level.

Types

type Filter 

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

Filter is a logger filter.

func NewFilter 

func NewFilter(logger Logger, opts ...FilterOption) *Filter

NewFilter new a logger filter.

func (*Filter) Log 

func (f *Filter) Log(level Level, keyvals ...interface{}) error

Log Print log by level and keyvals.

type FilterOption 

type FilterOption func(*Filter)

* h := NewHelper( 

	NewFilter(logger,
		// 等级过滤
		FilterLevel(log.LevelError),

		// 按key遮蔽
		FilterKey("username"),

		// 按value遮蔽
		FilterValue("hello"),

		// 自定义过滤函数
		FilterFunc(
			func (level Level, keyvals ...interface{}) bool {
				if level == LevelWarn {
					return true
				}
				for i := 0; i < len(keyvals); i++ {
					if keyvals[i] == "password" {
						keyvals[i+1] = fuzzyStr
					}
				}
				return false
			}
		),
	),
)

h.Log(log.LevelDebug, "msg", "test debug")
h.Info("hello")
h.Infow("password", "123456")
h.Infow("username", "kratos")
h.Warn("warn log")

FilterOption is filter option.

func FilterFunc 

func FilterFunc(f func(level Level, keyvals ...interface{}) bool) FilterOption

FilterFunc 使用自定义的函数来对日志进行处理，keyvals里为key和对应的value，按照奇偶进行读取即可

func FilterKey 

func FilterKey(key ...string) FilterOption

FilterKey 按照key过滤，这些key的值会被***遮蔽

func FilterLevel 

func FilterLevel(level Level) FilterOption

FilterLevel 按照日志等级过滤，低于该等级的日志将不会被输出

func FilterValue 

func FilterValue(value ...string) FilterOption

FilterValue 按照value过滤，匹配的值会被***遮蔽

type Helper 

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

Helper is a logger helper.

func Context 

func Context(ctx context.Context) *Helper

Context with context logger.

func NewHelper 

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

NewHelper new a logger helper.

func (*Helper) Debug 

func (h *Helper) Debug(a ...interface{})

Debug logs a message at debug level.

func (*Helper) Debugf 

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

Debugf logs a message at debug level.

func (*Helper) Debugw 

func (h *Helper) Debugw(keyAndVals ...interface{})

Debugw logs a message at debug level.

func (*Helper) Enabled 

func (h *Helper) Enabled(level Level) bool

Enabled returns true if the given level above this level. It delegates to the underlying *Filter.

func (*Helper) Error 

func (h *Helper) Error(a ...interface{})

Error logs a message at error level.

func (*Helper) Errorf 

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

Errorf logs a message at error level.

func (*Helper) Errorw 

func (h *Helper) Errorw(keyAndVals ...interface{})

Errorw logs a message at error level.

func (*Helper) Fatal 

func (h *Helper) Fatal(a ...interface{})

Fatal logs a message at fatal level.

func (*Helper) Fatalf 

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

Fatalf logs a message at fatal level.

func (*Helper) Fatalw 

func (h *Helper) Fatalw(keyAndVals ...interface{})

Fatalw logs a message at fatal level.

func (*Helper) Info 

func (h *Helper) Info(a ...interface{})

Info logs a message at info level.

func (*Helper) Infof 

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

Infof logs a message at info level.

func (*Helper) Infow 

func (h *Helper) Infow(keyAndVals ...interface{})

Infow logs a message at info level.

func (*Helper) Log 

func (h *Helper) Log(level Level, keyAndVals ...interface{})

Log Print log by level and keyAndVals.

func (*Helper) Trace 

func (h *Helper) Trace(a ...interface{})

Trace logs a message at trace level.

func (*Helper) Tracef 

func (h *Helper) Tracef(format string, a ...interface{})

Tracef logs a message at trace level.

func (*Helper) Tracew 

func (h *Helper) Tracew(keyAndVals ...interface{})

Tracew logs a message at trace level.

func (*Helper) Warn 

func (h *Helper) Warn(a ...interface{})

Warn logs a message at warn level.

func (*Helper) Warnf 

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

Warnf logs a message at warnf level.

func (*Helper) Warnw 

func (h *Helper) Warnw(keyAndVals ...interface{})

Warnw logs a message at warnf level.

func (*Helper) WithContext 

func (h *Helper) WithContext(ctx context.Context) *Helper

WithContext returns a shallow copy of h with its context changed to ctx. The provided ctx must be non-nil.

type Level 

type Level int8
const (
	// TraceLevel 日志级别很低，很少使用
	TraceLevel Level = iota - 2
	// DebugLevel  主要用于开发过程中打印运行信息
	DebugLevel
	// InfoLevel 用于输出程序运行的重要信息或感兴趣的信息，为默认级别
	InfoLevel
	// WarnLevel 表明会出现潜在错误的情形
	WarnLevel
	// ErrorLevel 打印错误和异常信息
	ErrorLevel
	// FatalLevel 重大错误，出现这种级别的事件会导致程序不能继续运行
	FatalLevel
)

func ParseLevel 

func ParseLevel(levelStr string) Level

ParseLevel 从字符串level中得到 logger level

func (Level) Key 

func (l Level) Key() string

func (Level) String 

func (l Level) String() string

type Logger 

type Logger interface {
	Log(level Level, keyAndVals ...interface{}) error // keyAndVals 是一个平铺的键值数组，它的长度需要是偶数，奇数位上的是key，偶数位上的是value
}

func GetLogger 

func GetLogger() Logger

GetLogger returns global logger appliance as logger in current process.

func NewStdLogger 

func NewStdLogger(w io.Writer) Logger

NewStdLogger new a logger with writer.

func With 

func With(l Logger, kv ...interface{}) Logger

With logger.With方法会返回一个新的Logger，把参数的Valuer绑上去。 logger = logger.With(logger, "ts", logger.DefaultTimestamp, "caller", logger.DefaultCaller)

func WithContext 

func WithContext(ctx context.Context, l Logger) Logger

WithContext returns a shallow copy of l with its context changed to ctx. The provided ctx must be non-nil.

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 自定义输出函数

func WithSprintf 

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

WithSprintf 自定义格式化输出函数

type Valuer 

type Valuer func(ctx context.Context) interface{}

func Caller 

func Caller(depth int) Valuer

Caller returns a Valuer that returns a pkg/file:line description of the caller.

func Timestamp 

func Timestamp(layout string) Valuer

Timestamp returns a timestamp Valuer with a custom time format.

type WriterOptionFn 

type WriterOptionFn func(w *writerWrapper)

func WithWriteMessageKey 

func WithWriteMessageKey(key string) WriterOptionFn

WithWriteMessageKey set writerWrapper helper message key.

func WithWriterLevel 

func WithWriterLevel(level Level) WriterOptionFn

WithWriterLevel set writerWrapper level.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.