logs

package
v0.79.4 Latest Latest
Warning

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

Go to latest
Published: Aug 14, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package logs 日志操作

这是对 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 (
	MilliLayout = logs.MilliLayout
	MicroLayout = logs.MicroLayout
	NanoLayout  = logs.NanoLayout
)

日志的时间格式

Variables

This section is empty.

Functions

func DestroyWithLogs added in v0.79.0

func DestroyWithLogs(l Logs)

DestroyWithLogs 回收 [Logs.With] 创建的对象

这是一个非必须的方法,调用可能会有一定的性能提升。需要确保 l 类型的正确性!

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 HandleFunc added in v0.78.0

type HandleFunc = logs.HandleFunc

type Handler added in v0.78.0

type Handler = logs.Handler

func MergeHandler added in v0.78.0

func MergeHandler(w ...Handler) Handler

func NewDispatchHandler added in v0.78.0

func NewDispatchHandler(d map[Level]Handler) Handler

func NewJSONHandler added in v0.78.0

func NewJSONHandler(timeLayout string, w ...io.Writer) Handler

func NewNopHandler added in v0.78.0

func NewNopHandler() Handler

func NewTermHandler added in v0.78.0

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

NewTermHandler 带颜色的终端输出通道

参数说明参考 logs.NewTermHandler

func NewTextHandler added in v0.78.0

func NewTextHandler(timeLayout string, w ...io.Writer) Handler

type Level

type Level = logs.Level

func AllLevels

func AllLevels() []Level

type Logger

type Logger = logs.Logger

Logger 单个日志的接口

type Logs

type Logs interface {
	INFO() Logger

	WARN() Logger

	TRACE() Logger

	DEBUG() Logger

	ERROR() Logger

	FATAL() Logger

	Logger(lv Level) Logger

	NewRecord(lv Level) *Record

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

Logs 所有日志的集合接口

func New

func New(opt *Options) (Logs, error)

New 声明日志实例

type Options

type Options struct {
	Handler Handler
	Caller  bool    // 是否带调用堆栈信息
	Created bool    // 是否带时间
	Levels  []Level // 允许的日志通道

	// 是否接管标准日的类型
	//
	// 如果为 true,则在 go1.21 之前会接管 log.Default() 的输出;
	// go1.21 以之后的版本则接管 slog.Default() 的输出;
	Std bool
}

Options 初始化日志的选项

type Record added in v0.78.0

type Record = logs.Record

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL