Documentation
¶
Index ¶
- func Debugw(msg string, kvs ...any)
- func Errorw(msg string, kvs ...any)
- func Fatalw(msg string, kvs ...any)
- func Infow(msg string, kvs ...any)
- func Init(opts *Options)
- func New(opts *Options) *zapLogger
- func Panicw(msg string, kvs ...any)
- func Sync()
- func Warnw(msg string, kvs ...any)
- type Logger
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Logger ¶
type Logger interface {
// Debugw 用于记录调试级别的日志,通常用于开发阶段,包含详细的调试信息。
Debugw(msg string, kvs ...any)
// Infow 用于记录信息级别的日志,表示系统的正常运行状态。
Infow(msg string, kvs ...any)
// Warnw 用于记录警告级别的日志,表示可能存在问题但不影响系统正常运行。
Warnw(msg string, kvs ...any)
// Errorw 用于记录错误级别的日志,表示系统运行中出现的错误,需要开发人员介入处理。
Errorw(msg string, kvs ...any)
// Panicw 用于记录严重错误级别的日志,表示系统无法继续运行,记录日志后会触发 panic。
Panicw(msg string, kvs ...any)
// Fatalw 用于记录致命错误级别的日志,表示系统无法继续运行,记录日志后会直接退出程序。
Fatalw(msg string, kvs ...any)
// Sync 用于刷新日志缓冲区,确保日志被完整写入目标存储。
Sync()
}
Logger 定义了 miniblog 项目的日志接口。 该接口包含了项目中支持的日志记录方法,提供对不同日志级别的支持。
type Options ¶
type Options struct {
// DisableCaller 指定是否禁用 caller 信息.
// 如果设置为 false(默认值),日志中会显示调用日志所在的文件名和行号,例如:"caller":"main.go:42".
DisableCaller bool
// DisableStacktrace 指定是否禁用堆栈信息.
// 如果设置为 false(默认值),在日志级别为 panic 或更高时,会打印堆栈跟踪信息.
DisableStacktrace bool
// Level 指定日志级别.
// 可选值包括:debug、info、warn、error、dpanic、panic、fatal.
// 默认值为 info.
Level string
// Format 指定日志的输出格式.
// 可选值包括:console(控制台格式)和 json(JSON 格式).
// 默认值为 console.
Format string
// OutputPaths 指定日志的输出位置.
// 默认值为标准输出(stdout),也可以指定文件路径或其他输出目标.
OutputPaths []string
}
Options 定义了日志配置的选项结构体. 通过该结构体,可以自定义日志的输出格式、级别以及其他相关配置.
func NewOptions ¶
func NewOptions() *Options
NewOptions 创建并返回一个带有默认值的 Options 对象. 该方法用于初始化日志配置选项,提供默认的日志级别、格式和输出位置.
Click to show internal directories.
Click to hide internal directories.