logs

Documentation

Overview

Package logs 日志操作

这是对 logs 的二次定义，方便使用者引用。

Index

• Constants
• func Destroy(l *ParamsLogs)
• func NewRotateFile(format, dir string, size int64) (io.WriteCloser, error)
• func NewSMTP(username, password, subject, host string, sendTo []string) io.Writer
• type Entry
• type Level
  • func AllLevels() []Level
• type Logger
• type Logs
  • func New(opt *Options, p *message.Printer) *Logs
  • func (l *Logs) DEBUG() Logger
  • func (l *Logs) ERROR() Logger
  • func (l *Logs) FATAL() Logger
  • func (l *Logs) INFO() Logger
  • func (l *Logs) NewEntry(lv Level) *Entry
  • func (l *Logs) TRACE() Logger
  • func (l *Logs) WARN() Logger
  • func (l *Logs) With(ps map[string]any) *ParamsLogs
• type Options
• type ParamsLogs
  • func (l *ParamsLogs) DEBUG() Logger
  • func (l *ParamsLogs) ERROR() Logger
  • func (l *ParamsLogs) FATAL() Logger
  • func (l *ParamsLogs) INFO() Logger
  • func (l *ParamsLogs) NewEntry(lv Level) *Entry
  • func (l *ParamsLogs) TRACE() Logger
  • func (l *ParamsLogs) WARN() Logger
• type Writer
  • func MergeWriter(w ...Writer) Writer
  • func NewDispatchWriter(d map[Level]Writer) Writer
  • func NewJSONWriter(timeLayout string, w ...io.Writer) Writer
  • func NewNopWriter() Writer
  • func NewTermWriter(timeLayout string, fore colors.Color, w io.Writer) Writer
  • func NewTextWriter(timeLayout string, w ...io.Writer) Writer

Constants

const (
	MicroLayout = logs.MicroLayout
	MilliLayout = logs.MilliLayout
	NanoLayout  = logs.NanoLayout
)

日志的时间格式

const (
	Info  = logs.LevelInfo
	Trace = logs.LevelTrace
	Warn  = logs.LevelWarn
	Debug = logs.LevelDebug
	Error = logs.LevelError
	Fatal = logs.LevelFatal
)

日志的类别

Functions

func Destroy

func Destroy(l *ParamsLogs)

Destroy 回收由 ParamsLogs 对象

这是一个非必须的方法，调用可能会有一定的性能提升。

func NewRotateFile

func NewRotateFile(format, dir string, size int64) (io.WriteCloser, error)

NewRotateFile 按大小分割的文件日志

参数说明参考 rotate.New

func NewSMTP

func NewSMTP(username, password, subject, host string, sendTo []string) io.Writer

NewSMTP 将日志内容发送至指定邮箱

参数说明参考 writers.NewSMTP

Types

type Entry

type Entry = logs.Entry

type Level

type Level = logs.Level

func AllLevels

func AllLevels() []Level

type Logger

type Logger = logs.Logger

type Logs

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

Logs 日志对象

func New

func New(opt *Options, p *message.Printer) *Logs

New 声明日志实例

func (*Logs) DEBUG

func (l *Logs) DEBUG() Logger

func (*Logs) ERROR

func (l *Logs) ERROR() Logger

func (*Logs) FATAL

func (l *Logs) FATAL() Logger

func (*Logs) INFO

func (l *Logs) INFO() Logger

func (*Logs) NewEntry

func (l *Logs) NewEntry(lv Level) *Entry

func (*Logs) TRACE

func (l *Logs) TRACE() Logger

func (*Logs) WARN

func (l *Logs) WARN() Logger

func (*Logs) With

func (l *Logs) With(ps map[string]any) *ParamsLogs

With 构建一个带有指定参数日志对象

type Options

type Options struct {
	Writer          Writer
	Caller, Created bool

	// 允许的日志通道
	Levels []Level
}

Options 初始化日志的选项

type ParamsLogs

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

ParamsLogs 带参数的日志

func (*ParamsLogs) DEBUG

func (l *ParamsLogs) DEBUG() Logger

func (*ParamsLogs) ERROR

func (l *ParamsLogs) ERROR() Logger

func (*ParamsLogs) FATAL

func (l *ParamsLogs) FATAL() Logger

func (*ParamsLogs) INFO

func (l *ParamsLogs) INFO() Logger

func (*ParamsLogs) NewEntry

func (l *ParamsLogs) NewEntry(lv Level) *Entry

func (*ParamsLogs) TRACE

func (l *ParamsLogs) TRACE() Logger

func (*ParamsLogs) WARN

func (l *ParamsLogs) WARN() Logger

type Writer

type Writer = logs.Writer

func MergeWriter

func MergeWriter(w ...Writer) Writer

MergeWriter 将多个 Writer 合并成一个 Writer 接口对象

func NewDispatchWriter

func NewDispatchWriter(d map[Level]Writer) Writer

func NewJSONWriter

func NewJSONWriter(timeLayout string, w ...io.Writer) Writer

func NewNopWriter

func NewNopWriter() Writer

func NewTermWriter

func NewTermWriter(timeLayout string, fore colors.Color, w io.Writer) Writer

NewTermWriter 带颜色的终端输出通道

参数说明参考 logs.NewTermWriter

func NewTextWriter

func NewTextWriter(timeLayout string, w ...io.Writer) Writer