log

Documentation

Index

• Constants
• func Register(name string, adapter Instance)
• type Config
  • func (c *Config) CheckWithDefault()
• type Instance
• type Level
• type Logger
  • func NewLogger(adapterName string, config Config) (adapter Logger, err error)

Constants

const (
	// TypeZsskyLog - use zssky log
	TypeZsskyLog = "zssky"
	// TypeLogrus - use logrus
	TypeLogrus = "logrus"
)

Functions

func Register

func Register(name string, adapter Instance)

Register makes a Logger adapter available by the adapter name. If Register is called twice with the same name or if driver is nil, it panics.

Types

type Config

type Config struct {
	Level         Level  `json:"level"`
	FilePath      string `json:"file_path"`
	HighLighting  bool   `json:"highlighting"`
	JSONFormatter bool   `json:"json_formatter"`
	AlsoToStdOut  bool   `json:"also_to_std_out"`
	CallerSkip    int    `json:"caller_skip"`

	// Rotation config
	RotationTime   time.Duration `json:"rotation_time"`
	RotationMaxAge time.Duration `json:"rotate_max_age"`
	RotationCount  uint          `json:"rotation_count"`

	// Extend fields
	// Extended fields can be used if there is a special implementation
	Extend1 string `json:"extend_1"`
	Extend2 string `json:"extend_2"`
}

Config - log base config

func (*Config) CheckWithDefault

func (c *Config) CheckWithDefault()

CheckWithDefault - check default value, if not set use default

type Instance

type Instance func() Logger

Instance is a function create a new Logger Instance

type Level

type Level string

Level - log level

const (
	// LevelInfo - info log
	LevelInfo Level = "info"
	// LevelDebug - debug log
	LevelDebug Level = "debug"
	// LevelWarning - warning log
	LevelWarning Level = "warn"
	// LevelError - error log
	LevelError Level = "error"
	// LevelFatal - fatal log
	LevelFatal Level = "fatal"
)

type Logger

type Logger interface {
	// Infof - info format log
	Infof(format string, v ...interface{})

	// Info - info format log
	Info(v ...interface{})

	// Debugf - debug format log
	Debugf(format string, v ...interface{})

	// Debug - debug format log
	Debug(v ...interface{})

	// Warnf - warn format log
	Warnf(format string, v ...interface{})

	// Warn - warn log
	Warn(v ...interface{})

	// Warningf - Warning format log
	Warningf(format string, v ...interface{})

	// Warning - Warning log
	Warning(v ...interface{})

	// Errorf - error format log
	Errorf(format string, v ...interface{})

	// Error - error format log
	Error(v ...interface{})

	// Fatalf - fatal format log
	Fatalf(format string, v ...interface{})

	// Fatal - fatal format log
	Fatal(v ...interface{})

	// Fatalln - fatal log
	Fatalln(v ...interface{})

	// Printf - printf format value
	Printf(format string, v ...interface{})

	// Print - printf value
	Print(v ...interface{})

	// Println - print value
	Println(v ...interface{})

	// Panic - panic
	Panic(v ...interface{})

	// Panicf - panic format value
	Panicf(format string, v ...interface{})

	// Panicln - panic
	Panicln(v ...interface{})

	// close connection
	Close() error

	// start gc routine based on config settings.
	StartAndGC(config Config) error
}

Logger interface contains all behaviors for log adapter.

func NewLogger

func NewLogger(adapterName string, config Config) (adapter Logger, err error)

NewLogger Create a new Logger driver by adapter name and config string. it will start gc automatically.