log

Documentation

Index

• Constants
• Variables
• func DefaultConfig() *zap.Config
• func DefaultEncoderConfig() zapcore.EncoderConfig
• func HandleZapFields(withGoid bool, args []any, additional ...zap.Field) []zap.Field
• type Cfg
  • func NewCfg() *Cfg
  • func (c *Cfg) Build() (Logger, error)
• type Logger
  • func Default() Logger
  • func NewNopLogger() Logger
  • func NewZapLogger(c *Cfg) (Logger, error)

Constants

const (
	FilepathSplitter       = ","
	DefaultFilepath        = "stdout"
	DefaultMaxFileSize     = 100
	DefaultMaxBackups      = 30
	DefaultMaxAge          = 30
	DefaultDisableCompress = true
)

const (
	JSONFormat        = "json"
	ConsoleFormat     = "console"
	ConsoleLiteFormat = "consolelite"

	LevelEncoderCapital      = "capital"
	LevelEncoderCapitalColor = "capitalColor"
	LevelEncoderColor        = "color"
	LevelEncoderLowercase    = "lowercase"

	TimeEncoderRFC3339Nano = "rfc3339nano"
	TimeEncoderRFC3339     = "rfc3339"
	TimeEncoderISO8601     = "iso8601"
	TimeEncoderMillis      = "millis"
	TimeEncoderNanos       = "nanos"
	TimeEncoderSecond      = "second"
	TimeEncoderLayout      = "2006-01-02 15:04:05.000000"

	DurationEncoderString = "string"
	DurationEncoderNanos  = "nanos"
	DurationEncoderMillis = "ms"
	DurationEncoderSecond = "second"

	CallerEncoderFull  = "full"
	CallerEncoderShort = "short"

	NameEncoderFull = "full"

	DefaultLevel             = "info"
	DefaultIsDev             = false
	DefaultDisableCaller     = false
	DefaultDisableStacktrace = true // stack core will extract error stack, so zap's stack is useless

	DefaultFormat                  = ConsoleLiteFormat
	DefaultEncoderMessageKey       = "msg"
	DefaultEncoderLevelKey         = "lvl"
	DefaultEncoderNameKey          = "logger"
	DefaultEncoderTimeKey          = "ts"
	DefaultEncoderCallerKey        = "caller"
	DefaultEncoderFunctionKey      = ""
	DefaultEncoderStacktraceKey    = "stacktrace"
	DefaultEncoderSkipLineEncoding = false
	DefaultEncoderLineEnding       = "\n"
	DefaultEncoderLevelEncoder     = LevelEncoderLowercase
	DefaultEncoderTimeEncoder      = TimeEncoderLayout
	DefaultEncoderDurationEncoder  = DurationEncoderString
	DefaultEncoderCallerEncoder    = CallerEncoderShort
	DefaultEncoderNameEncoder      = NameEncoderFull
	DefaultEncoderConsoleSeparator = "\t"
)

Variables

var (
	DefaultOutputPath      = []string{"stdout"}
	DefaultErrorOutputPath = []string{"stderr"}
)

Functions

func DefaultConfig

func DefaultConfig() *zap.Config

func DefaultEncoderConfig

func DefaultEncoderConfig() zapcore.EncoderConfig

func HandleZapFields

func HandleZapFields(withGoid bool, args []any, additional ...zap.Field) []zap.Field

Types

type Cfg

type Cfg struct {
	Filepath        string `env:"LOG_PATH"             flag-long:"log-path"             yaml:"filepath"        flag-description:"log file path"`
	Format          string `env:"LOG_FORMAT"           flag-long:"log-format"           yaml:"format"          flag-description:"log line format"`
	MaxFileSize     int    `` /* 166-byte string literal not displayed */
	MaxBackups      int    `` /* 143-byte string literal not displayed */
	MaxAge          int    `` /* 197-byte string literal not displayed */
	Level           string `` /* 131-byte string literal not displayed */
	DisableCompress bool   `` /* 146-byte string literal not displayed */
}

Cfg is logger cfg include level, rotate, etc.

func NewCfg

func NewCfg() *Cfg

func (*Cfg) Build

func (c *Cfg) Build() (Logger, error)

Build logger from cfg. DO NOT CREATE GLOBAL LOGGER. USE PROVIDED LOGGER, SUCH AS Runner.Info

type Logger

type Logger interface {
	Debug(msg string, kvs ...any)
	Info(msg string, kvs ...any)
	Warn(msg string, kvs ...any)
	Error(msg string, err error, kvs ...any)

	WithLoggerName(n string) Logger
	WithLoggerFields(kvs ...any)
	SetLoggerLevel(lvl string)
}

Logger is a log interface. DO NOT CREATE GLOBAL LOGGER. USE PROVIDED LOG METHOD, SUCH AS Runner.Info.

func Default

func Default() Logger

func NewNopLogger

func NewNopLogger() Logger

func NewZapLogger

func NewZapLogger(c *Cfg) (Logger, error)