vlog

package module
v0.9.12 Latest Latest
Warning

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

 Go to latest Published: Aug 20, 2025 License: MIT Imports: 3 Imported by: 69

README

vlog (github.com/starter-go/vlog)

vlog (virtual-logger) 是一个抽象的日志接口库，相当于 slf4j

源代码: https://github.com/starter-go/vlog

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Debug 

func Debug(fmt string, args ...any)

Debug 输出一条等级为 DEBUG 的日志记录

func Error 

func Error(fmt string, args ...any)

Error 输出一条等级为 ERROR 的日志记录

func Fatal 

func Fatal(fmt string, args ...any)

Fatal 输出一条等级为 FATAL 的日志记录

func ForLog added in v0.9.9 

func ForLog(l Level, fn func(l Logger))

ForLog 以回调的方式输出一条等级为 l 的日志记录

func HandleError added in v0.9.8 

func HandleError(err error)

HandleError 把错误信息(error)通过日志输出

func HandleErrorX added in v0.9.8 

func HandleErrorX(x any)

HandleErrorX 把错误信息(any)通过日志输出

func Info 

func Info(fmt string, args ...any)

Info 输出一条等级为 INFO 的日志记录

func IsDebugEnabled 

func IsDebugEnabled() bool

IsDebugEnabled 判断是否需要输出等级为 DEBUG 的日志记录

func IsErrorEnabled 

func IsErrorEnabled() bool

IsErrorEnabled 判断是否需要输出等级为 ERROR 的日志记录

func IsFatalEnabled 

func IsFatalEnabled() bool

IsFatalEnabled 判断是否需要输出等级为 FATAL 的日志记录

func IsInfoEnabled 

func IsInfoEnabled() bool

IsInfoEnabled 判断是否需要输出等级为 INFO 的日志记录

func IsTraceEnabled 

func IsTraceEnabled() bool

IsTraceEnabled 判断是否需要输出等级为 TRACE 的日志记录

func IsWarnEnabled 

func IsWarnEnabled() bool

IsWarnEnabled 判断是否需要输出等级为 WARN 的日志记录

func SetLoggerFactory 

func SetLoggerFactory(factory LoggerFactory)

SetLoggerFactory 设置(当前)日志工厂

func Trace 

func Trace(fmt string, args ...any)

Trace 输出一条等级为 TRACE 的日志记录

func Warn 

func Warn(fmt string, args ...any)

Warn 输出一条等级为 WARN 的日志记录

Types

type ConsoleDisplayFilter 

type ConsoleDisplayFilter struct {
}

ConsoleDisplayFilter 过滤器

func (*ConsoleDisplayFilter) DoFilter 

func (inst *ConsoleDisplayFilter) DoFilter(msg *Message, chain MessageFilterChain)

DoFilter 执行过滤操作

type DateTimeFilter 

type DateTimeFilter struct {
}

DateTimeFilter 过滤器

func (*DateTimeFilter) DoFilter 

func (inst *DateTimeFilter) DoFilter(msg *Message, chain MessageFilterChain)

DoFilter 执行过滤操作

type ErrorFilter 

type ErrorFilter struct {
}

ErrorFilter 过滤器

func (*ErrorFilter) DoFilter 

func (inst *ErrorFilter) DoFilter(msg *Message, chain MessageFilterChain)

DoFilter 执行过滤操作

type FormatterFilter 

type FormatterFilter struct {
}

FormatterFilter 过滤器

func (*FormatterFilter) DoFilter 

func (inst *FormatterFilter) DoFilter(msg *Message, chain MessageFilterChain)

DoFilter 执行过滤操作

type Level 

type Level int

Level 表示日志的等级 

const (
	ALL   Level = 0 // 把允许的输出等级设置为 ALL，可以输出所有的日志
	TRACE Level = 1
	DEBUG Level = 2
	INFO  Level = 3
	WARN  Level = 4
	ERROR Level = 5
	FATAL Level = 6
	NONE  Level = 99 // 把允许的输出等级设置为 NONE，禁止输出任何等级的日志
)

定义日志等级

func ParseLevel added in v0.9.2 

func ParseLevel(str string) (Level, error)

ParseLevel 把字符串解析为 vlog.Level 值

func (Level) String added in v0.9.2 

func (l Level) String() string

type LevelFilter 

type LevelFilter struct {
	AcceptedLevel Level
}

