2025-06-06 19:38:01 +08:00
|
|
|
// Package gologger provides a simple logging implementation with multiple appenders and formatters.
|
|
|
|
// It supports console, file, and HTTP logging with customizable formats.
|
2023-01-23 10:09:21 +08:00
|
|
|
package gologger
|
2023-01-23 09:59:30 +08:00
|
|
|
|
|
|
|
import (
|
2023-11-28 18:29:30 +08:00
|
|
|
"strings"
|
2023-01-23 09:59:30 +08:00
|
|
|
"time"
|
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
|
|
|
NoLog = iota
|
|
|
|
Error
|
|
|
|
Warn
|
|
|
|
Info
|
|
|
|
Debug
|
|
|
|
Trace
|
|
|
|
)
|
|
|
|
|
2023-11-28 18:29:30 +08:00
|
|
|
var logLevelMap map[string]int = map[string]int{
|
|
|
|
"off": NoLog,
|
|
|
|
"error": Error,
|
|
|
|
"warn": Warn,
|
|
|
|
"info": Info,
|
|
|
|
"debug": Debug,
|
|
|
|
"trace": Trace,
|
|
|
|
}
|
2023-12-13 23:05:42 +08:00
|
|
|
var loggerMap map[string]*Logger = map[string]*Logger{}
|
|
|
|
var appenderFactoryMap map[string]func(LogAppenderConfig) *LoggerAppender = map[string]func(LogAppenderConfig) *LoggerAppender{}
|
|
|
|
var appenders map[string]*LoggerAppender = map[string]*LoggerAppender{}
|
2025-06-06 13:55:46 +08:00
|
|
|
var loggerConfig LoggersConfig = LoggersConfig{
|
|
|
|
Appenders: map[string]LogAppenderConfig{
|
|
|
|
"console": {
|
|
|
|
Type: "console",
|
|
|
|
Formatter: "text",
|
|
|
|
Options: map[string]interface{}{},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
Categories: map[string]LogConfig{
|
|
|
|
"default": {
|
|
|
|
Level: "error",
|
|
|
|
Appenders: []string{"console"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2023-01-23 10:24:39 +08:00
|
|
|
|
2023-11-28 18:29:30 +08:00
|
|
|
type LogAppenderConfig struct {
|
2025-06-06 11:07:04 +08:00
|
|
|
Type string `json:"type"`
|
|
|
|
Formatter string `json:"formatter"`
|
|
|
|
Options map[string]interface{} `json:"options"`
|
2023-11-28 18:29:30 +08:00
|
|
|
}
|
2023-01-23 10:20:17 +08:00
|
|
|
type LogConfig struct {
|
2023-11-28 18:29:30 +08:00
|
|
|
Level string `json:"level"`
|
|
|
|
Appenders []string `json:"appenders"`
|
|
|
|
}
|
|
|
|
|
|
|
|
type LoggersConfig struct {
|
|
|
|
Appenders map[string]LogAppenderConfig `json:"appenders"`
|
|
|
|
Categories map[string]LogConfig `json:"categories"`
|
2023-01-23 10:20:17 +08:00
|
|
|
}
|
2025-06-06 19:38:01 +08:00
|
|
|
// Logger represents a logger instance for a specific category.
|
|
|
|
// It maintains the log level and appenders for that category.
|
|
|
|
// Example:
|
|
|
|
// logger := GetLogger("mycategory")
|
|
|
|
// logger.Info("This is an info message")
|
|
|
|
// logger.Error("This is an error message")
|
2023-01-23 09:59:30 +08:00
|
|
|
type Logger struct {
|
2023-11-28 18:29:30 +08:00
|
|
|
category string
|
|
|
|
level int
|
2023-12-13 23:05:42 +08:00
|
|
|
appenders []*LoggerAppender
|
2023-01-23 09:59:30 +08:00
|
|
|
}
|
|
|
|
|
2023-01-23 11:35:44 +08:00
|
|
|
type LogEvent struct {
|
2025-06-06 11:07:04 +08:00
|
|
|
Category string `json:"category"`
|
|
|
|
Ts time.Time `json:"ts"`
|
|
|
|
Level int `json:"level"`
|
|
|
|
Data []interface{} `json:"data"`
|
2023-01-23 11:35:44 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
type LoggerAppender interface {
|
|
|
|
GetName() string
|
|
|
|
Append(logEvent LogEvent)
|
2024-09-21 14:25:45 +08:00
|
|
|
Close()
|
2023-01-23 11:35:44 +08:00
|
|
|
}
|
|
|
|
|
2025-06-06 11:07:04 +08:00
|
|
|
var consoleAppender LoggerAppender = *makeConsoleAppender(LogAppenderConfig{})
|
2023-11-28 18:29:30 +08:00
|
|
|
var defaultLogger = &Logger{
|
|
|
|
|
|
|
|
level: Error,
|
2023-12-13 23:05:42 +08:00
|
|
|
appenders: []*LoggerAppender{&consoleAppender},
|
2023-01-23 11:35:44 +08:00
|
|
|
}
|
|
|
|
|
2023-01-23 11:48:03 +08:00
|
|
|
func (l *Logger) log(Level int, msg []interface{}) {
|
2023-01-23 11:35:44 +08:00
|
|
|
|
2023-11-28 18:29:30 +08:00
|
|
|
if Level <= l.level {
|
2023-01-23 11:35:44 +08:00
|
|
|
now := time.Now()
|
2023-11-28 18:29:30 +08:00
|
|
|
logEvent := LogEvent{l.category, now, Level, msg}
|
|
|
|
for _, appender := range l.appenders {
|
2023-12-13 23:05:42 +08:00
|
|
|
(*appender).Append(logEvent)
|
2023-11-28 18:29:30 +08:00
|
|
|
}
|
|
|
|
// l.Appender.Append(logEvent)
|
2023-01-23 11:35:44 +08:00
|
|
|
// fmt.Println(now.Format("2006-01-02 15:04:05"), " ", l.Name, ": ", msg)
|
2023-01-23 09:59:30 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-01-23 11:35:44 +08:00
|
|
|
func (l *Logger) Error(msg ...interface{}) {
|
2023-01-23 09:59:30 +08:00
|
|
|
l.log(Error, msg)
|
|
|
|
}
|
|
|
|
|
2023-01-23 11:35:44 +08:00
|
|
|
func (l *Logger) Warn(msg ...interface{}) {
|
2023-01-23 09:59:30 +08:00
|
|
|
l.log(Warn, msg)
|
|
|
|
}
|
|
|
|
|
2023-01-23 11:35:44 +08:00
|
|
|
func (l *Logger) Info(msg ...interface{}) {
|
2023-01-23 09:59:30 +08:00
|
|
|
l.log(Info, msg)
|
|
|
|
}
|
|
|
|
|
2023-01-23 11:35:44 +08:00
|
|
|
func (l *Logger) Debug(msg ...interface{}) {
|
2023-01-23 09:59:30 +08:00
|
|
|
l.log(Debug, msg)
|
|
|
|
}
|
|
|
|
|
2023-01-23 11:35:44 +08:00
|
|
|
func (l *Logger) Trace(msg ...interface{}) {
|
2023-01-23 09:59:30 +08:00
|
|
|
l.log(Trace, msg)
|
|
|
|
}
|
2023-12-13 23:05:42 +08:00
|
|
|
func GetLogger(name string) *Logger {
|
2023-11-28 18:29:30 +08:00
|
|
|
if logger, ok := loggerMap[name]; ok {
|
2023-01-23 10:24:39 +08:00
|
|
|
return logger
|
|
|
|
} else {
|
2023-11-28 18:29:30 +08:00
|
|
|
logConfig, ok := loggerConfig.Categories[name]
|
|
|
|
if ok {
|
|
|
|
return makeLogger(name, logConfig)
|
|
|
|
}
|
2025-06-06 13:55:46 +08:00
|
|
|
logConfig, ok = loggerConfig.Categories["default"]
|
|
|
|
l := makeLogger(name, logConfig)
|
2023-12-13 23:05:42 +08:00
|
|
|
l.category = name
|
2025-06-06 13:55:46 +08:00
|
|
|
loggerMap[name] = l
|
|
|
|
return l
|
2023-11-28 18:29:30 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-12-13 23:05:42 +08:00
|
|
|
func makeLogger(name string, config LogConfig) *Logger {
|
2023-11-28 18:29:30 +08:00
|
|
|
logger := &Logger{category: name}
|
|
|
|
levelstr := strings.ToLower(config.Level)
|
|
|
|
logger.level = logLevelMap[levelstr]
|
2023-11-29 10:16:56 +08:00
|
|
|
|
2025-06-06 09:57:25 +08:00
|
|
|
if len(config.Appenders) == 0 {
|
2023-12-13 23:05:42 +08:00
|
|
|
logger.appenders = []*LoggerAppender{&consoleAppender}
|
2023-11-28 18:29:30 +08:00
|
|
|
} else {
|
2023-12-13 23:05:42 +08:00
|
|
|
logger.appenders = make([]*LoggerAppender, len(config.Appenders))
|
2023-11-28 18:29:30 +08:00
|
|
|
for i, appenderName := range config.Appenders {
|
|
|
|
logger.appenders[i] = appenders[appenderName]
|
|
|
|
}
|
|
|
|
}
|
2023-12-13 23:05:42 +08:00
|
|
|
loggerMap[name] = logger
|
|
|
|
return logger
|
2023-11-28 18:29:30 +08:00
|
|
|
}
|
2025-06-06 13:55:46 +08:00
|
|
|
|
|
|
|
func ReconfigLoggers(config LoggersConfig) {
|
|
|
|
validateConfig(config)
|
2023-11-28 18:29:30 +08:00
|
|
|
loggerConfig = config
|
|
|
|
for name, appenderConfig := range loggerConfig.Appenders {
|
2025-06-06 13:55:46 +08:00
|
|
|
oldappender, ok := appenders[name]
|
|
|
|
if ok {
|
|
|
|
(*oldappender).Close()
|
|
|
|
}
|
2023-11-28 18:29:30 +08:00
|
|
|
appenderFactory, ok := appenderFactoryMap[appenderConfig.Type]
|
|
|
|
if ok {
|
|
|
|
appenders[name] = appenderFactory(appenderConfig)
|
|
|
|
} else {
|
2023-12-13 23:05:42 +08:00
|
|
|
appenders[name] = &consoleAppender
|
2023-01-23 11:35:44 +08:00
|
|
|
}
|
2023-01-23 10:24:39 +08:00
|
|
|
}
|
2025-06-06 13:55:46 +08:00
|
|
|
for name, logger := range loggerMap {
|
|
|
|
logConfig, ok := loggerConfig.Categories[name]
|
|
|
|
if !ok {
|
|
|
|
logConfig, _ = loggerConfig.Categories["default"]
|
|
|
|
}
|
|
|
|
logger.level = logLevelMap[strings.ToLower(logConfig.Level)]
|
|
|
|
if len(logConfig.Appenders) == 0 {
|
|
|
|
logger.appenders = []*LoggerAppender{&consoleAppender}
|
|
|
|
} else {
|
|
|
|
logger.appenders = make([]*LoggerAppender, len(logConfig.Appenders))
|
|
|
|
for i, appenderName := range logConfig.Appenders {
|
|
|
|
logger.appenders[i] = appenders[appenderName]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
func validateConfig(config LoggersConfig) {
|
|
|
|
_, ok := loggerConfig.Categories["default"]
|
|
|
|
if !ok {
|
|
|
|
panic("default logger config not found")
|
2023-11-28 18:29:30 +08:00
|
|
|
}
|
|
|
|
}
|
2025-06-06 13:55:46 +08:00
|
|
|
func Configure(config LoggersConfig) {
|
|
|
|
validateConfig(config)
|
|
|
|
ReconfigLoggers(config)
|
|
|
|
}
|
2023-11-28 18:29:30 +08:00
|
|
|
|
2023-12-13 23:05:42 +08:00
|
|
|
func RegistAppender(typeName string, appenderCreatCb func(LogAppenderConfig) *LoggerAppender) {
|
2023-01-23 10:24:39 +08:00
|
|
|
|
2023-11-28 18:29:30 +08:00
|
|
|
appenderFactoryMap[typeName] = appenderCreatCb
|
2023-01-23 09:59:30 +08:00
|
|
|
}
|
2025-06-06 13:55:46 +08:00
|
|
|
|
|
|
|
func init() {
|
|
|
|
loggerMap["default"] = defaultLogger
|
|
|
|
}
|