logger

Documentation

Index

• Constants
• Variables
• func CreateLog() error
• func NewGwriterWithStdout(c *Conf) (io.Writer, error)
• type Conf
  • func DefaultConf() *Conf
• type GWriter
  • func (w *GWriter) Close() error
  • func (w *GWriter) CompressFile(srcFile string) error
  • func (w *GWriter) Rolling() error
  • func (w *GWriter) Write(b []byte) (n int, err error)
• type IGWriter
  • func NewGwriter(c *Conf) (IGWriter, error)

Constants

const (
	// RollNon 日志文件不轮转
	RollNon int = 0

	// RollBySize 按大小轮转
	RollBySize int = 1

	// RollByTime 按时间轮转
	RollByTime int = 2
)

Variables

var (
	// TRACE 记录所有日志
	TRACE *log.Logger

	// INFO 记录重要信息日志
	INFO *log.Logger

	// DEBUG 记录调试信息日志
	DEBUG *log.Logger

	// ERROR 记录错误信息日志
	ERROR *log.Logger
)

Functions

func CreateLog

func CreateLog() error

CreateLog 创建日志记录

func NewGwriterWithStdout

func NewGwriterWithStdout(c *Conf) (io.Writer, error)

NewGwriterWithStdout 创建带控制台输出的 MultiWriter

Types

type Conf

type Conf struct {

	// 文件路径 如: C:\\log
	FilePath string `json:"filePath"`

	// 命名日期时间格式：yyyyMMddHHmmss
	TimePatten string

	// 文件名 如：system.log
	FileName string `json:"fileName"`

	// 保留天数，超过后自动清除
	RemainDay int `json:"remainDay"`

	// 文件滚动策略，按大小，按时间等等
	// RollPolicy 策略支持 RollNon, RollBySize, RollByTime
	// RollTime 滚动的时间间隔，单位秒
	// RollSize 滚动的文件大小，单位Byte
	RollPolicy int   `json:"rollPolicy"`
	RollTime   int64 `json:"rollTime"`
	RollSize   int64 `json:"rollSize"`

	// 是否压缩
	Compress bool `json:"compress"`
}

Conf 是 Gwriter 的配置文件

func DefaultConf

func DefaultConf() *Conf

DefaultConf 创建默认GLog配置

type GWriter

type GWriter struct {

	// 写操作同步锁
	sync.Mutex
	// contains filtered or unexported fields
}

GWriter 是一个线程安全的文件写入对象，它实现了IGWriter接口

func (*GWriter) Close

func (w *GWriter) Close() error

Close GWriter 实现 IGWriter 中的 Close 接口

func (*GWriter) CompressFile

func (w *GWriter) CompressFile(srcFile string) error

CompressFile 文件gz压缩

func (*GWriter) Rolling

func (w *GWriter) Rolling() error

Rolling 轮换文件

func (*GWriter) Write

func (w *GWriter) Write(b []byte) (n int, err error)

Write GWriter 实现 IGWriter 中的 io.Writer 接口

type IGWriter

type IGWriter interface {
	io.Writer
	Close() error
}

IGWriter 实现了 io.writer，可以将其传入任何框架以支持日志文件记录

func NewGwriter

func NewGwriter(c *Conf) (IGWriter, error)

NewGwriter 创建 Gwriter