Compare commits

...

10 Commits

Author SHA1 Message Date
kingecg cdea9d86ed ```
feat(file): add thread safety and improve log rolling functionality

- Add sync.Mutex to FileAppender for thread-safe operations
- Implement proper mutex locking in start() goroutine to prevent
  race conditions during file operations
- Return boolean from checkAndRoll() method to indicate if rolling occurred
- Add MaxCount field to limit number of archived log files
- Implement cleanup of old log files exceeding MaxCount limit
- Add proper error handling for file rename operations
- Track current file size using WriteString return values

refactor(format): update formatting functions with better type safety

- Change isFormatString parameter

Co-authored-by: Copilot <copilot@github.com>
2026-07-09 21:47:03 +08:00
kingecg 8c6cf6310f chore: update module path to git.kingecg.top 2025-06-26 01:05:39 +08:00
kingecg ecd906084a chore: update module path to git.kingecg.top 2025-06-25 22:53:39 +08:00
kingecg 0c28c10c1e chore: update module path to git.kingecg.top 2025-06-25 21:56:20 +08:00
kingecg 27fcdad135 fix nil pointer error 2025-06-06 23:30:27 +08:00
kingecg 1004333534 fix 2025-06-06 20:23:06 +08:00
kingecg 107b8f3050 add doc 2025-06-06 19:38:01 +08:00
程广 42beab28a3 make it can reconfig 2025-06-06 13:55:46 +08:00
程广 b5ea719c56 file appender添加滚动设置,appender添加formatter设置 2025-06-06 11:07:04 +08:00
程广 c8e7426d2d fix code 2025-06-06 09:57:25 +08:00
9 changed files with 452 additions and 66 deletions

View File

@ -1,3 +1,77 @@
# gologger
a logger used in go
GoLogger 是一个简单但功能强大的 Go 语言日志库,提供灵活的日志记录功能。它支持多种日志输出方式(控制台、文件等),并允许自定义日志格式。
## 特性
- 支持多种日志级别ERROR, WARN, INFO, DEBUG, TRACE
- 支持多种输出方式:控制台、文件(支持滚动策略)
- 可定制日志格式
- 支持按类别记录日志
## 安装
```bash
go get github.com/yourusername/gologger
```
## 快速开始
```go
package main
import (
"github.com/yourusername/gologger"
)
func main() {
// 获取默认logger
logger := gologger.GetLogger("main")
// 设置全局日志级别
gologger.Configure(gologger.LoggersConfig{
Level: "info",
Appenders: []gologger.LogAppenderConfig{
{
Type: "console",
},
{
Type: "file",
Options: map[string]interface{}{
"filePath": "app.log",
"EnableRolling": true,
"MaxSize": 1024 * 1024 * 10, // 10MB
},
},
},
})
// 记录日志
logger.Info("Application started")
logger.Error("An error occurred")
}
```
## 配置说明
### 日志级别
支持的级别包括off, error, warn, info, debug, trace
### 输出方式Appenders
1. **ConsoleAppender** - 控制台输出
配置示例:
```go
{
Type: "console",
}
```
2. **FileAppender** - 文件输出,支持滚动策略
配置参数:
- filePath: 日志文件路径
- EnableRolling: 是否启用滚动默认true
- MaxSize: 单个文件最大大小字节默认10MB
- MaxAge: 文件最大保存时间默认86400秒=24小时
### 格式化器
可以通过SelectFormatter选择不同的日志格式
- simple: 简单格式 `[timestamp] level : category - message`
- json: JSON 格式输出

View File

@ -4,6 +4,18 @@ import (
"fmt"
)
// ConsoleAppender implements the LoggerAppender interface for console output.
// It uses color-coded templates for different log levels.
// Example:
// appender := &ConsoleAppender{
// formatter: NewSimpleFormatter(),
// }
// appender.Append(event)
// appender.Close()
type ConsoleAppender struct {
formatter LogFormatter
}
const (
ErrorTemplate = "\033[1;31m%s\033[0m"
WarnTemplate = "\033[1;33m%s\033[0m"
@ -12,9 +24,6 @@ const (
TraceTemplate = "\033[1;35m%s\033[0m"
)
type ConsoleAppender struct {
}
// Close implements LoggerAppender.
func (c *ConsoleAppender) Close() {
@ -26,7 +35,7 @@ func (c *ConsoleAppender) GetName() string {
func (c *ConsoleAppender) Append(logEvent LogEvent) {
logMsg := format(logEvent)
logMsg := c.formatter(logEvent)
switch logEvent.Level {
case Error:
fmt.Printf(ErrorTemplate, logMsg)
@ -41,7 +50,9 @@ func (c *ConsoleAppender) Append(logEvent LogEvent) {
}
}
func makeConsoleAppender(appenderConfig LogAppenderConfig) *LoggerAppender {
var appender LoggerAppender = &ConsoleAppender{}
consoleAppender := &ConsoleAppender{}
consoleAppender.formatter = SelectFormatter(appenderConfig.Formatter)
var appender LoggerAppender = consoleAppender
return &appender
}
func init() {

201
file.go
View File

@ -3,13 +3,40 @@ package gologger
import (
"os"
"path/filepath"
"regexp"
"sort"
"strconv"
"strings"
"sync"
"time"
)
// FileAppender implements the LoggerAppender interface for file output.
// It supports log rotation based on file size and age.
// Example:
//
// appender := &FileAppender{
// formatter: NewSimpleFormatter(),
// filePath: "app.log",
// EnableRolling: true,
// MaxSize: 1024 * 1024 * 10, // 10MB
// }
// appender.Append(event)
// appender.Close()
type FileAppender struct {
filePath string
lchan chan LogEvent
file *os.File
stopChan chan struct{}
formatter LogFormatter
filePath string
lchan chan LogEvent
file *os.File
stopChan chan struct{}
mu sync.Mutex
// 新增滚动相关字段
EnableRolling bool
MaxSize int64 // 文件最大大小(字节)
MaxAge int64 // 文件最大时间(秒)
MaxCount int // 最大文件数量
currentFileSize int64 // 当前文件大小
createdAt int64 // 文件创建时间戳
}
// Close implements LoggerAppender.
@ -32,36 +59,186 @@ func (f *FileAppender) start() {
os.MkdirAll(dirName, 0755)
}
f.file, _ = os.OpenFile(f.filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
// 获取当前文件大小
if stat, err := f.file.Stat(); err == nil {
f.currentFileSize = stat.Size()
}
// 记录文件创建时间
f.createdAt = time.Now().Unix()
}
go func() {
defer f.file.Close()
for {
select {
case <-f.stopChan:
f.mu.Lock()
if f.file != nil {
f.file.Close()
}
f.mu.Unlock()
return
case logEvent := <-f.lchan:
logMsg := format(logEvent)
f.file.WriteString(logMsg)
f.mu.Lock()
// 检查日志滚动
if f.EnableRolling {
if f.checkAndRoll(logEvent) {
f.mu.Unlock()
continue
}
}
logMsg := f.formatter(logEvent)
n, err := f.file.WriteString(logMsg)
if err == nil {
f.currentFileSize += int64(n)
}
f.mu.Unlock()
}
}
}()
}
// 新增日志滚动方法,返回是否进行了滚动
func (f *FileAppender) checkAndRoll(logEvent LogEvent) bool {
// 按大小滚动
if f.MaxSize > 0 && f.currentFileSize >= f.MaxSize {
f.rollFile(logEvent)
return true
}
// 按时间滚动
if f.MaxAge > 0 && time.Now().Unix()-f.createdAt >= f.MaxAge {
f.rollFile(logEvent)
return true
}
return false
}
// 日志文件滚动
func (f *FileAppender) rollFile(logEvent LogEvent) {
// 关闭当前文件
if f.file != nil {
f.file.Close()
}
// 重命名旧文件
timestamp := time.Now().Format("20060102150405")
newPath := f.filePath + "." + timestamp
if err := os.Rename(f.filePath, newPath); err != nil {
// 重命名失败,直接创建新文件
f.file, _ = os.OpenFile(f.filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
return
}
// 创建新文件
var err error
f.file, err = os.OpenFile(f.filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
if err != nil {
return
}
// 重置状态
f.currentFileSize = 0
f.createdAt = time.Now().Unix()
// 重新写入当前日志
logMsg := f.formatter(logEvent)
if _, err := f.file.WriteString(logMsg); err == nil {
f.currentFileSize += int64(len(logMsg))
}
// 清理超过MaxCount的旧文件
if f.MaxCount > 0 {
logDir := filepath.Dir(newPath)
logFileBase := filepath.Base(f.filePath)
files, _ := filepath.Glob(logDir + "/" + logFileBase + ".*")
if len(files) > f.MaxCount {
sort.Slice(files, func(i, j int) bool {
return files[i] < files[j]
})
for i := 0; i < len(files)-f.MaxCount; i++ {
os.Remove(files[i])
}
}
}
}
func (f *FileAppender) Append(logEvent LogEvent) {
f.lchan <- logEvent
}
func makeFileAppender(appenderConfig LogAppenderConfig) *LoggerAppender {
var logfile interface{}
var ok bool
logfile, ok = appenderConfig.Options["file"]
logfile, ok := appenderConfig.Options["file"]
if !ok {
logfile = "default.log"
}
// 新增滚动配置参数
rollingEnabled := false
if enable, ok := appenderConfig.Options["enableRolling"].(bool); ok {
rollingEnabled = enable
}
maxSize := int64(0)
if size, ok := appenderConfig.Options["maxSize"].(int64); ok {
maxSize = size * 1024 * 1024 // 将兆转换为字节
} else if sizeStr, ok := appenderConfig.Options["maxSize"].(string); ok {
// 解析带单位的大小配置支持KB, MB, GB
var re = regexp.MustCompile(`(?i)^(\d+)([kmg]b)?$`)
matches := re.FindStringSubmatch(sizeStr)
if len(matches) > 0 {
num, _ := strconv.ParseInt(matches[1], 10, 64)
unit := ""
if len(matches) > 2 {
unit = matches[2]
}
switch unit {
case "KB", "kb":
maxSize = num * 1024
case "MB", "mb":
maxSize = num * 1024 * 1024
case "GB", "gb":
maxSize = num * 1024 * 1024 * 1024
default:
maxSize = num * 1024 * 1024 // 默认按MB处理
}
}
}
maxAge := int64(0)
if ageStr, ok := appenderConfig.Options["maxAge"].(string); ok {
// 解析带单位的时间配置
re := regexp.MustCompile(`^\d+[hd]?$`)
if re.MatchString(ageStr) {
// 提取数字部分和单位
var numStr strings.Builder
unit := ""
for _, c := range ageStr {
if c >= '0' && c <= '9' {
numStr.WriteRune(c)
} else {
unit = string(c)
}
}
num, _ := strconv.ParseInt(numStr.String(), 10, 64)
switch unit {
case "h":
maxAge = num * 3600 // 小时转秒
default:
maxAge = num * 86400 // 默认按天转秒
}
}
} else if ageInt, ok := appenderConfig.Options["maxAge"].(int64); ok {
maxAge = ageInt
}
var ret LoggerAppender = &FileAppender{
filePath: logfile.(string),
formatter: SelectFormatter(appenderConfig.Formatter),
filePath: logfile.(string),
EnableRolling: rollingEnabled,
MaxSize: maxSize,
MaxAge: maxAge,
}
ret.(*FileAppender).start()

View File

@ -1,24 +1,39 @@
// Package gologger provides a simple logging implementation with multiple appenders and formatters.
// It supports console, file, and HTTP logging with customizable formats.
package gologger
import (
"encoding/json"
"fmt"
"strings"
)
// LogFormatter is a function type that formats a LogEvent into a string.
// Example:
//
// formatter := func(event LogEvent) string {
// return fmt.Sprintf("[%s] %s: %v", event.Ts.Format("2006-01-02"), event.Level, event.Data)
// }
type LogFormatter = func(LogEvent) string
const logTemplate = "[%s] %s : %s - %s\n"
// format is the default formatter that converts a LogEvent to a string using the default template.
// It handles both simple values and formatted strings.
// Template: "[timestamp] level : category - data"
func format(logEvent LogEvent) string {
data := logEvent.Ts.Format("2006-01-02 15:04:05")
msg := ""
firstMsg := logEvent.Data[0]
if isFormatString(firstMsg) {
msg = fmt.Sprintf(firstMsg.(string), logEvent.Data[1:]...)
} else {
msg = sprint(logEvent.Data)
var msg string
if len(logEvent.Data) > 0 {
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 fmt.Sprintf(logTemplate, data, logEvent.Category, getLogLevelStr(logEvent.Level), msg)
}
func getLogLevelStr(level int) string {
@ -30,24 +45,45 @@ func getLogLevelStr(level int) string {
return "Unknown"
}
func isFormatString(f interface{}) bool {
func isFormatString(f any) bool {
s, ok := f.(string)
if !ok {
return false
}
// 尝试使用空接口来格式化字符串
m := fmt.Sprintf(s, []interface{}{}...)
return strings.Index(m, "MISSING") != -1
// 检查是否包含常见格式化动词
return strings.Contains(s, "%s") || strings.Contains(s, "%d") ||
strings.Contains(s, "%v") || strings.Contains(s, "%f") ||
strings.Contains(s, "%x") || strings.Contains(s, "%t") ||
strings.Contains(s, "%c") || strings.Contains(s, "%b") ||
strings.Contains(s, "%e") || strings.Contains(s, "%g")
}
func sprint(s []interface{}) string {
str := make([]any, len(s))
func sprint(s []any) string {
var b strings.Builder
for i, v := range s {
if i > 0 {
str[i] = fmt.Sprintf(" %v", v)
} else {
str[i] = fmt.Sprintf("%v", v)
b.WriteString(" ")
}
fmt.Fprintf(&b, "%v", v)
}
return b.String()
}
func jsonFormatter(logEvent LogEvent) string {
d, err := json.Marshal(logEvent)
if err != nil {
return fmt.Sprintf(`{"error":"%v"}`, logEvent.Data)
}
return string(d)
}
func SelectFormatter(formatter string) LogFormatter {
switch strings.ToLower(formatter) {
case "json":
return jsonFormatter
case "text":
return format
default:
return format
}
return fmt.Sprint(str...)
}

View File

@ -46,7 +46,7 @@ func TestFormat(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := format(tt.logEvent); strings.Index(got, tt.want) == -1 {
if got := format(tt.logEvent); strings.Contains(got, tt.want) {
t.Errorf("format() = %v, want %v", got, tt.want)
}
})

2
go.mod
View File

@ -1,3 +1,3 @@
module git.pyer.club/kingecg/gologger
module git.kingecg.top/kingecg/gologger
go 1.19

117
main.go
View File

@ -1,7 +1,10 @@
// Package gologger provides a simple logging implementation with multiple appenders and formatters.
// It supports console, file, and HTTP logging with customizable formats.
package gologger
import (
"strings"
"sync"
"time"
)
@ -25,11 +28,27 @@ var logLevelMap map[string]int = map[string]int{
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{}
var loggerConfig LoggersConfig
var mu sync.RWMutex
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"},
},
},
}
type LogAppenderConfig struct {
Type string `json:"type"`
Options map[string]interface{} `json:"options"`
Type string `json:"type"`
Formatter string `json:"formatter"`
Options map[string]interface{} `json:"options"`
}
type LogConfig struct {
Level string `json:"level"`
@ -40,6 +59,14 @@ type LoggersConfig struct {
Appenders map[string]LogAppenderConfig `json:"appenders"`
Categories map[string]LogConfig `json:"categories"`
}
// 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")
type Logger struct {
category string
level int
@ -47,10 +74,10 @@ type Logger struct {
}
type LogEvent struct {
Category string
Ts time.Time
Level int
Data []interface{}
Category string `json:"category"`
Ts time.Time `json:"ts"`
Level int `json:"level"`
Data []interface{} `json:"data"`
}
type LoggerAppender interface {
@ -59,7 +86,7 @@ type LoggerAppender interface {
Close()
}
var consoleAppender LoggerAppender = &ConsoleAppender{}
var consoleAppender LoggerAppender = *makeConsoleAppender(LogAppenderConfig{})
var defaultLogger = &Logger{
level: Error,
@ -99,21 +126,24 @@ func (l *Logger) Trace(msg ...interface{}) {
l.log(Trace, msg)
}
func GetLogger(name string) *Logger {
mu.RLock()
if logger, ok := loggerMap[name]; ok {
mu.RUnlock()
return logger
} else {
logConfig, ok := loggerConfig.Categories[name]
if ok {
return makeLogger(name, logConfig)
}
if name == "default" {
return defaultLogger
}
l := *GetLogger("default")
l.category = name
loggerMap[name] = &l
return &l
}
mu.RUnlock()
logConfig, ok := loggerConfig.Categories[name]
if !ok {
logConfig = loggerConfig.Categories["default"]
}
l := makeLogger(name, logConfig)
l.category = name
mu.Lock()
loggerMap[name] = l
mu.Unlock()
return l
}
func makeLogger(name string, config LogConfig) *Logger {
@ -121,7 +151,7 @@ func makeLogger(name string, config LogConfig) *Logger {
levelstr := strings.ToLower(config.Level)
logger.level = logLevelMap[levelstr]
if config.Appenders == nil || len(config.Appenders) == 0 {
if len(config.Appenders) == 0 {
logger.appenders = []*LoggerAppender{&consoleAppender}
} else {
logger.appenders = make([]*LoggerAppender, len(config.Appenders))
@ -132,22 +162,57 @@ func makeLogger(name string, config LogConfig) *Logger {
loggerMap[name] = logger
return logger
}
func Configure(config LoggersConfig) {
func ReconfigLoggers(config LoggersConfig) {
validateConfig(config)
mu.Lock()
defer mu.Unlock()
loggerConfig = config
for name, appenderConfig := range loggerConfig.Appenders {
appenderFactory, ok := appenderFactoryMap[appenderConfig.Type]
if ok {
if oldappender, ok := appenders[name]; ok {
(*oldappender).Close()
}
if appenderFactory, ok := appenderFactoryMap[appenderConfig.Type]; ok {
appenders[name] = appenderFactory(appenderConfig)
} else {
appenders[name] = &consoleAppender
}
}
for name, _ := range loggerConfig.Categories {
GetLogger(name)
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")
}
}
func Configure(config LoggersConfig) {
validateConfig(config)
ReconfigLoggers(config)
}
func RegistAppender(typeName string, appenderCreatCb func(LogAppenderConfig) *LoggerAppender) {
appenderFactoryMap[typeName] = appenderCreatCb
}
func init() {
loggerMap["default"] = defaultLogger
appenders["console"] = &consoleAppender
}

View File

@ -10,7 +10,30 @@ func TestGetLogger(t *testing.T) {
if dl != defaultLogger {
t.Errorf("GetLogger(\"defult\") should return defaultLogger")
}
dl.Error("test")
Configure(LoggersConfig{
Appenders: map[string]LogAppenderConfig{
"console": {
Type: "console",
Formatter: "json",
Options: map[string]interface{}{},
},
},
Categories: map[string]LogConfig{
"default": {
Level: "info",
Appenders: []string{"console"},
},
"app": {
Level: "debug",
Appenders: []string{"console"},
},
},
})
dl.Info("test")
if dl.level != Info {
t.Errorf("GetLogger(\"default\") should return defaultLogger")
}
al := GetLogger("app")
if al == dl {

View File

@ -1,7 +1,7 @@
package main
import (
logger "git.pyer.club/kingecg/gologger"
logger "git.kingecg.top/kingecg/gologger"
)
func aqmain() {