log

Documentation

Index

• Variables
• func CheckIntLevel(level int32) bool
• func Debug(msg string, fields ...Field)
• func Debugf(format string, v ...interface{})
• func Debugw(msg string, keysAndValues ...interface{})
• func Error(msg string, fields ...Field)
• func Errorf(format string, v ...interface{})
• func Errorw(msg string, keysAndValues ...interface{})
• func Fatal(msg string, fields ...Field)
• func Fatalf(format string, args ...interface{})
• func Fatalw(msg string, keysAndValues ...interface{})
• func Flush()
• func GetLogger() *zapLogger
• func Info(msg string, fields ...Field)
• func Infof(format string, v ...interface{})
• func Infow(msg string, keysAndValues ...interface{})
• func Init(opts *Options)
• func Panic(msg string, fields ...Field)
• func Panicf(format string, v ...interface{})
• func Panicw(msg string, keysAndValues ...interface{})
• func StdErrLogger() *log.Logger
• func StdInfoLogger() *log.Logger
• func Warn(msg string, fields ...Field)
• func Warnf(format string, v ...interface{})
• func Warnw(msg string, keysAndValues ...interface{})
• func ZapLogger() *zap.Logger
• type Field
• type InfoLogger
  • func V(level int) InfoLogger
• type Level
• type Logger
  • func FromContext(ctx context.Context) Logger
  • func NewLogger(l *zap.Logger) Logger
  • func WithName(name string) Logger
  • func WithValues(keysAndValues ...interface{}) Logger
• type Options
  • func GetOptions() *Options
  • func NewOptions() *Options
  • func (o *Options) AddFlags(fs *pflag.FlagSet)
  • func (o *Options) String() string
  • func (o *Options) Validate() []error

Variables

var (
	DebugLevel  = zapcore.DebugLevel
	InfoLevel   = zapcore.InfoLevel
	WarnLevel   = zapcore.WarnLevel
	ErrorLevel  = zapcore.ErrorLevel
	DPanicLevel = zapcore.DPanicLevel
	PanicLevel  = zapcore.PanicLevel
	FatalLevel  = zapcore.FatalLevel
)

var (
	Any         = zap.Any
	Array       = zap.Array
	Object      = zap.Object
	Binary      = zap.Binary
	Bool        = zap.Bool
	Bools       = zap.Bools
	ByteString  = zap.ByteString
	ByteStrings = zap.ByteStrings
	Complex64   = zap.Complex64
	Complex64s  = zap.Complex64s
	Complex128  = zap.Complex128
	Complex128s = zap.Complex128s
	Duration    = zap.Duration
	Durations   = zap.Durations
	Err         = zap.Error
	Errors      = zap.Errors
	Float32     = zap.Float32
	Float32s    = zap.Float32s
	Float64     = zap.Float64
	Float64s    = zap.Float64s
	Int         = zap.Int
	Ints        = zap.Ints
	Int8        = zap.Int8
	Int8s       = zap.Int8s
	Int16       = zap.Int16
	Int16s      = zap.Int16s
	Int32       = zap.Int32
	Int32s      = zap.Int32s
	Int64       = zap.Int64
	Int64s      = zap.Int64s
	Namespace   = zap.Namespace
	Reflect     = zap.Reflect
	Stack       = zap.Stack
	String      = zap.String
	Stringer    = zap.Stringer
	Strings     = zap.Strings
	Time        = zap.Time
	Times       = zap.Times
	Uint        = zap.Uint
	Uints       = zap.Uints
	Uint8       = zap.Uint8
	Uint8s      = zap.Uint8s
	Uint16      = zap.Uint16
	Uint16s     = zap.Uint16s
	Uint32      = zap.Uint32
	Uint32s     = zap.Uint32s
	Uint64      = zap.Uint64
	Uint64s     = zap.Uint64s
	Uintptr     = zap.Uintptr
	Uintptrs    = zap.Uintptrs
)

Functions

func CheckIntLevel

func CheckIntLevel(level int32) bool

message at the specified level is enabled.

func Debug

func Debug(msg string, fields ...Field)

Debug method output debug level log.

func Debugf

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

Debugf method output debug level log.

func Debugw

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

Debugw method output debug level log.

func Error

func Error(msg string, fields ...Field)

Error method output error level log.

func Errorf

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

Errorf method output error level log.

func Errorw

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

Errorw method output error level log.

func Fatal

func Fatal(msg string, fields ...Field)

Fatal method output fatal level log.

func Fatalf

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

Fatalf method output fatal level log.

func Fatalw

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

Fatalw method output Fatalw level log.

func Flush

func Flush()

func GetLogger

func GetLogger() *zapLogger

func Info

func Info(msg string, fields ...Field)

Info method output info level log.

func Infof

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

Infof method output info level log.

func Infow

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

Infow method output info level log.

func Init

func Init(opts *Options)

func Panic

func Panic(msg string, fields ...Field)

Panic method output panic level log and shutdown application.

func Panicf

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

Panicf method output panic level log and shutdown application.

func Panicw

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

Panicw method output panic level log.

func StdErrLogger

func StdErrLogger() *log.Logger

func StdInfoLogger

func StdInfoLogger() *log.Logger

func Warn

func Warn(msg string, fields ...Field)

Warn method output warning level log.

func Warnf

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

Warnf method output warning level log.

func Warnw

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

Warnw method output warning level log.

func ZapLogger

func ZapLogger() *zap.Logger

Types

type Field

type Field = zapcore.Field

type InfoLogger

type InfoLogger interface {
	Info(msg string, keysAndValues ...interface{})
	Infof(format string, args ...interface{})
	Enabled() bool
}

InfoLogger represents the ability to log non-error messages, at a particular verbosity.

func V

func V(level int) InfoLogger

type Level

type Level = zapcore.Level

type Logger

type Logger interface {
	InfoLogger

	Error(err error, msg string, keysAndValues ...interface{})
	Errorf(format string, args ...interface{})

	V(level int) InfoLogger

	Write(p []byte) (n int, err error)

	WithValues(keysAndValues ...interface{}) Logger

	WithName(name string) Logger

	WithContext(ctx context.Context) context.Context

	Flush()
}

func FromContext

func FromContext(ctx context.Context) Logger

func NewLogger

func NewLogger(l *zap.Logger) Logger

func WithName

func WithName(name string) Logger

func WithValues

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

type Options

type Options struct {
	Level            string   `json:"level"              mapstructure:"level"`
	Format           string   `json:"format"             mapstructure:"format"`
	EnableColor      bool     `json:"enable-color"       mapstructure:"enable-color"`
	EnableCaller     bool     `json:"enable-caller"      mapstructure:"enable-caller"`
	OutputPaths      []string `json:"output-paths"       mapstructure:"output-paths"`
	ErrorOutputPaths []string `json:"error-output-paths" mapstructure:"error-output-paths"`
}

Options contains the configuration for the logger.

func GetOptions

func GetOptions() *Options

func NewOptions

func NewOptions() *Options

NewOptions returns a new Options instance.

func (*Options) AddFlags

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

AddFlags adds the flags for Options.

func (*Options) String

func (o *Options) String() string

func (*Options) Validate

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

Validate validates the Options.