log

Documentation

Index

• type Config
  • func FromURL(u *url.URL) (*Config, error)
  • func (c *Config) String() string
• type Field
  • func Any(key string, val interface{}) Field
  • func Code(err error) Field
  • func Error(err error) Field
• type Level
• type Logger
  • func Init(cfg Config, fields ...Field) (*Logger, error)
  • func L() *Logger
  • func With(fields ...Field) *Logger
• type Option

Types

type Config

type Config struct {
	Level       string `yaml:"level" json:"level" default:"info" validate:"regexp=^(fatal|panic|error|warn|info|debug)$"`
	Encoding    string `yaml:"encoding" json:"encoding" default:"json" validate:"regexp=^(json|console)$"`
	Filename    string `yaml:"filename" json:"filename"`
	Compress    bool   `yaml:"compress" json:"compress"`
	MaxAge      int    `yaml:"maxAge" json:"maxAge" default:"15" validate:"min=1"`   // days
	MaxSize     int    `yaml:"maxSize" json:"maxSize" default:"50" validate:"min=1"` // MB
	MaxBackups  int    `yaml:"maxBackups" json:"maxBackups" default:"15" validate:"min=1"`
	EncodeTime  string `yaml:"encodeTime" json:"encodeTime"`   // time format, like [2006/01/02 15:04:05 UTC]
	EncodeLevel string `yaml:"encodeLevel" json:"encodeLevel"` // symbols surround level, like [level]
}

Config for logging

func FromURL

func FromURL(u *url.URL) (*Config, error)

FromURL creates config from url

func (*Config) String

func (c *Config) String() string

type Field

type Field = zap.Field

Field log field

func Any

func Any(key string, val interface{}) Field

Any constructs a field with the given key and value

func Code

func Code(err error) Field

Code constructs a field with the given value and code key

func Error

func Error(err error) Field

Error constructs a field with the given value and error key

type Level

type Level = zapcore.Level

Level log level

const (
	DebugLevel Level = iota - 1
	InfoLevel
	WarnLevel
	ErrorLevel
	PanicLevel
	FatalLevel
)

all log level

type Logger

type Logger = zap.Logger

Logger logger

func Init

func Init(cfg Config, fields ...Field) (*Logger, error)

Init init and return logger

func L

func L() *Logger

L returns the global Logger, which can be reconfigured with ReplaceGlobals. It's safe for concurrent use.

func With

func With(fields ...Field) *Logger

With creates a child logger and adds structured context to it. Fields added to the child don't affect the parent, and vice versa.

type Option

type Option = zap.Option

Option log Option