日志类

package
v0.0.0-...-7e18bce Latest Latest
Warning

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

 Go to latest Published: Sep 4, 2024 License: MIT Imports: 35 Imported by: 0

Documentation

Overview

包glog实现了强大且易于使用的等级化日志记录功能。 md5:b8685dc39c4dd154

Index

Constants

View Source 
const (
	F_ASYNC      = 1 << iota // 异步打印日志内容。 md5:aae4973631499f41
	F_FILE_LONG              // 打印完整的文件名和行号：/a/b/c/d.go:23。 md5:b0d552af751b5a59
	F_FILE_SHORT             // 打印最终的文件名元素和行号：d.go:23。会覆盖F_FILE_LONG设置。 md5:b2f804c31e821aba
	F_TIME_DATE              // 在本地时区打印日期：2009-01-23。 md5:d7310c166de59388
	F_TIME_TIME              // 在本地时区打印时间：01:23:23。 md5:547ab7e84bd2a146
	F_TIME_MILLI             // 在本地时区打印带有毫秒的时间：01:23:23.675。 md5:063a060ef145f39d
	F_CALLER_FN              // 打印调用者函数名称和包：main.main. md5:1d729cf0b4dce445
	F_TIME_STD   = F_TIME_DATE | F_TIME_MILLI
)
View Source 
const (
	COLOR_BLACK = 30 + iota
	COLOR_RED
	COLOR_GREEN
	COLOR_YELLOW
	COLOR_BLUE
	COLOR_MAGENTA
	COLOR_CYAN
	COLOR_WHITE
)
View Source 
const (
	COLOR_HI_BLACK = 90 + iota
	COLOR_HI_RED
	COLOR_HI_GREEN
	COLOR_HI_YELLOW
	COLOR_HI_BLUE
	COLOR_HI_MAGENTA
	COLOR_HI_CYAN
	COLOR_HI_WHITE
)

前景高亮度文本颜色. md5:e39d29d745b2e70e

View Source 
const (
	LEVEL_ALL  = LEVEL_DEBU | LEVEL_INFO | LEVEL_NOTI | LEVEL_WARN | LEVEL_ERRO | LEVEL_CRIT
	LEVEL_DEV  = LEVEL_ALL
	LEVEL_PROD = LEVEL_WARN | LEVEL_ERRO | LEVEL_CRIT
	LEVEL_NONE = 0
	LEVEL_DEBU = 1 << iota // 16
	LEVEL_INFO             // 32
	LEVEL_NOTI             // 64
	LEVEL_WARN             // 128
	LEVEL_ERRO             // 256
	LEVEL_CRIT             // 512
	LEVEL_PANI             // 1024
	LEVEL_FATA             // 2048
)

注意，LEVEL_PANI和LEVEL_FATA级别不用于日志输出，而是用于前缀配置。 md5:991a3476bacb665d

View Source 
const (
	// DefaultName是实例使用的默认组名。 md5:ca8d8295a8c531f4
	DefaultName = "default"
)

Variables

This section is empty.

Functions

func Error 

func Error(上下文 context.Context, 值 ...interface{})

Error 打印带有 [ERRO] 标头和换行符的日志内容。 如果启用了堆栈跟踪功能，它还会打印调用者堆栈信息。 md5:f2aa6f6c0e4d2061

func X中间件函数Json 

func X中间件函数Json(上下文 context.Context, in *HandlerInput)

X中间件函数Json 是一个处理器，用于将输出日志内容作为单个 JSON 字符串。 md5:5f3ff01b64c4588b

func X中间件函数文本结构化输出 

func X中间件函数文本结构化输出(上下文 context.Context, in *HandlerInput)

X中间件函数文本结构化输出 是一个处理器，用于将输出的日志内容以结构化字符串的形式处理。 md5:392f74b46dcdd1eb

func X取Writer 

func X取Writer() io.Writer

X取Writer 返回自定义的 writer 对象，它实现了 io.Writer 接口。 如果没有设置自定义 writer，它将返回 nil。 md5:37b3d820b5547c91

func X取上下文名称 

func X取上下文名称() []interface{}

X取上下文名称检索并返回日志记录的上下文键。 md5:1e780871ada8c59c

func X取堆栈信息 

func X取堆栈信息(偏移量 ...int) string

X取堆栈信息 返回调用者栈的内容， 可选参数 `skip` 指定从终点开始要跳过的栈偏移量。 md5:13592be3061e779d

func X取文件路径 

func X取文件路径() string

X取文件路径 返回用于文件日志记录的目录路径。 如果未设置目录路径，它将返回空字符串。 md5:f69da996992ffd9e

func X取标识 

func X取标识() int

X取标识 返回默认日志器defaultLogger的标志。 md5:ca4e9bc9260b114a

func X取级别 

func X取级别() int

X取级别 返回默认的日志级别值。 md5:5ae9c76de12ac5c9

func X取级别前缀 

func X取级别前缀(级别 int) string

X取级别前缀 返回指定级别的前缀字符串。 md5:339b86b4f84d6049

func X设置Writer 

func X设置Writer(writer io.Writer)

X设置Writer 设置自定义的日志记录器`writer`。 `writer`对象应实现io.Writer接口。 开发者可以使用自定义的`writer`将日志输出重定向到其他服务，如：kafka、mysql、mongodb等。 md5:50799f5f4e6280ea

func X设置debug 

func X设置debug(开启 bool)

X设置debug 启用/禁用默认 defaultLogger 的调试级别。默认情况下，调试级别已启用。 md5:335740e0731656b1

func X设置上下文名称 

func X设置上下文名称(名称 ...interface{})