LevelFilter 过滤器

func (*LevelFilter) DoFilter 

func (inst *LevelFilter) DoFilter(msg *Message, chain MessageFilterChain)

DoFilter 执行过滤操作

type Logger 

type Logger interface {
	LoggerExt

	WithSender(sender any) Logger

	WithTag(tag string) Logger
}

Logger 是最核心的日志接口

func GetDefaultLogger added in v0.9.12 

func GetDefaultLogger() Logger

GetDefaultLogger 获取(默认)日志接口

func GetLogger 

func GetLogger() Logger

GetLogger 获取(当前)日志接口

type LoggerAdapter added in v0.9.11 

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

func (*LoggerAdapter) Debug added in v0.9.11 

func (inst *LoggerAdapter) Debug(fmt string, args ...any)

func (*LoggerAdapter) Error added in v0.9.11 

func (inst *LoggerAdapter) Error(fmt string, args ...any)

func (*LoggerAdapter) Fatal added in v0.9.11 

func (inst *LoggerAdapter) Fatal(fmt string, args ...any)

func (*LoggerAdapter) ForDebug added in v0.9.11 

func (inst *LoggerAdapter) ForDebug(fn func(logger Logger))

func (*LoggerAdapter) ForError added in v0.9.11 

func (inst *LoggerAdapter) ForError(fn func(logger Logger))

func (*LoggerAdapter) ForFatal added in v0.9.11 

func (inst *LoggerAdapter) ForFatal(fn func(logger Logger))

func (*LoggerAdapter) ForInfo added in v0.9.11 

func (inst *LoggerAdapter) ForInfo(fn func(logger Logger))

func (*LoggerAdapter) ForLog added in v0.9.11 

func (inst *LoggerAdapter) ForLog(level Level, fn func(logger Logger))

func (*LoggerAdapter) ForTrace added in v0.9.11 

func (inst *LoggerAdapter) ForTrace(fn func(logger Logger))

func (*LoggerAdapter) ForWarn added in v0.9.11 

func (inst *LoggerAdapter) ForWarn(fn func(logger Logger))

func (*LoggerAdapter) HandleMessage added in v0.9.11 

func (inst *LoggerAdapter) HandleMessage(msg *Message)

func (*LoggerAdapter) Info added in v0.9.11 

func (inst *LoggerAdapter) Info(fmt string, args ...any)

func (*LoggerAdapter) IsDebugEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsDebugEnabled() bool

func (*LoggerAdapter) IsErrorEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsErrorEnabled() bool

func (*LoggerAdapter) IsFatalEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsFatalEnabled() bool

func (*LoggerAdapter) IsInfoEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsInfoEnabled() bool

func (*LoggerAdapter) IsLevelEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsLevelEnabled(l Level) bool

func (*LoggerAdapter) IsTraceEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsTraceEnabled() bool

func (*LoggerAdapter) IsWarnEnabled added in v0.9.11 

func (inst *LoggerAdapter) IsWarnEnabled() bool

func (*LoggerAdapter) Log added in v0.9.11 

func (inst *LoggerAdapter) Log(level Level, fmt string, args ...any)

func (*LoggerAdapter) SetLevelAccepted added in v0.9.11 

func (inst *LoggerAdapter) SetLevelAccepted(lv Level) *LoggerAdapter

func (*LoggerAdapter) SetSender added in v0.9.11 

func (inst *LoggerAdapter) SetSender(sender any) *LoggerAdapter

func (*LoggerAdapter) SetTag added in v0.9.11 

func (inst *LoggerAdapter) SetTag(tag string) *LoggerAdapter

func (*LoggerAdapter) SetTargetChain added in v0.9.11 

func (inst *LoggerAdapter) SetTargetChain(chain MessageFilterChain) *LoggerAdapter

func (*LoggerAdapter) SetTargetHandler added in v0.9.11 

func (inst *LoggerAdapter) SetTargetHandler(h MessageHandler) *LoggerAdapter

func (*LoggerAdapter) SetTargetLogger added in v0.9.11 

func (inst *LoggerAdapter) SetTargetLogger(l LoggerBase) *LoggerAdapter

func (*LoggerAdapter) Trace added in v0.9.11 

func (inst *LoggerAdapter) Trace(fmt string, args ...any)

func (*LoggerAdapter) Warn added in v0.9.11 

