logs

Documentation

Overview

Package logs 日志操作

Index

• Constants
• func NewRotateFile(format, dir string, size int64) (io.WriteCloser, error)
• func NewSMTP(username, password, subject, host string, sendTo []string) io.Writer
• type Buffer
  • func NewBuffer(detail bool) *Buffer
• type Handler
  • func MergeHandler(w ...Handler) Handler
  • func NewDispatchHandler(d map[Level]Handler) Handler
  • func NewJSONHandler(w ...io.Writer) Handler
  • func NewNopHandler() Handler
  • func NewTermHandler(w io.Writer, colors map[Level]colors.Color) Handler
  • func NewTextHandler(w ...io.Writer) Handler
• type HandlerFunc
• type Level
  • func AllLevels() []Level
• type Logger
• type Logs
  • func New(p *localeutil.Printer, opt *Options) (Logs, error)
• type Options
• type Record

Constants

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

日志的类别

const (
	DateMilliLayout = logs.DateMilliLayout
	DateMicroLayout = logs.DateMicroLayout
	DateNanoLayout  = logs.DateNanoLayout

	MilliLayout = logs.MilliLayout
	MicroLayout = logs.MicroLayout
	NanoLayout  = logs.NanoLayout
)

日志的时间格式

Functions

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 Buffer

type Buffer = logs.Buffer

func NewBuffer

func NewBuffer(detail bool) *Buffer

type Handler

type Handler = logs.Handler

func MergeHandler

func MergeHandler(w ...Handler) Handler

MergeHandler 合并多个 Handler 对象

func NewDispatchHandler

func NewDispatchHandler(d map[Level]Handler) Handler

NewDispatchHandler 按不同的 Level 派发到不同的 Handler 对象

func NewJSONHandler

func NewJSONHandler(w ...io.Writer) Handler

func NewNopHandler

func NewNopHandler() Handler

func NewTermHandler

func NewTermHandler(w io.Writer, colors map[Level]colors.Color) Handler

NewTermHandler 带颜色的终端输出通道

参数说明参考 logs.NewTermHandler

func NewTextHandler

func NewTextHandler(w ...io.Writer) Handler

type HandlerFunc

type HandlerFunc = logs.HandlerFunc

type Level

type Level = logs.Level

func AllLevels

func AllLevels() []Level

type Logger

type Logger = logs.Logger

type Logs

type Logs interface {
	INFO() Logger

	WARN() Logger

	TRACE() Logger

	DEBUG() Logger

	ERROR() Logger

	FATAL() Logger

	Logger(Level) Logger

	NewRecord(Level) *Record

	// With 构建一个带有指定参数的日志对象
	With(ps map[string]any) Logs

	// Free 回收当前对象
	Free()
}

Logs 日志系统接口

func New

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

New 声明日志实例

p 关联的本地对象，[Logger.Error] 和 [Logger.Print] 等的输出受此影响，可以为空，具体可参考 logs.WithLocale。

type Options

type Options struct {
	Handler  Handler
	Location bool    // 是否带调用堆栈信息
	Created  string  // 指定创建日志的时间格式，如果为空表示不需要输出时间。
	Levels   []Level // 允许的日志通道

	// 对于 [Logger.Error] 输入 [xerrors.Formatter] 类型时，
	// 是否输出调用堆栈信息。
	StackError bool

	// 是否接管标准库日志的输出
	//
	// 如果为 true，则在 go1.21 之前会接管 log.Default() 的输出；
	// go1.21 及之后的版本则接管 log/slog.Default() 的输出；
	Std bool
}

Options 初始化日志的选项

type Record

type Record = logs.Record