log

Documentation

Index

• func C(ctx context.Context) *zapLogger
• func Debugw(msg string, keysAndValues ...interface{})
• func Errorw(msg string, keysAndValues ...interface{})
• func Fatalw(msg string, keysAndValues ...interface{})
• func Infow(msg string, keysAndValues ...interface{})
• func Init(opts *Options)
• func NewLogger(opts *Options) *zapLogger
• func Panicw(msg string, keysAndValues ...interface{})
• func Sync()
• func Warnw(msg string, keysAndValues ...interface{})
• type Logger
• type Options
  • func NewOptions() *Options

Functions

func C

func C(ctx context.Context) *zapLogger

C 解析传入的 context，尝试提取关注的键值，并添加到 zap.Logger 结构化日志中.

func Debugw

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

Debugw 输出 debug 级别的日志.

func Errorw

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

Errorw 输出 error 级别的日志.

func Fatalw

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

Fatalw 输出 fatal 级别的日志.

func Infow

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

Infow 输出 info 级别的日志.

func Init

func Init(opts *Options)

Init 使用指定的选项初始化 Logger.

func NewLogger

func NewLogger(opts *Options) *zapLogger

NewLogger 根据传入的 opts 创建 Logger.

func Panicw

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

Panicw 输出 panic 级别的日志.

func Sync

func Sync()

Sync 调用底层 zap.Logger 的 Sync 方法，将缓存中的日志刷新到磁盘文件中. 主程序需要在退出前调用 Sync.

func Warnw

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

Warnw 输出 warning 级别的日志.

Types

type Logger

type Logger interface {
	Debugw(msg string, keysAndValues ...interface{})
	Infow(msg string, keysAndValues ...interface{})
	Warnw(msg string, keysAndValues ...interface{})
	Errorw(msg string, keysAndValues ...interface{})
	Panicw(msg string, keysAndValues ...interface{})
	Fatalw(msg string, keysAndValues ...interface{})
	Sync()
}

Logger 定义了 miniblog 项目的日志接口. 该接口只包含了支持的日志记录方法.

type Options

type Options struct {
	// 是否开启 caller，如果开启会在日志中显示调用日志所在的文件和行号
	DisableCaller bool
	// 是否禁止在 panic 及以上级别打印堆栈信息
	DisableStacktrace bool
	// 指定日志级别，可选值：debug, info, warn, error, dpanic, panic, fatal
	Level string
	// 指定日志显示格式，可选值：console, json
	Format string
	// 指定日志输出位置
	OutputPaths []string
}

Options 包含与日志相关的配置项.

func NewOptions

func NewOptions() *Options

NewOptions 创建一个带有默认参数的 Options 对象.