Compare commits

...

9 Commits

Author SHA1 Message Date
kingecg 74b7feac5b 添加 LICENSE 2024-11-08 21:33:16 +08:00
kingecg 45c66585ad fix support for format 2024-10-01 15:55:21 +08:00
kingecg d13d851819 add support for format 2024-10-01 13:47:50 +08:00
kingecg 8515465587 fix test app 2024-09-21 22:41:52 +08:00
kingecg 6d89afc6e3 fix dead loop 2024-09-21 14:25:45 +08:00
kingecg 20e440f79d 增加close file code 2023-12-13 23:07:32 +08:00
kingecg a6aaaa7495 getlogger返回指针,file 改为通过协程写文件 2023-12-13 23:05:42 +08:00
kingecg 4811fbbbe5 更新 format.go 2023-12-10 00:40:49 +08:00
kingecg 5b8be57c69 更新 format.go
log 信息添加category
2023-12-10 00:40:28 +08:00
10 changed files with 185 additions and 31 deletions

1
.gitignore vendored
View File

@ -15,3 +15,4 @@
# Dependency directories (remove the comment below to include it) # Dependency directories (remove the comment below to include it)
# vendor/ # vendor/
log/

2
.vscode/launch.json vendored
View File

@ -9,7 +9,7 @@
"type": "go", "type": "go",
"request": "launch", "request": "launch",
"mode": "auto", "mode": "auto",
"program": "${fileDirname}", "program": "${workspaceFolder}/test",
"cwd": "${workspaceFolder}", "cwd": "${workspaceFolder}",
} }
] ]

9
LICENSE Normal file
View File

