logs

package
v0.86.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package logs 日志操作

Index

Constants

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

日志的类别

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

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

日志的时间格式

Variables

This section is empty.

Functions

func NewRotateFile

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

NewRotateFile 按大小分割的文件日志

参数说明参考 rotate.New

func NewSMTP added in v0.67.1

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

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

参数说明参考 writers.NewSMTP

Types

type Attr added in v0.86.0

type Attr = logs.Attr

type Buffer added in v0.85.0

type Buffer = logs.Buffer

func NewBuffer added in v0.85.0

func NewBuffer(detail bool) *Buffer

type Handler added in v0.78.0

type Handler = logs.Handler

func MergeHandler added in v0.78.0

func MergeHandler(w ...Handler) Handler

MergeHandler 合并多个 Handler 对象

func NewDispatchHandler added in v0.78.0

func NewDispatchHandler(d map[Level]Handler) Handler

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

func NewJSONHandler added in v0.78.0

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

func NewNopHandler added in v0.78.0

func NewNopHandler() Handler

func NewTermHandler added in v0.78.0

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

NewTermHandler 带颜色的终端输出通道

参数说明参考 logs.NewTermHandler

func NewTextHandler added in v0.78.0

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

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() *Record

	// New 构建一个带有指定属性的 [Logs]
	New(map[string]any) Logs

	// AppendAttrs 添加共同属性
	AppendAttrs(map[string]any)

	// Free 回收当前对象
	//
	// 大部分时候不需要主动调用此方法。但是一旦调用,
	// 表示该对象已经不可用。
	Free()
}

Logs 日志系统接口

func New

func New(p *localeutil.Printer, o *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() 的输出;
	// 具体参考 [logs.WithStd]。
	Std bool
}

Options 初始化日志的选项

type Record added in v0.78.0

type Record = logs.Record

type Recorder added in v0.86.0

type Recorder = logs.Recorder

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