log

Documentation

Overview

Package log is a log package used by onex project.

Index

• func Debugf(format string, args ...any)
• func Debugw(msg string, keyvals ...any)
• func Errorf(format string, args ...any)
• func Errorw(err error, msg string, keyvals ...any)
• func Fatalf(format string, args ...any)
• func Fatalw(msg string, keyvals ...any)
• func Infof(format string, args ...any)
• func Infow(msg string, keyvals ...any)
• func Init(opts *Options)
• func Panicf(format string, args ...any)
• func Panicw(msg string, keyvals ...any)
• func Sync()
• func Warnf(format string, args ...any)
• func Warnw(msg string, keyvals ...any)
• func WithContext(ctx context.Context, keyvals ...any) context.Context
• type Field
• type Logger
  • func AddCallerSkip(skip int) Logger
  • func C(ctx context.Context) Logger
  • func Default() Logger
  • func FromContext(ctx context.Context, keyvals ...any) Logger
  • func With(fields ...Field) Logger
• type Options
  • func NewOptions() *Options
  • func (o *Options) AddFlags(fs *pflag.FlagSet)
  • func (o *Options) Validate() []error

Functions

func Debugf

func Debugf(format string, args ...any)

Debugf 输出 debug 级别的日志.

func Debugw

func Debugw(msg string, keyvals ...any)

Debugw 输出 debug 级别的日志.

func Errorf

func Errorf(format string, args ...any)

Errorf 输出 error 级别的日志.

func Errorw

func Errorw(err error, msg string, keyvals ...any)

Errorw 输出 error 级别的日志.

func Fatalf

func Fatalf(format string, args ...any)

Fatalf 输出 fatal 级别的日志.

func Fatalw

func Fatalw(msg string, keyvals ...any)

Fatalw 输出 fatal 级别的日志.

func Infof

func Infof(format string, args ...any)

Infof 输出 info 级别的日志.

func Infow

func Infow(msg string, keyvals ...any)

Infow 输出 info 级别的日志.

func Init

func Init(opts *Options)

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

func Panicf

func Panicf(format string, args ...any)

Panicf 输出 panic 级别的日志.

func Panicw

func Panicw(msg string, keyvals ...any)

Panicw 输出 panic 级别的日志.

func Sync

func Sync()

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

func Warnf

func Warnf(format string, args ...any)

Warnf 输出 warning 级别的日志.

func Warnw

func Warnw(msg string, keyvals ...any)

Warnw 输出 warning 级别的日志.

func WithContext

func WithContext(ctx context.Context, keyvals ...any) context.Context

WithContext returns a copy of context in which the log value is set.

Types

type Field

type Field = zapcore.Field

type Logger

type Logger interface {
	Debugf(format string, args ...any)
	Debugw(msg string, keyvals ...any)
	Infof(format string, args ...any)
	Infow(msg string, keyvals ...any)
	Warnf(format string, args ...any)
	Warnw(msg string, keyvals ...any)
	Errorf(format string, args ...any)
	Errorw(err error, msg string, keyvals ...any)
	Panicf(format string, args ...any)
	Panicw(msg string, keyvals ...any)
	Fatalf(format string, args ...any)
	Fatalw(msg string, keyvals ...any)
	With(fields ...Field) Logger
	AddCallerSkip(skip int) Logger
	Sync()

	gormlogger.Interface
}

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

func AddCallerSkip

func AddCallerSkip(skip int) Logger

func C

func C(ctx context.Context) Logger

C represents for `FromContext` with empty keyvals.

func Default

func Default() Logger

func FromContext

func FromContext(ctx context.Context, keyvals ...any) Logger

FromContext returns a logger with predefined values from a context.Context.

func With

func With(fields ...Field) Logger

type Options

type Options struct {
	// DisableCaller specifies whether to include caller information in the log.
	DisableCaller bool `json:"disable-caller,omitempty" mapstructure:"disable-caller"`
	// DisableStacktrace specifies whether to record a stack trace for all messages at or above panic level.
	DisableStacktrace bool `json:"disable-stacktrace,omitempty" mapstructure:"disable-stacktrace"`
	// EnableColor specifies whether to output colored logs.
	EnableColor bool `json:"enable-color"       mapstructure:"enable-color"`
	// Level specifies the minimum log level. Valid values are: debug, info, warn, error, dpanic, panic, and fatal.
	Level string `json:"level,omitempty" mapstructure:"level"`
	// Format specifies the log output format. Valid values are: console and json.
	Format string `json:"format,omitempty" mapstructure:"format"`
	// OutputPaths specifies the output paths for the logs.
	OutputPaths []string `json:"output-paths,omitempty" mapstructure:"output-paths"`
}

Options contains configuration options for logging.

func NewOptions

func NewOptions() *Options

NewOptions creates a new Options object with default values.

func (*Options) AddFlags

func (o *Options) AddFlags(fs *pflag.FlagSet)

AddFlags adds command line flags for the configuration.

func (*Options) Validate

func (o *Options) Validate() []error

Validate verifies flags passed to LogsOptions.