X设置上下文名称 为 defaultLogger 设置上下文键。这些键用于从上下文中检索值，并将它们打印到日志内容中。

注意，多次调用此函数会覆盖之前设置的上下文键。 md5:8a4710a99dd19d4d

func X设置中间件 

func X设置中间件(处理函数 ...Handler)

X设置中间件 设置默认日志记录器defaultLogger的处理程序。 md5:637a5dc8ccc73e8f

func X设置前缀 

func X设置前缀(前缀 string)

X设置前缀 设置日志内容的前缀字符串。 前缀是日志头的一部分，如果关闭了头部输出，就不会显示前缀。 md5:31d8e3c101c1eea6

func X设置堆栈跟踪 

func X设置堆栈跟踪(开启 bool)

X设置堆栈跟踪 启用/禁用失败日志输出中的堆栈功能。 md5:3c80a664fff650de

func X设置异步输出 

func X设置异步输出(开启 bool)

X设置异步输出 用于启用或禁用默认默认日志记录器的异步日志输出功能。 md5:2659994b118a6211

func X设置文件名格式 

func X设置文件名格式(文件名格式 string)

X设置文件名格式 设置文件日志的文件名模式为 `pattern`。 在 `pattern` 中可以使用日期时间模式，例如：access-YYYYMMDD.log。 默认的文件名模式为：Y-m-d.log，例如：2018-01-01.log md5:03b3a973ce783b24

func X设置文件是否输出颜色 

func X设置文件是否输出颜色(开启 bool)

X设置文件是否输出颜色 设置文件日志记录使用颜色. md5:3ff25da59932914b

func X设置文件路径 

func X设置文件路径(文件路径 string) error

X设置文件路径 设置文件日志的目录路径。 md5:817e6d2802241584

func X设置文本级别 

func X设置文本级别(级别 string) error

X设置文本级别 通过级别字符串设置日志级别。 md5:53cbbdf23584340e

func X设置是否同时输出到终端 

func X设置是否同时输出到终端(开启 bool)

X设置是否同时输出到终端 设置是否将日志内容输出到stdout，默认为true。 md5:f68d5bea1f6372d1

func X设置是否输出头信息 

func X设置是否输出头信息(开启 bool)

X设置是否输出头信息 设置日志输出的头部是否打印，默认为 true。 md5:3e71cb67564384cc

func X设置级别 

func X设置级别(级别 int)

X设置级别 设置默认的日志级别。 md5:ab428766cae30d65

func X设置级别前缀 

func X设置级别前缀(级别 int, 前缀 string)

X设置级别前缀 为指定的日志级别设置前缀字符串。 md5:a2b7a43af150bcb7

func X设置级别前缀Map 

func X设置级别前缀Map(前缀Map map[int]string)

X设置级别前缀Map 设置默认logger的级别到前缀字符串的映射。 md5:5d55474512859352

func X设置配置Map 

func X设置配置Map(m map[string]interface{}) error

使用映射为defaultLogger设置配置。 md5:195834b40cfce621

func X设置配置项 

func X设置配置项(配置项 Config) error

X设置配置项 为默认日志器设置配置。 md5:5f388c6c2d28724c

func X设置额外标识 

func X设置额外标识(标识 int)

X设置额外标识 为日志输出功能设置额外的标志。 md5:40253d4ed662de77

func X设置默认中间件 

func X设置默认中间件(处理函数 Handler)

X设置默认中间件 设置包的默认处理器。 md5:33a213aebe83e5ed

func X设置默认日志类 

func X设置默认日志类(l *Logger)

X设置默认日志类 为 glog 包设置默认的日志记录器。 注意，如果在不同的 goroutine 中调用此函数，可能会存在并发安全问题。 md5:acb1633d3882d5ab

func X输出 

func X输出(上下文 context.Context, 值 ...interface{})

X输出 使用 fmt.Sprintln 函数打印 `v` 并添加换行符。 参数 `v` 可以是多个变量。 md5:6c0b3b96234f77ce

func X输出CRIT 

func X输出CRIT(上下文 context.Context, 值 ...interface{})

X输出CRIT 打印带有 [CRIT] 头部和换行符的日志内容。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:f9fb0900ff8f602f

func X输出DEBU 

func X输出DEBU(上下文 context.Context, 值 ...interface{})

X输出DEBU 打印带有 [DEBU] 标头和换行符的日志内容。 md5:7a64f5ebf48d4f92

func X输出FATA 

func X输出FATA(上下文 context.Context, 值 ...interface{})

X输出FATA 以[FATA]标题和换行符打印日志内容，然后退出当前进程。 md5:4061b6551d7137a1

func X输出INFO 

func X输出INFO(上下文 context.Context, 值 ...interface{})

X输出INFO 打印带有 "[INFO]" 标头和换行符的日志内容。 md5:1ed8e917ecca5ef4

func X输出NOTI 

func X输出NOTI(上下文 context.Context, 值 ...interface{})

```go X输出NOTI 打印日志内容，前缀为 [NOTI] 并在末尾添加换行符。 如果启用了堆栈跟踪功能，它还会打印调用者堆栈信息。 ``` md5:c36d548c618d1251

func X输出PANI 

func X输出PANI(上下文 context.Context, 值 ...interface{})

X输出PANI 在输出带有 [PANI] 头部和换行符的日志内容后，引发 panic。 md5:bcde7bf5ff45073a

func X输出WARN 

func X输出WARN(上下文 context.Context, 值 ...interface{})

X输出WARN 打印带有 [WARN] 头部和换行符的日志内容。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:8142c86f6be53ee0

func X输出堆栈信息 

func X输出堆栈信息(上下文 context.Context, 偏移量 ...int)