func (inst *LoggerAdapter) Warn(fmt string, args ...any)

func (*LoggerAdapter) WithSender added in v0.9.11 

func (inst *LoggerAdapter) WithSender(sender any) Logger

func (*LoggerAdapter) WithTag added in v0.9.11 

func (inst *LoggerAdapter) WithTag(tag string) Logger

type LoggerBase added in v0.9.10 

type LoggerBase interface {
	MessageHandler

	IsLevelEnabled(l Level) bool

	Log(level Level, fmt string, args ...any)

	ForLog(level Level, fn func(logger Logger))
}

LoggerBase 提供基本的日志接口

type LoggerExt added in v0.9.10 

type LoggerExt interface {
	LoggerBase

	IsTraceEnabled() bool
	IsDebugEnabled() bool
	IsInfoEnabled() bool
	IsWarnEnabled() bool
	IsErrorEnabled() bool
	IsFatalEnabled() bool

	ForTrace(fn func(logger Logger))
	ForDebug(fn func(logger Logger))
	ForInfo(fn func(logger Logger))
	ForWarn(fn func(logger Logger))
	ForError(fn func(logger Logger))
	ForFatal(fn func(logger Logger))

	Trace(fmt string, args ...any)
	Debug(fmt string, args ...any)
	Info(fmt string, args ...any)
	Warn(fmt string, args ...any)
	Error(fmt string, args ...any)
	Fatal(fmt string, args ...any)
}

提供扩展的日志接口

type LoggerFactory 

type LoggerFactory interface {
	Create() Logger
}

LoggerFactory 是用来创建 Logger 的接口

func GetDefaultLoggerFactory added in v0.9.12 

func GetDefaultLoggerFactory() LoggerFactory

GetDefaultLoggerFactory 获取(默认)日志工厂

func GetLoggerFactory 

func GetLoggerFactory() LoggerFactory

GetLoggerFactory 获取(当前)日志工厂

type LoggerHolder added in v0.9.5 

type LoggerHolder interface {
	Logger() Logger
}

LoggerHolder 是用来获取 Logger 的接口

type Message 

type Message struct {
	Arguments []any
	Error     error
	Format    string
	Level     Level
	Tag       string
	Sender    any
	Text      string
	Timestamp time.Time
}

Message 表示一条日志记录

type MessageFilter 

type MessageFilter interface {
	DoFilter(msg *Message, chain MessageFilterChain)
}

MessageFilter 表示一个日志消息过滤器

type MessageFilterChain 

type MessageFilterChain interface {
	DoFilter(msg *Message)
}

MessageFilterChain 表示一个日志消息过滤器串

type MessageFilterChainBuilder 

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

MessageFilterChainBuilder 用来创建一个 MessageFilterChain

func (*MessageFilterChainBuilder) AddFilter 

func (inst *MessageFilterChainBuilder) AddFilter(filter MessageFilter)

AddFilter 添加一个过滤器

func (*MessageFilterChainBuilder) Create 

func (inst *MessageFilterChainBuilder) Create() MessageFilterChain

Create 创建 MessageFilterChain

type MessageFilterGroup added in v0.9.3 

type MessageFilterGroup interface {
	GetFilterChain() MessageFilterChain
}

MessageFilterGroup 表示一个日志消息过滤器组

type MessageFilterRegistration added in v0.9.3 

type MessageFilterRegistration struct {
	Order  int
	Name   string
	Filter MessageFilter
}

MessageFilterRegistration 表示一个日志过滤器注册信息

type MessageFilterRegistry added in v0.9.3 

type MessageFilterRegistry interface {
	ListLogFilterRegistration() []*MessageFilterRegistration
}

MessageFilterRegistry 表示一个日志过滤器注册器

type MessageHandler added in v0.9.10 

type MessageHandler interface {
	HandleMessage(msg *Message)
}

MessageHandler 表示一个能接收并处理日志消息的接口

type SimpleLoggerFactory 

type SimpleLoggerFactory struct {
	AcceptedLevel Level
}

SimpleLoggerFactory 实现一个简易的日志工厂

func (*SimpleLoggerFactory) Create 

func (inst *SimpleLoggerFactory) Create() Logger

Create 创建日志接口

type Stringer 

type Stringer interface {
	String() string
}

Stringer 表示一个可字符化的接口

Source Files

View all Source files

Directories

Path Synopsis
src
test/go command

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.