@ -0,0 +1,9 @@
MIT License
Copyright (c) 2024 kingecg
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -15,6 +15,11 @@ const (
type ConsoleAppender struct { type ConsoleAppender struct {
} }
// Close implements LoggerAppender.
func (c *ConsoleAppender) Close() {
}
func (c *ConsoleAppender) GetName() string { func (c *ConsoleAppender) GetName() string {
return "console" return "console"
} }
@ -35,9 +40,9 @@ func (c *ConsoleAppender) Append(logEvent LogEvent) {
fmt.Printf(TraceTemplate, logMsg) fmt.Printf(TraceTemplate, logMsg)
} }
} }
func makeConsoleAppender(appenderConfig LogAppenderConfig) LoggerAppender { func makeConsoleAppender(appenderConfig LogAppenderConfig) *LoggerAppender {
var appender LoggerAppender = &ConsoleAppender{} var appender LoggerAppender = &ConsoleAppender{}
return appender return &appender
} }
func init() { func init() {
RegistAppender("console", makeConsoleAppender) RegistAppender("console", makeConsoleAppender)

37
file.go
View File

@ -7,14 +7,24 @@ import (
type FileAppender struct { type FileAppender struct {
filePath string filePath string
lchan chan LogEvent
file *os.File file *os.File
stopChan chan struct{}
}
// Close implements LoggerAppender.
func (f *FileAppender) Close() {
//send stop signal
f.stopChan <- struct{}{}
} }
func (f *FileAppender) GetName() string { func (f *FileAppender) GetName() string {
return "FileAppender:" + f.filePath return "FileAppender:" + f.filePath
} }
func (f *FileAppender) Append(logEvent LogEvent) { func (f *FileAppender) start() {
f.lchan = make(chan LogEvent, 10)
f.stopChan = make(chan struct{})
if f.file == nil || int(f.file.Fd()) == -1 { if f.file == nil || int(f.file.Fd()) == -1 {
dirName := filepath.Dir(f.filePath) dirName := filepath.Dir(f.filePath)
_, err := os.Stat(dirName) _, err := os.Stat(dirName)
@ -24,12 +34,26 @@ func (f *FileAppender) Append(logEvent LogEvent) {
f.file, _ = os.OpenFile(f.filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) f.file, _ = os.OpenFile(f.filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
} }
logMsg := format(logEvent) go func() {
f.file.WriteString(logMsg) defer f.file.Close()
for {
select {
case <-f.stopChan:
return
case logEvent := <-f.lchan:
logMsg := format(logEvent)
f.file.WriteString(logMsg)
}
}
}()
}
func (f *FileAppender) Append(logEvent LogEvent) {
f.lchan <- logEvent
} }
func makeFileAppender(appenderConfig LogAppenderConfig) LoggerAppender { func makeFileAppender(appenderConfig LogAppenderConfig) *LoggerAppender {
var logfile interface{} var logfile interface{}
var ok bool var ok bool
logfile, ok = appenderConfig.Options["file"] logfile, ok = appenderConfig.Options["file"]
@ -39,7 +63,10 @@ func makeFileAppender(appenderConfig LogAppenderConfig) LoggerAppender {
var ret LoggerAppender = &FileAppender{ var ret LoggerAppender = &FileAppender{
filePath: logfile.(string), filePath: logfile.(string),
} }
return ret
ret.(*FileAppender).start()
return &ret
} }
func init() { func init() {

View File

@ -2,22 +2,52 @@ package gologger
import ( import (
"fmt" "fmt"
"strings"
) )
const logTemplate = "[%s] %s - %s\n" const logTemplate = "[%s] %s : %s - %s\n"
func format(logEvent LogEvent) string { func format(logEvent LogEvent) string {
data := logEvent.Ts.Format("2006-01-02 15:04:05") data := logEvent.Ts.Format("2006-01-02 15:04:05")
msg := fmt.Sprint(logEvent.Data...) msg := ""
ret := fmt.Sprintf(logTemplate, data, getLogLevelStr(logEvent.Level), msg) firstMsg := logEvent.Data[0]
if isFormatString(firstMsg) {
msg = fmt.Sprintf(firstMsg.(string), logEvent.Data[1:]...)
} else {
msg = sprint(logEvent.Data)
}
ret := fmt.Sprintf(logTemplate, data, logEvent.Category, getLogLevelStr(logEvent.Level), msg)
return ret return ret
} }
func getLogLevelStr(level int) string { func getLogLevelStr(level int) string {
for name, slevel := range logLevelMap { for name, slevel := range logLevelMap {
if slevel == level { if slevel == level {
return name return strings.ToUpper(name)
} }
} }
return "Unknown" return "Unknown"
} }
func isFormatString(f interface{}) bool {
s, ok := f.(string)
if !ok {
return false
}
// 尝试使用空接口来格式化字符串
m := fmt.Sprintf(s, []interface{}{}...)
return strings.Index(m, "MISSING") != -1
}
func sprint(s []interface{}) string {
str := make([]any, len(s))
for i, v := range s {
if i > 0 {
str[i] = fmt.Sprintf(" %v", v)
} else {
str[i] = fmt.Sprintf("%v", v)
}
}
return fmt.Sprint(str...)
}

54
format_test.go Normal file
View File

@ -0,0 +1,54 @@
package gologger
import (
"strings"
"testing"
"time"
)
func TestFormat(t *testing.T) {
tests := []struct {
name string
logEvent LogEvent
want string
}{
{
name: "Info level with format string",
logEvent: LogEvent{
Ts: time.Now(),
Category: "test_category",
Level: Info,
Data: []interface{}{"%s: %v", "key", "value"},
},
want: "test_category : INFO - key: value",
},
{
name: "Info level with one format string",
logEvent: LogEvent{
Ts: time.Now(),
Category: "test_category",
Level: Info,
Data: []interface{}{"%s", "key"},
},
want: "test_category : INFO - key",
},
{
name: "Error level without format string",
logEvent: LogEvent{
Ts: time.Now(),
Category: "test_category",
Level: Error,
Data: []interface{}{"error occurred", "additional info"},
},
want: "test_category : ERROR - error occurred additional info",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := format(tt.logEvent); strings.Index(got, tt.want) == -1 {
t.Errorf("format() = %v, want %v", got, tt.want)
}
})
}
}

38
main.go
View File

@ -22,9 +22,9 @@ var logLevelMap map[string]int = map[string]int{
"debug": Debug, "debug": Debug,
"trace": Trace, "trace": Trace,
} }
var loggerMap map[string]Logger = map[string]Logger{} var loggerMap map[string]*Logger = map[string]*Logger{}
var appenderFactoryMap map[string]func(LogAppenderConfig) LoggerAppender = map[string]func(LogAppenderConfig) LoggerAppender{} var appenderFactoryMap map[string]func(LogAppenderConfig) *LoggerAppender = map[string]func(LogAppenderConfig) *LoggerAppender{}
var appenders map[string]LoggerAppender = map[string]LoggerAppender{} var appenders map[string]*LoggerAppender = map[string]*LoggerAppender{}
var loggerConfig LoggersConfig var loggerConfig LoggersConfig
type LogAppenderConfig struct { type LogAppenderConfig struct {
@ -43,7 +43,7 @@ type LoggersConfig struct {
type Logger struct { type Logger struct {
category string category string
level int level int
appenders []LoggerAppender appenders []*LoggerAppender
} }
type LogEvent struct { type LogEvent struct {
@ -56,13 +56,14 @@ type LogEvent struct {
type LoggerAppender interface { type LoggerAppender interface {
GetName() string GetName() string
Append(logEvent LogEvent) Append(logEvent LogEvent)
Close()
} }
var consoleAppender LoggerAppender = &ConsoleAppender{} var consoleAppender LoggerAppender = &ConsoleAppender{}
var defaultLogger = &Logger{ var defaultLogger = &Logger{
level: Error, level: Error,
appenders: []LoggerAppender{consoleAppender}, appenders: []*LoggerAppender{&consoleAppender},
} }
func (l *Logger) log(Level int, msg []interface{}) { func (l *Logger) log(Level int, msg []interface{}) {
@ -71,7 +72,7 @@ func (l *Logger) log(Level int, msg []interface{}) {
now := time.Now() now := time.Now()
logEvent := LogEvent{l.category, now, Level, msg} logEvent := LogEvent{l.category, now, Level, msg}
for _, appender := range l.appenders { for _, appender := range l.appenders {
appender.Append(logEvent) (*appender).Append(logEvent)
} }
// l.Appender.Append(logEvent) // l.Appender.Append(logEvent)
// fmt.Println(now.Format("2006-01-02 15:04:05"), " ", l.Name, ": ", msg) // fmt.Println(now.Format("2006-01-02 15:04:05"), " ", l.Name, ": ", msg)
@ -97,7 +98,7 @@ func (l *Logger) Debug(msg ...interface{}) {
func (l *Logger) Trace(msg ...interface{}) { func (l *Logger) Trace(msg ...interface{}) {
l.log(Trace, msg) l.log(Trace, msg)
} }
func GetLogger(name string) Logger { func GetLogger(name string) *Logger {
if logger, ok := loggerMap[name]; ok { if logger, ok := loggerMap[name]; ok {
return logger return logger
} else { } else {
@ -106,29 +107,30 @@ func GetLogger(name string) Logger {
return makeLogger(name, logConfig) return makeLogger(name, logConfig)
} }
if name == "default" { if name == "default" {
return *defaultLogger return defaultLogger
} }
ret := GetLogger("default") l := *GetLogger("default")
ret.category = name l.category = name
return ret loggerMap[name] = &l
return &l
} }
} }
func makeLogger(name string, config LogConfig) Logger { func makeLogger(name string, config LogConfig) *Logger {
logger := &Logger{category: name} logger := &Logger{category: name}
levelstr := strings.ToLower(config.Level) levelstr := strings.ToLower(config.Level)
logger.level = logLevelMap[levelstr] logger.level = logLevelMap[levelstr]
if config.Appenders == nil || len(config.Appenders) == 0 { if config.Appenders == nil || len(config.Appenders) == 0 {
logger.appenders = []LoggerAppender{consoleAppender} logger.appenders = []*LoggerAppender{&consoleAppender}
} else { } else {
logger.appenders = make([]LoggerAppender, len(config.Appenders)) logger.appenders = make([]*LoggerAppender, len(config.Appenders))
for i, appenderName := range config.Appenders { for i, appenderName := range config.Appenders {
logger.appenders[i] = appenders[appenderName] logger.appenders[i] = appenders[appenderName]
} }
} }
loggerMap[name] = *logger loggerMap[name] = logger
return *logger return logger
} }
func Configure(config LoggersConfig) { func Configure(config LoggersConfig) {
loggerConfig = config loggerConfig = config
@ -137,7 +139,7 @@ func Configure(config LoggersConfig) {
if ok { if ok {
appenders[name] = appenderFactory(appenderConfig) appenders[name] = appenderFactory(appenderConfig)
} else { } else {
appenders[name] = &ConsoleAppender{} appenders[name] = &consoleAppender
} }
} }
for name, _ := range loggerConfig.Categories { for name, _ := range loggerConfig.Categories {
@ -145,7 +147,7 @@ func Configure(config LoggersConfig) {
} }
} }
func RegistAppender(typeName string, appenderCreatCb func(LogAppenderConfig) LoggerAppender) { func RegistAppender(typeName string, appenderCreatCb func(LogAppenderConfig) *LoggerAppender) {
appenderFactoryMap[typeName] = appenderCreatCb appenderFactoryMap[typeName] = appenderCreatCb
} }

26
main_test.go Normal file
View File

@ -0,0 +1,26 @@
// TestGetLogger tests the GetLogger function
package gologger
import "testing"
func TestGetLogger(t *testing.T) {
// Initialize loggerMap and loggerConfig
dl := GetLogger("default")
if dl != defaultLogger {
t.Errorf("GetLogger(\"defult\") should return defaultLogger")
}
al := GetLogger("app")
if al == dl {
t.Errorf("GetLogger(\"app\") should return a new logger")
}
al2 := GetLogger("app")
if al2 != al {
t.Errorf("GetLogger(\"app\") should return the same logger")
}
}

View File

@ -4,7 +4,7 @@ import (
logger "git.pyer.club/kingecg/gologger" logger "git.pyer.club/kingecg/gologger"
) )
func main() { func aqmain() {
logger.Configure(logger.LoggersConfig{ logger.Configure(logger.LoggersConfig{
Categories: map[string]logger.LogConfig{ Categories: map[string]logger.LogConfig{
"default": { "default": {