X输出堆栈信息 打印调用堆栈， 可选参数 `skip` 用于指定从堆栈终点开始忽略的偏移量。 md5:ef6cd40820765783

func X输出并格式化 

func X输出并格式化(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化 使用 fmt.Sprintf 根据格式 `format` 打印 `v`。 参数 `v` 可以是多个变量。 md5:e3b6ab3d8750ad4c

func X输出并格式化CRIT 

func X输出并格式化CRIT(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化CRIT 函数打印带有 [CRIT] 标头、自定义格式和换行的日志内容。 如果启用了堆栈追踪功能，它还会打印调用者堆栈信息。 md5:fa381bbe7b0465d0

func X输出并格式化DEBU 

func X输出并格式化DEBU(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化DEBU 函数打印带有 [DEBU] 标头、自定义格式化内容和换行符的日志信息。 md5:0c0164b88b59a40c

func X输出并格式化ERR 

func X输出并格式化ERR(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化ERR 函数会打印带有 [ERRO] 标头的日志内容，使用自定义格式并添加换行符。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:4a90789d1de07943

func X输出并格式化FATA 

func X输出并格式化FATA(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化FATA 打印带有 [FATA] 头部、自定义格式和换行符的日志内容，然后退出当前进程。 md5:cbaf3fb7e2b92df9

func X输出并格式化INFO 

func X输出并格式化INFO(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化INFO 打印带有 [INFO] 标头、自定义格式和换行符的日志内容。 md5:fda1e57b2e2089d7

func X输出并格式化NOTI 

func X输出并格式化NOTI(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化NOTI 打印带有 [NOTI] 标头的日志内容，自定义格式和换行符。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:f9d4f5af91856cd9

func X输出并格式化PANI 

func X输出并格式化PANI(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化PANI 函数打印带有 [PANI] 标头、自定义格式和换行的日志内容，然后触发恐慌（panic）。 md5:bf1df3ad28ded71f

func X输出并格式化WARN 

func X输出并格式化WARN(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化WARN 函数打印带有 [WARN] 标头的记录内容、自定义格式化字符串以及换行。 如果启用了堆栈追踪功能，它还会打印调用者堆栈信息。 md5:025f0baa4a1f8600

Types

type Config 

type Config struct {
	Handlers             []Handler      `json:"-"`                    // Logger handlers 实现了类似于中间件的功能。 md5:dba4d3d0c7f592b9
	Writer               io.Writer      `json:"-"`                    // Customized io.Writer.
	Flags                int            `json:"flags"`                // 用于日志输出功能的额外标志。 md5:6b323bf0cac304e0
	TimeFormat           string         `json:"timeFormat"`           // Logging time format
	Path                 string         `json:"path"`                 // 日志目录路径。 md5:a9b74f93138f8158
	File                 string         `json:"file"`                 // 日志文件的格式化模式。 md5:88ed9324a5afc4c8
	Level                int            `json:"level"`                // Output level.
	Prefix               string         `json:"prefix"`               // 每个日志内容的前缀字符串。 md5:9318d5ac0b1e3e0e
	StSkip               int            `json:"stSkip"`               // 跳过栈的计数。 md5:dd0842336cee717c
	StStatus             int            `json:"stStatus"`             // 栈的状态（1：启用 - 默认；0：禁用）. md5:3a07964ef563d1f6
	StFilter             string         `json:"stFilter"`             // Stack string filter.
	CtxKeys              []interface{}  `json:"ctxKeys"`              // 用于日志记录的上下文键，用于从上下文中检索值。 md5:d4a4f8b7c1027e23
	HeaderPrint          bool           `json:"header"`               // 是否打印头部信息，默认为true。 md5:8b587e739278ffe3
	StdoutPrint          bool           `json:"stdout"`               // 是否将输出写入stdout（默认为true）。 md5:4f790cec19c3aa5a
	LevelPrint           bool           `json:"levelPrint"`           // 是否打印级别格式字符串（默认为 true）。 md5:2261e6b6d1cccb2d
	LevelPrefixes        map[int]string `json:"levelPrefixes"`        // 日志级别与其前缀字符串的映射。 md5:c4a5a8857bc37946
	RotateSize           int64          `json:"rotateSize"`           // 如果日志文件的大小大于0字节，则进行日志文件轮换。 md5:9fb4614dcea49823
	RotateExpire         time.Duration  `json:"rotateExpire"`         // 如果日志文件的修改时间超过这个持续时间，就旋转日志文件。 md5:0832ad6a5113efe9
	RotateBackupLimit    int            `json:"rotateBackupLimit"`    // 旋转文件的最大备份数量，默认为0，表示不备份。 md5:67b4908c6a850b93
	RotateBackupExpire   time.Duration  `json:"rotateBackupExpire"`   // Max 为旋转文件的过期时间，默认为0，表示永不过期。 md5:eedec2e3ee56fc5d
	RotateBackupCompress int            `json:"rotateBackupCompress"` // Compress level for rotated files using gzip algorithm. It's 0 in default, means no compression.
	RotateCheckInterval  time.Duration  `json:"rotateCheckInterval"`  // Asynchronously checks the backups and expiration at intervals. It's 1 hour in default.
	StdoutColorDisabled  bool           `json:"stdoutColorDisabled"`  // 是否向写入器输出带有颜色的日志级别前缀（默认为false）。 md5:cd5684396601fdfc
	WriterColorEnable    bool           `json:"writerColorEnable"`    // 是否向写入器输出带有颜色的日志级别前缀（默认为false）。 md5:cd5684396601fdfc
	// contains filtered or unexported fields
}

Config 是记录器的配置对象。 md5:df2a8ab047bea305

func X生成默认配置 

func X生成默认配置() Config

X生成默认配置 返回日志记录器的默认配置。 md5:307781636b8ca142

type Handler 

type Handler func(ctx context.Context, in *HandlerInput)

Handler 是用于自定义日志内容输出的函数处理器。 md5:486a8db7f7dd8188

func X取默认中间件 

func X取默认中间件() Handler

X取默认中间件 返回包的默认处理器。 md5:8812c42db1189f3b

type HandlerInput 

type HandlerInput struct {

	// Current Logger object.
	Logger *Logger

	// 用于存储日志输出内容的缓冲区。 md5:33224816c1505400
	Buffer *bytes.Buffer

	// （只读）记录时间，即触发日志记录的时间。 md5:5ce6aaa482dcea28
	Time time.Time

	// 格式化的输出时间字符串，如 "2016-01-09 12:00:00"。 md5:530cb544b3906631
	TimeFormat string

	//（只读）使用颜色常量值，如COLOR_RED，COLOR_BLUE等。
	// 示例：34
	// md5:e377684c0eb82b75
	Color int

	// （只读）使用级别，如LEVEL_INFO、LEVEL_ERROR等。
	// 例子：256
	// md5:20e8f648c34222c9
	Level int

	// 用于输出的格式化日志级别字符串，如 "DEBU"、"ERRO" 等。
	// 示例：ERRO
	// md5:0bad424894695e93
	LevelFormat string

	// 调用日志的源函数名称，仅在设置F_CALLER_FN时可用。 md5:2bfd8148853e8e4c
	CallerFunc string

	// 调用日志的源文件路径及其行号，只有在设置F_FILE_SHORT或F_FILE_LONG时可用。
	// md5:8e31a0cc592be662
	CallerPath string

	// 从上下文中获取的已配置的 context 值字符串。如果没有配置 Config.CtxKeys，它将为空。
	// md5:b854bd1bcad06fda
	CtxStr string

	// 跟踪ID，仅在启用OpenTelemetry时可用，否则为空字符串。 md5:0cd8e77f80286121
	TraceId string

	// 在日志内容头部自定义的前缀字符串。
	// 请注意，如果已禁用HeaderPrint，此设置将不会生效。
	// md5:004eed7afe3ca2dd
	Prefix string

	// 用于日志记录的自定义日志内容。 md5:9749c3bafd8e33d5
	Content string

	// 传递给日志记录器的未经格式化的值数组。 md5:854ab8e84e01371d
	Values []any

	// 由记录器生成的堆栈字符串，仅在配置了Config.StStatus时可用。
	// 注意，堆栈内容中通常包含多行。
	// md5:c36e69fdfae3ac16
	Stack string

	// IsAsync 标记为异步日志记录。 md5:e138a9a968506347
	IsAsync bool
	// contains filtered or unexported fields
}

HandlerInput是日志处理器的输入参数结构体。

日志内容由以下部分组成： 时间格式 [级别格式] {跟踪ID} {上下文字符串} 前缀 调用函数 调用路径 内容 值 堆栈

日志内容的头部是： 时间格式 [级别格式] {跟踪ID} {上下文字符串} 前缀 调用函数 调用路径 md5:6213dd0ebb4e9188

func (*HandlerInput) Next 

func (in *HandlerInput) Next(ctx context.Context)

Next 以中间件的方式调用下一个日志处理程序。 md5:ab91f9dfe65c4322

func (*HandlerInput) String 

func (in *HandlerInput) String(withColor ...bool) string

String 返回默认日志处理器格式化的日志内容。 md5:e78613962fe54276

func (*HandlerInput) ValuesContent 

func (in *HandlerInput) ValuesContent() string

ValuesContent 将值转换为字符串内容并返回。 md5:da3a0fd9093d35c9

type HandlerOutputJson 

type HandlerOutputJson struct {
	Time       string `json:""`           // 格式化的日期时间字符串，例如 "2016-01-09 12:00:00"。 md5:4e5e7f760859f24e
	TraceId    string `json:",omitempty"` // 跟踪ID，仅在启用跟踪时可用。 md5:3b404f27a111b55f
	CtxStr     string `json:",omitempty"` // 从上下文中检索到的值字符串，仅在配置了Config.CtxKeys时可用。 md5:b666fc055085d9a9
	Level      string `json:""`           // 格式化的级别字符串，如"DEBU"、"ERRO"等。例如：ERRO. md5:b12f3fdf5d67e119
	CallerPath string `json:",omitempty"` // 调用日志的源文件路径及其行号，只有在设置F_FILE_SHORT或F_FILE_LONG时才可用。 md5:b3812538f3d66adf
	CallerFunc string `json:",omitempty"` // 调用日志的源函数名称，仅在设置F_CALLER_FN时可用。 md5:2bfd8148853e8e4c
	Prefix     string `json:",omitempty"` // 自定义日志内容的前缀字符串。 md5:c5186327c46919a1
	Content    string `json:""`           // Content 是日志的主要内容，包含由记录器生成的错误堆栈字符串。 md5:1939e6f99648f6e4
	Stack      string `json:",omitempty"` // 由logger生成的堆栈跟踪字符串，只有在配置了Config.StStatus时才可用。 md5:5951e7cd2f97d44d
}

HandlerOutputJson 是将日志内容作为单一JSON输出的结构体。 备注: 此配置结构不做名称翻译, 输出的日志会直接用结构字段名称作为日志内容的键名,导致TestLogger_SetHandlers_HandlerJson单元测试不通过. (2024-07-21) HandlerOutputJson 是将日志内容作为单一JSON输出的结构体。 备注: 此配置结构不做名称翻译, 输出的日志会直接用结构字段名称作为日志内容的键名,导致TestLogger_SetHandlers_HandlerJson单元测试不通过. (2024-07-21) HandlerOutputJson 是将日志内容作为单一JSON输出的结构体。 备注: 此配置结构不做名称翻译, 输出的日志会直接用结构字段名称作为日志内容的键名,导致TestLogger_SetHandlers_HandlerJson单元测试不通过. (2024-07-21) HandlerOutputJson 是将日志内容作为单一JSON输出的结构体。 备注: 此配置结构不做名称翻译, 输出的日志会直接用结构字段名称作为日志内容的键名,导致TestLogger_SetHandlers_HandlerJson单元测试不通过. (2024-07-21) md5:d9846a62089232e7

type ILogger 

type ILogger interface {
	X输出(ctx context.Context, v ...interface{})
	X输出并格式化(ctx context.Context, format string, v ...interface{})
	X输出DEBU(ctx context.Context, v ...interface{})
	X输出并格式化DEBU(ctx context.Context, format string, v ...interface{})
	X输出INFO(ctx context.Context, v ...interface{})
	X输出并格式化INFO(ctx context.Context, format string, v ...interface{})
	X输出NOTI(ctx context.Context, v ...interface{})
	X输出并格式化NOTI(ctx context.Context, format string, v ...interface{})
	X输出WARN(ctx context.Context, v ...interface{})
	X输出并格式化WARN(ctx context.Context, format string, v ...interface{})
	Error(ctx context.Context, v ...interface{})
	X输出并格式化ERR(ctx context.Context, format string, v ...interface{})
	X输出CRIT(ctx context.Context, v ...interface{})
	X输出并格式化CRIT(ctx context.Context, format string, v ...interface{})
	X输出PANI(ctx context.Context, v ...interface{})
	X输出并格式化PANI(ctx context.Context, format string, v ...interface{})
	X输出FATA(ctx context.Context, v ...interface{})
	X输出并格式化FATA(ctx context.Context, format string, v ...interface{})
}

ILogger是日志记录器的API接口。 md5:762449020563f6b9

type Logger 

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

Logger 是用于日志管理的结构体。 md5:c338807dca943ae3

func Expose别名 

func Expose别名() *Logger

Expose别名 返回 glog 包的默认日志记录器。 md5:20ba79507675e0e8

func X创建 

func X创建() *Logger

X创建 创建并返回一个自定义的日志器。 md5:0205650422cdd95e

func X创建并按writer 

func X创建并按writer(writer io.Writer) *Logger

X创建并按writer 创建并返回一个具有 io.Writer 的自定义日志器。 md5:51edfcbd62ded572

func X取单例对象 

func X取单例对象(名称 ...string) *Logger

X取单例对象 返回一个具有默认设置的 Logger 实例。 参数 `name` 是该实例的名称。 md5:ff5711e68bbfdd35

func X取默认日志类 

func X取默认日志类() *Logger

X取默认日志类 返回默认的logger。 md5:375e904736d75955

func X堆栈偏移量 

func X堆栈偏移量(偏移量 int) *Logger

X堆栈偏移量 是一个链式函数， 用于设置当前日志内容输出的堆栈跳过级别。 当启用行号打印时，它也会影响调用者文件路径的检查。 md5:f009e835989b7d56

func X堆栈过滤 

func X堆栈过滤(过滤器 string) *Logger

X堆栈过滤是一个链式函数，它为当前日志内容输出设置堆栈过滤器。 md5:07c5327660880bce

func X堆栈选项 

func X堆栈选项(开启 bool, 偏移量 ...int) *Logger

X堆栈选项是一个链式函数， 用于设置当前日志内容输出的堆栈选项。 md5:aa980bb8d1f29075

func X文件分类 

func X文件分类(类名称 string) *Logger

X文件分类 是一个链式函数， 用于将当前日志内容输出的类别设置为 `category`。 md5:9233c1ec32751e89

func X文件名格式 

func X文件名格式(文件名格式 string) *Logger

X文件名格式是一个链式函数， 用于设置当前日志内容输出的文件名`pattern`。 md5:2daa0ddd7ccf2b81

func X文件路径 

func X文件路径(文件路径 string) *Logger

X文件路径是一个链式函数，它为当前日志内容输出设置目录路径为`path`。 md5:9f023b954ca40c7e

func X文本级别 

func X文本级别(文本级别 string) *Logger

X文本级别 是一个链式函数， 它使用级别字符串设置当前日志输出内容的记录级别。 md5:1edd3ebd98ec4de9

func X是否同时输出到终端 

func X是否同时输出到终端(开启 ...bool) *Logger

X是否同时输出到终端 是一个链式函数， 它允许/禁用当前日志内容输出到标准输出。默认启用。 md5:47b9f2393a7d5d1f

func X是否异步输出 

func X是否异步输出(开启 ...bool) *Logger

X是否异步输出 是一个链式函数， 用于启用或禁用异步日志输出功能。 md5:8b08233b7c37c09f

func X是否输出头信息 

func X是否输出头信息(开启 ...bool) *Logger

X是否输出头信息 是一个链接函数， 用于启用或禁用当前日志内容输出的头部信息。 默认情况下，它是启用的。 md5:0d1df22042835f38

func X是否输出源文件路径与行号 

func X是否输出源文件路径与行号(开启 ...bool) *Logger

X是否输出源文件路径与行号 is a chaining function, which enables/disables printing its caller file along with its line number. The parameter `long` specified whether print the long absolute file path, eg: /a/b/c/d.go:23.

func X级别 

func X级别(级别 int) *Logger

X级别是一个链式函数，它为当前日志输出内容设置日志级别。 md5:47d5e7fde254fd72

func X重定向输出 

func X重定向输出(writer io.Writer) *Logger

X重定向输出是一个链式函数， 它将当前日志内容输出重定向到指定的`writer`。 md5:198a22b4aa1923ef

func (*Logger) AppendCtxKeys 

func (l *Logger) AppendCtxKeys(keys ...interface{})

AppendCtxKeys 向记录器添加额外的键。 如果该键已先前被添加到记录器中，则此操作会忽略该键。 md5:f989e696d285ffc1

func (*Logger) Error 

func (l *Logger) Error(上下文 context.Context, 值 ...interface{})

Error 打印带有 [ERRO] 标头和换行符的日志内容。 如果启用了堆栈跟踪功能，它还会打印调用者堆栈信息。 md5:f2aa6f6c0e4d2061

func (*Logger) PrintStack 

func (l *Logger) PrintStack(ctx context.Context, skip ...int)

PrintStack 打印调用堆栈， 可选参数 `skip` 用于指定从堆栈终点开始忽略的偏移量。 md5:ef6cd40820765783

func (*Logger) Write 

func (l *Logger) Write(p []byte) (n int, err error)

Write 实现了 io.Writer 接口。 它只是使用 Print 函数打印内容。 md5:da123f9fe994f171

func (*Logger) X取Writer 

func (l *Logger) X取Writer() io.Writer

X取Writer 返回自定义的 writer 对象，该对象实现了 io.Writer 接口。 如果之前未设置 writer，则返回 nil。 md5:cce0a2679c717d75

func (*Logger) X取上下文名称 

func (l *Logger) X取上下文名称() []interface{}

X取上下文名称检索并返回日志记录的上下文键。 md5:1e780871ada8c59c

func (*Logger) X取副本 

func (l *Logger) X取副本() *Logger

X取副本 返回一个新的记录器，它是当前记录器的`浅拷贝`。 注意，克隆体的`config`属性是对当前记录器配置的浅拷贝。 md5:c70ded0c6903f4be

func (*Logger) X取堆栈信息 

func (l *Logger) X取堆栈信息(偏移量 ...int) string

X取堆栈信息 返回调用者栈的内容， 可选参数 `skip` 指定从终点开始要跳过的栈偏移量。 md5:13592be3061e779d

func (*Logger) X取文件路径 

func (l *Logger) X取文件路径() string

X取文件路径 返回用于文件日志记录的目录路径。 如果未设置目录路径，它将返回空字符串。 md5:f69da996992ffd9e

func (*Logger) X取标识 

func (l *Logger) X取标识() int

X取标识 返回记录器的标志。 md5:b9a17daa74081d07

func (*Logger) X取级别 

func (l *Logger) X取级别() int

X取级别 返回日志级别值。 md5:8b5b1f26924bf360

func (*Logger) X取级别前缀 

func (l *Logger) X取级别前缀(级别 int) string

X取级别前缀 返回指定级别的前缀字符串。 md5:339b86b4f84d6049

func (*Logger) X取配置项 

func (l *Logger) X取配置项() Config

X取配置项 返回当前Logger的配置。 md5:34aac9175b86a456

func (*Logger) X堆栈偏移量 

func (l *Logger) X堆栈偏移量(偏移量 int) *Logger

X堆栈偏移量 是一个链式函数， 用于设置当前日志内容输出的堆栈跳过级别。 当启用行号打印时，它也会影响调用者文件路径的检查。 md5:f009e835989b7d56

func (*Logger) X堆栈过滤 

func (l *Logger) X堆栈过滤(过滤器 string) *Logger

X堆栈过滤是一个链式函数，它为当前日志内容输出设置堆栈过滤器。 md5:07c5327660880bce

func (*Logger) X堆栈选项 

func (l *Logger) X堆栈选项(开启 bool, 偏移量 ...int) *Logger

X堆栈选项是一个链式函数， 用于设置当前日志内容输出的堆栈选项。 md5:aa980bb8d1f29075

func (*Logger) X文件分类 

func (l *Logger) X文件分类(类名称 string) *Logger

X文件分类是一个链式函数， 它将当前日志输出的内容类别设置为`category`。 参数`category`可以是分层的，例如：module/user。 md5:a2af01bf0ef7b61a

func (*Logger) X文件名格式 

func (l *Logger) X文件名格式(文件名格式 string) *Logger

X文件名格式是一个链式函数， 用于设置当前日志内容输出的文件名`pattern`。 md5:2daa0ddd7ccf2b81

func (*Logger) X文件路径 

func (l *Logger) X文件路径(文件路径 string) *Logger

X文件路径 是一个链接函数， 用于设置当前日志内容输出的目录路径为 `path`。

注意，参数 `path` 是一个目录路径，而不是文件路径。 md5:32049f7ff7fb26c7

func (*Logger) X文本级别 

func (l *Logger) X文本级别(文本级别 string) *Logger

X文本级别 是一个链式函数， 它使用级别字符串设置当前日志输出内容的记录级别。 md5:1edd3ebd98ec4de9

func (*Logger) X是否同时输出到终端 

func (l *Logger) X是否同时输出到终端(开启 ...bool) *Logger

X是否同时输出到终端 是一个链式函数， 它允许/禁用当前日志内容输出到标准输出。默认启用。 md5:47b9f2393a7d5d1f

func (*Logger) X是否异步输出 

func (l *Logger) X是否异步输出(开启 ...bool) *Logger

X是否异步输出 是一个链式函数， 用于启用或禁用异步日志输出功能。 md5:8b08233b7c37c09f

func (*Logger) X是否输出头信息 

func (l *Logger) X是否输出头信息(开启 ...bool) *Logger

X是否输出头信息 是一个链接函数， 用于启用或禁用当前日志内容输出的头部信息。 默认情况下，它是启用的。 md5:0d1df22042835f38

func (*Logger) X是否输出源文件路径与行号 

func (l *Logger) X是否输出源文件路径与行号(开启 ...bool) *Logger

X是否输出源文件路径与行号 is a chaining function, which enables/disables printing its caller file path along with its line number. The parameter `long` specified whether print the long absolute file path, eg: /a/b/c/d.go:23, or else short one: d.go:23.

func (*Logger) X级别 

func (l *Logger) X级别(级别 int) *Logger

X级别是一个链式函数，它为当前日志输出内容设置日志级别。 md5:47d5e7fde254fd72

func (*Logger) X设置Writer 

func (l *Logger) X设置Writer(writer io.Writer)

X设置Writer 设置自定义的日志记录器`writer`。 `writer`对象应实现io.Writer接口。 开发者可以使用自定义的`writer`将日志输出重定向到其他服务， 例如：kafka，mysql，mongodb等。 md5:8f650a69c1fe2b4b

func (*Logger) X设置debug 

func (l *Logger) X设置debug(开启 bool)

X设置debug 用于启用/禁用日志记录器的调试级别。默认情况下，调试级别是启用的。 md5:72f0f67e25416b8e

func (*Logger) X设置上下文名称 

func (l *Logger) X设置上下文名称(名称 ...interface{})

X设置上下文名称 为日志器设置上下文键。这些键用于从上下文中检索值并将其打印到日志内容中。

注意，多次调用此函数会覆盖之前设置的上下文键。 md5:f7244f6c7fa79db2

func (*Logger) X设置中间件 

func (l *Logger) X设置中间件(处理函数 ...Handler)

X设置中间件 设置当前日志记录器的处理程序。 md5:7b876afcd04a669e

func (*Logger) X设置关闭终端颜色输出 

func (l *Logger) X设置关闭终端颜色输出(关闭 bool)

X设置关闭终端颜色输出 禁用带有颜色的stdout日志记录。 md5:aed9b0e4a2ba0f72

func (*Logger) X设置前缀 

func (l *Logger) X设置前缀(前缀 string)

X设置前缀 设置日志内容的前缀字符串。 前缀是日志头的一部分，如果关闭了头部输出，就不会显示前缀。 md5:31d8e3c101c1eea6

func (*Logger) X设置堆栈偏移量 

func (l *Logger) X设置堆栈偏移量(偏移量 int)

X设置堆栈偏移量 设置从终点开始的堆栈偏移量。 md5:98a83cd0e38dc56c

func (*Logger) X设置堆栈跟踪 

func (l *Logger) X设置堆栈跟踪(开启 bool)

X设置堆栈跟踪 启用/禁用失败日志输出中的堆栈功能。 md5:3c80a664fff650de

func (*Logger) X设置堆栈过滤 

func (l *Logger) X设置堆栈过滤(过滤器 string)

X设置堆栈过滤 从端点设置堆栈过滤器。 md5:7eabd577c24907f2

func (*Logger) X设置异步输出 

func (l *Logger) X设置异步输出(开启 bool)

X设置异步输出 启用/禁用异步日志输出功能。 md5:10096a3a0860346e

func (*Logger) X设置文件名格式 

func (l *Logger) X设置文件名格式(文件名格式 string)

X设置文件名格式 设置文件日志的文件名模式为 `pattern`。 在 `pattern` 中可以使用日期时间模式，例如：access-YYYYMMDD.log。 默认的文件名模式为：Y-m-d.log，例如：2018-01-01.log md5:03b3a973ce783b24

func (*Logger) X设置文件是否输出颜色 

func (l *Logger) X设置文件是否输出颜色(开启 bool)

X设置文件是否输出颜色 启用带有颜色的文件/写入器日志记录。 md5:deef19b9707bd4df

func (*Logger) X设置文件路径 

func (l *Logger) X设置文件路径(文件路径 string) error

X设置文件路径 设置文件日志的目录路径。 md5:817e6d2802241584

func (*Logger) X设置文本级别 

func (l *Logger) X设置文本级别(级别 string) error

X设置文本级别 通过级别字符串设置日志级别。 md5:53cbbdf23584340e

func (*Logger) X设置时间格式 

func (l *Logger) X设置时间格式(时间格式 string)

X设置时间格式 设置日志时间的时间格式。 md5:258a98926fba4588

func (*Logger) X设置是否同时输出到终端 

func (l *Logger) X设置是否同时输出到终端(开启 bool)

X设置是否同时输出到终端 设置是否将日志内容输出到标准输出，默认为true。 md5:b212437cebfd423a

func (*Logger) X设置是否输出头信息 

func (l *Logger) X设置是否输出头信息(开启 bool)

X设置是否输出头信息 设置日志输出的头部是否打印，默认为 true。 md5:3e71cb67564384cc

func (*Logger) X设置是否输出级别 

func (l *Logger) X设置是否输出级别(开启 bool)

X设置是否输出级别 设置是否输出日志内容的级别字符串，默认为true。 md5:6ba8899e4d3d1c1b

func (*Logger) X设置级别 

func (l *Logger) X设置级别(级别 int)

X设置级别 设置日志级别。 注意，`LEVEL_CRIT`、`LEVEL_PANI` 和 `LEVEL_FATA` 级别无法删除，因为它们会自动添加到日志内容中。 md5:e488e79c6c4c2e71

func (*Logger) X设置级别前缀 

func (l *Logger) X设置级别前缀(级别 int, 前缀 string)

X设置级别前缀 为指定的日志级别设置前缀字符串。 md5:a2b7a43af150bcb7

func (*Logger) X设置级别前缀Map 

func (l *Logger) X设置级别前缀Map(前缀Map map[int]string)

X设置级别前缀Map 为记录器设置级别与前缀字符串的映射关系。 md5:a80f5e3de3c222ff

func (*Logger) X设置配置Map 

func (l *Logger) X设置配置Map(m map[string]interface{}) error

X设置配置Map 使用映射为日志器设置配置。 md5:a4d4197c666898a3

func (*Logger) X设置配置项 

func (l *Logger) X设置配置项(配置项 Config) error

X设置配置项 为logger设置配置。 md5:d219673b9a3ec8b0

func (*Logger) X设置额外标识 

func (l *Logger) X设置额外标识(标识 int)

X设置额外标识 为日志输出功能设置额外的标志。 md5:40253d4ed662de77

func (*Logger) X输出 

func (l *Logger) X输出(上下文 context.Context, 值 ...interface{})

X输出 使用 fmt.Sprintln 函数打印 `v` 并添加换行符。 参数 `v` 可以是多个变量。 md5:6c0b3b96234f77ce

func (*Logger) X输出CRIT 

func (l *Logger) X输出CRIT(上下文 context.Context, 值 ...interface{})

X输出CRIT 打印带有 [CRIT] 头部和换行符的日志内容。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:f9fb0900ff8f602f

func (*Logger) X输出DEBU 

func (l *Logger) X输出DEBU(上下文 context.Context, 值 ...interface{})

X输出DEBU 打印带有 [DEBU] 标头和换行符的日志内容。 md5:7a64f5ebf48d4f92

func (*Logger) X输出FATA 

func (l *Logger) X输出FATA(上下文 context.Context, 值 ...interface{})

X输出FATA 以[FATA]标题和换行符打印日志内容，然后退出当前进程。 md5:4061b6551d7137a1

func (*Logger) X输出INFO 

func (l *Logger) X输出INFO(上下文 context.Context, 值 ...interface{})

X输出INFO 打印带有 "[INFO]" 标头和换行符的日志内容。 md5:1ed8e917ecca5ef4

func (*Logger) X输出NOTI 

func (l *Logger) X输出NOTI(上下文 context.Context, 值 ...interface{})

```go X输出NOTI 打印日志内容，前缀为 [NOTI] 并在末尾添加换行符。 如果启用了堆栈跟踪功能，它还会打印调用者堆栈信息。 ``` md5:c36d548c618d1251

func (*Logger) X输出PANI 

func (l *Logger) X输出PANI(上下文 context.Context, 值 ...interface{})

X输出PANI 在输出带有 [PANI] 头部和换行符的日志内容后，引发 panic。 md5:bcde7bf5ff45073a

func (*Logger) X输出WARN 

func (l *Logger) X输出WARN(上下文 context.Context, 值 ...interface{})

X输出WARN 打印带有 [WARN] 头部和换行符的日志内容。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:8142c86f6be53ee0

func (*Logger) X输出并格式化 

func (l *Logger) X输出并格式化(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化 使用 fmt.Sprintf 根据格式 `format` 打印 `v`。 参数 `v` 可以是多个变量。 md5:e3b6ab3d8750ad4c

func (*Logger) X输出并格式化CRIT 

func (l *Logger) X输出并格式化CRIT(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化CRIT 函数打印带有 [CRIT] 标头、自定义格式和换行的日志内容。 如果启用了堆栈追踪功能，它还会打印调用者堆栈信息。 md5:fa381bbe7b0465d0

func (*Logger) X输出并格式化DEBU 

func (l *Logger) X输出并格式化DEBU(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化DEBU 函数打印带有 [DEBU] 标头、自定义格式化内容和换行符的日志信息。 md5:0c0164b88b59a40c

func (*Logger) X输出并格式化ERR 

func (l *Logger) X输出并格式化ERR(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化ERR 函数会打印带有 [ERRO] 标头的日志内容，使用自定义格式并添加换行符。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:4a90789d1de07943

func (*Logger) X输出并格式化FATA 

func (l *Logger) X输出并格式化FATA(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化FATA 打印带有 [FATA] 头部、自定义格式和换行符的日志内容，然后退出当前进程。 md5:cbaf3fb7e2b92df9

func (*Logger) X输出并格式化INFO 

func (l *Logger) X输出并格式化INFO(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化INFO 打印带有 [INFO] 标头、自定义格式和换行符的日志内容。 md5:fda1e57b2e2089d7

func (*Logger) X输出并格式化NOTI 

func (l *Logger) X输出并格式化NOTI(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化NOTI 打印带有 [NOTI] 标头的日志内容，自定义格式和换行符。如果启用了堆栈功能，它还会打印调用者堆栈信息。 md5:f9d4f5af91856cd9

func (*Logger) X输出并格式化PANI 

func (l *Logger) X输出并格式化PANI(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化PANI 函数打印带有 [PANI] 标头、自定义格式和换行的日志内容，然后触发恐慌（panic）。 md5:bf1df3ad28ded71f

func (*Logger) X输出并格式化WARN 

func (l *Logger) X输出并格式化WARN(上下文 context.Context, 格式 string, 值 ...interface{})

X输出并格式化WARN 函数打印带有 [WARN] 标头的记录内容、自定义格式化字符串以及换行。 如果启用了堆栈追踪功能，它还会打印调用者堆栈信息。 md5:025f0baa4a1f8600

func (*Logger) X重定向输出 

func (l *Logger) X重定向输出(writer io.Writer) *Logger

X重定向输出是一个链式函数， 它将当前日志内容输出重定向到指定的`writer`。 md5:ebcc479882059a2e

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.