log

README

日志API设计

日志API需求

1. 日志分级;
2. 日志存档（文件，ELK等）;
3. 日志API

日志API实现

1. log包提供一个对外部稳定的API，外部不必关注log包内部是如何实现（内部目前使用uber zap）;
2. 业务package只需要import log即可使用日志，不必在new其它对象；
3. 通过不同的API名称实现日志分级

接口	作用
log.Setup()	设置参数
log.Debugf()	调试日志
log.Infof()	信息日志
log.Warnf()	警告日志
log.Errorf()	错误日志
log.Fatalf()	错误日志，程序不能继续执行

Documentation

Index

• Constants
• func AppFileErrorLog(format string, a ...interface{}) error
• func DPanicf(format string, args ...interface{})
• func Debugf(format string, args ...interface{})
• func Errorf(format string, args ...interface{})
• func Fatalf(format string, args ...interface{})
• func Infof(format string, args ...interface{})
• func IsTerminal(w io.Writer) bool
• func Panicf(format string, args ...interface{})
• func ServerErrorLog(format string, a ...interface{})
• func Setup(isProduction, enableSysLog bool, level, filepath, args string)
• func Shutdown()
• func Warnf(format string, args ...interface{})
• func WriteFileLog(filename, format string, a ...interface{}) error
• type FileLogger
  • func NewFileWriter(prefix string) *FileLogger
  • func (w *FileLogger) Sync() error
  • func (w *FileLogger) Write(data []byte) error
• type Hooker
  • func NewSyslogHook(network, raddr string, priority syslog.Priority, tag string) Hooker
• type SyslogHook
  • func (h *SyslogHook) Fire(entry zapcore.Entry) error
  • func (h *SyslogHook) Name() string

Constants

const (
	TimestampFormat = "2006-01-02 15:04:05.999"
)

Functions

func AppFileErrorLog

func AppFileErrorLog(format string, a ...interface{}) error

func DPanicf

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

func Debugf

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

func Errorf

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

func Fatalf

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

func Infof

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

func IsTerminal

func IsTerminal(w io.Writer) bool

func Panicf

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

func ServerErrorLog

func ServerErrorLog(format string, a ...interface{})

用于在初始化服务时的错误日志

func Setup

func Setup(isProduction, enableSysLog bool, level, filepath, args string)

func Shutdown

func Shutdown()

func Warnf

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

func WriteFileLog

func WriteFileLog(filename, format string, a ...interface{}) error

Types

type FileLogger

type FileLogger struct {
	// contains filtered or unexported fields
}

记录日志到文件

func NewFileWriter

func NewFileWriter(prefix string) *FileLogger

func (*FileLogger) Sync

func (w *FileLogger) Sync() error

func (*FileLogger) Write

func (w *FileLogger) Write(data []byte) error

type Hooker

type Hooker interface {
	Name() string
	Fire(entry zapcore.Entry) error
}

func NewSyslogHook

func NewSyslogHook(network, raddr string, priority syslog.Priority, tag string) Hooker

Creates a hook to be added to an instance of logger. This is called with `hook, err := NewSyslogHook("udp", "localhost:514", syslog.LOG_DEBUG, "")`

type SyslogHook

type SyslogHook struct {
	// contains filtered or unexported fields
}

SyslogHook to send logs via syslog.

func (*SyslogHook) Fire

func (h *SyslogHook) Fire(entry zapcore.Entry) error

func (*SyslogHook) Name

func (h *SyslogHook) Name() string