log

Documentation

Index

• func Debugf(format string, args ...interface{})
• func Debugw(msg string, keysAndValues ...interface{})
• func Errorf(format string, args ...interface{})
• func Errorw(msg string, keysAndValues ...interface{})
• func Fatalf(format string, args ...interface{})
• func Fatalw(msg string, keysAndValues ...interface{})
• func Infof(format string, args ...interface{})
• func Infow(msg string, keysAndValues ...interface{})
• func Init(opts *Options) (err error)
• func Panicf(format string, args ...interface{})
• func Panicw(msg string, keysAndValues ...interface{})
• func Sync()
• func Warnf(format string, args ...interface{})
• func Warnw(msg string, keysAndValues ...interface{})
• type Logger
  • func L() Logger
  • func NewZapLogger(opts *Options) (Logger, error)
  • func WithValues(keysAndValues ...interface{}) Logger
• type Options
  • func NewOptions() *Options
• type SugaredLogger
  • func (l *SugaredLogger) Sync()
  • func (l *SugaredLogger) WithValues(keysAndValues ...interface{}) Logger

Functions

func Debugf

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

Debugf 使用全局日志记录器记录一条调试级别的消息。

func Debugw

func Debugw(msg string, keysAndValues ...interface{})

Debugw 使用全局日志记录器记录一条调试级别的结构化消息。

func Errorf

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

Errorf 使用全局日志记录器记录一条错误级别的消息。

func Errorw

func Errorw(msg string, keysAndValues ...interface{})

Errorw 使用全局日志记录器记录一条错误级别的结构化消息。

func Fatalf

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

Fatalf 使用全局日志记录器记录一条致命级别的消息。

func Fatalw

func Fatalw(msg string, keysAndValues ...interface{})

Fatalw 使用全局日志记录器记录一条致命级别的结构化消息。

func Infof

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

Infof 使用全局日志记录器记录一条信息级别的消息。

func Infow

func Infow(msg string, keysAndValues ...interface{})

Infow 使用全局日志记录器记录一条信息级别的结构化消息。

func Init

func Init(opts *Options) (err error)

Init 使用给定的选项初始化全局日志记录器。 它会替换掉 failsafe 日志记录器。

func Panicf

func Panicf(format string, args ...interface{})

Panicf 使用全局日志记录器记录一条 panic 级别的消息。

func Panicw

func Panicw(msg string, keysAndValues ...interface{})

Panicw 使用全局日志记录器记录一条 panic 级别的结构化消息。

func Sync

func Sync()

Sync 同步全局日志记录器。

func Warnf

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

Warnf 使用全局日志记录器记录一条警告级别的消息。

func Warnw

func Warnw(msg string, keysAndValues ...interface{})

Warnw 使用全局日志记录器记录一条警告级别的结构化消息。

Types

type Logger

type Logger interface {
	// Debugf 使用 fmt.Sprintf 格式记录一条调试级别的消息。
	Debugf(format string, args ...interface{})
	// Infof 使用 fmt.Sprintf 格式记录一条信息级别的消息。
	Infof(format string, args ...interface{})
	// Warnf 使用 fmt.Sprintf 格式记录一条警告级别的消息。
	Warnf(format string, args ...interface{})
	// Errorf 使用 fmt.Sprintf 格式记录一条错误级别的消息。
	Errorf(format string, args ...interface{})
	// Panicf 使用 fmt.Sprintf 格式记录一条 panic 级别的消息，然后 panic。
	Panicf(format string, args ...interface{})
	// Fatalf 使用 fmt.Sprintf 格式记录一条致命级别的消息，然后调用 os.Exit。
	Fatalf(format string, args ...interface{})

	// Debugw 记录一条调试级别的结构化消息。
	Debugw(msg string, keysAndValues ...interface{})
	// Infow 记录一条信息级别的结构化消息。
	Infow(msg string, keysAndValues ...interface{})
	// Warnw 记录一条警告级别的结构化消息。
	Warnw(msg string, keysAndValues ...interface{})
	// Errorw 记录一条错误级别的结构化消息。
	Errorw(msg string, keysAndValues ...interface{})
	// Panicw 记录一条 panic 级别的结构化消息，然后 panic。
	Panicw(msg string, keysAndValues ...interface{})
	// Fatalw 记录一条致命级别的结构化消息，然后调用 os.Exit。
	Fatalw(msg string, keysAndValues ...interface{})

	// WithValues 添加一些上下文键值对到日志记录器。
	WithValues(keysAndValues ...interface{}) Logger
	// Sync 调用底层 Core 的 Sync 方法，刷新所有缓冲的日志条目。
	// 应用程序应尽量调用 Sync，在退出前刷新日志。
	Sync()
}

Logger 定义了项目所需的日志接口。 它是 go-kit log.Logger 和 zap.SugaredLogger 的一个子集。

func L

func L() Logger

L 返回全局日志记录器。

func NewZapLogger

func NewZapLogger(opts *Options) (Logger, error)

NewZapLogger 根据给定的选项创建一个新的 zapLogger。

func WithValues

func WithValues(keysAndValues ...interface{}) Logger

WithValues 返回一个包含额外上下文的全局日志记录器。

type Options

type Options struct {
	// OutputPaths 是一个文件路径列表，用于写入日志。
	// 使用 "stdout" 或 "stderr" 来登录到控制台。
	OutputPaths []string `json:"output-paths" mapstructure:"output-paths"`
	// ErrorOutputPaths 是一个文件路径列表，用于写入错误日志。
	ErrorOutputPaths []string `json:"error-output-paths" mapstructure:"error-output-paths"`
	// Level 是将要记录的最低日志级别。
	// 可用级别: "debug", "info", "warn", "error", "dpanic", "panic", "fatal"
	Level string `json:"level" mapstructure:"level"`
	// Format 是日志格式。可以是 "json" 或 "console"。
	Format string `json:"format" mapstructure:"format"`
	// EnableCaller 确定是否在日志中包含调用者信息。
	EnableCaller bool `json:"enable-caller" mapstructure:"enable-caller"`
	// Name 是日志记录器的名称。
	Name string `json:"name" mapstructure:"name"`
}

Options 包含日志记录器的配置选项

func NewOptions

func NewOptions() *Options

NewOptions 创建一个带有默认值的新 Options 对象。

type SugaredLogger

type SugaredLogger struct {
	*zap.SugaredLogger
}

SugaredLogger 是 zap.SugaredLogger 的一个包装器，它实现了 Logger 接口。

func (*SugaredLogger) Sync

func (l *SugaredLogger) Sync()

Sync 同步底层 zap 日志记录器。

func (*SugaredLogger) WithValues

func (l *SugaredLogger) WithValues(keysAndValues ...interface{}) Logger

WithValues 返回一个新的 SugaredLogger，其中包含额外的上下文。