Support split log file by date

Author: mstmdev

file_logger.go

@@ -25,6 +25,7 @@ var (
 	mkdirAll    = os.MkdirAll
 	create      = os.Create
 	openFile    = os.OpenFile
+	now         = time.Now
 )
 
 type fileLogger struct {
@@ -38,6 +39,7 @@ type fileLogger struct {
 	close       chan struct{} // the log is closed, and wait to write all the logs
 	mu          sync.Mutex    // avoid data race for writer
 	date        time.Time
+	file        *os.File
 }
 
 type logMsg struct {
@@ -89,30 +91,32 @@ func (l *fileLogger) Close() error {
 }
 
 func (l *fileLogger) init() error {
-	if err := l.initFile(); err != nil {
+	if err := l.initFile(true); err != nil {
 		return err
 	}
 	l.start()
 	l.startAutoFlush()
 	return nil
 }
 
-func (l *fileLogger) initFile() error {
-	now := time.Now()
+func (l *fileLogger) initFile(splitDate bool) error {
+	if !splitDate {
+		return nil
+	}
+	date := now()
 	timeFormat := "20060102"
-	if l.date.Format(timeFormat) == now.Format(timeFormat) {
+	if l.date.Format(timeFormat) == date.Format(timeFormat) {
 		return nil
 	}
 	// reset initialized
 	l.initialized = false
-	l.date = now
 
 	logDir := filepath.Clean(l.opt.LogDir)
 	prefix := strings.TrimSpace(l.opt.FilePrefix)
 	if len(prefix) > 0 {
 		prefix = filepath.Clean(prefix)
 	}
-	logFile := logDir + "/" + prefix + l.date.Format(timeFormat) + ".log"
+	logFile := logDir + "/" + prefix + date.Format(timeFormat) + ".log"
 
 	_, err := stat(logDir)
 	if isNotExist(err) {
@@ -135,8 +139,21 @@ func (l *fileLogger) initFile() error {
 		l.innerLog("init file logger err, can't open the log file. %s", err)
 		return err
 	}
+
+	if l.writer != nil {
+		l.writer.Flush()
+	}
+
 	l.writer = newWriter(f)
 	l.initialized = true
+	l.date = date
+
+	if l.file != nil {
+		if err = l.file.Close(); err != nil {
+			l.innerLog("close file error => %s %v", l.file.Name(), err)
+		}
+	}
+	l.file = f
 	return nil
 }
 
@@ -157,6 +174,7 @@ func (l *fileLogger) write() {
 	if msg.closed {
 		if l.initialized && l.writer != nil {
 			l.writer.Flush()
+			l.file.Close()
 		}
 		l.close <- struct{}{}
 	} else if msg.flush && l.initialized && l.writer != nil && l.writer.Buffered() > 0 {
@@ -165,6 +183,10 @@ func (l *fileLogger) write() {
 			l.innerLog("file logger flush log error. %s", err)
 		}
 	} else if l.initialized && l.writer != nil && len(msg.log) > 0 {
+		if err := l.initFile(l.opt.SplitDate); err != nil {
+			l.innerLog("init log file error. %s", err)
+			return
+		}
 		if _, err := l.writer.Write(msg.log); err != nil {
 			l.innerLog("file logger write log error. %s", err)
 		}
@@ -187,7 +209,7 @@ func (l *fileLogger) startAutoFlush() {
 		delayCheckCount := 10
 		for {
 			<-time.After(wait)
-			if l.closed.Get() || l.writer == nil {
+			if l.closed.Get() {
 				return
 			}
 			l.mu.Lock()
@@ -217,7 +239,7 @@ func (l *fileLogger) Write(p []byte) (n int, err error) {
 	}
 	cp := make([]byte, pLen)
 	copy(cp, p)
-	if l.initialized && !l.closed.Get() {
+	if !l.closed.Get() {
 		l.in <- logMsg{
 			log:    cp,
 			closed: false,

file_logger_mock_test.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/no-src/log/level"
+	"github.com/no-src/log/option"
 )
 
 func TestFileLogger_WithNotExistFile(t *testing.T) {
@@ -96,6 +97,42 @@ func TestFileLogger_WithAutoFlushWithWriteErrorAndNoAutoFlush(t *testing.T) {
 	<-time.After(wait + time.Second)
 }
 
+func TestFileLogger_WithMultiInitFile(t *testing.T) {
+	defer func() {
+		initTimeMock()
+	}()
+	fLogger, err := NewFileLogger(level.DebugLevel, "./multi_init_file_logs", "ns")
+	if err != nil {
+		t.Fatal(err)
+	}
+	now = nowMock
+	fLogger.(*fileLogger).initFile(true)
+	InitDefaultLogger(fLogger)
+	defer Close()
+}
+
+func TestFileLogger_WithSplitDateError(t *testing.T) {
+	defer func() {
+		initTimeMock()
+		initOSMock()
+	}()
+	fLogger, err := NewFileLoggerWithOption(option.FileLoggerOption{
+		Level:      level.DebugLevel,
+		LogDir:     "./split_date_logs_error",
+		FilePrefix: "ns",
+		SplitDate:  true,
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	InitDefaultLogger(fLogger)
+	defer Close()
+	isNotExist = isNotExistAlwaysTrueMock
+	mkdirAll = mkdirAllErrorMock
+	now = nowMock
+	testLogs(t)
+}
+
 func init() {
 	initFileLoggerMock()
 }
@@ -131,6 +168,10 @@ func initOSMock() {
 	openFile = openFileMock
 }
 
+func initTimeMock() {
+	now = time.Now
+}
+
 func isNotExistAlwaysFalseMock(err error) bool {
 	return false
 }
@@ -156,9 +197,13 @@ func createErrorMock(name string) (*os.File, error) {
 }
 
 func openFileMock(name string, flag int, perm os.FileMode) (*os.File, error) {
-	return nil, nil
+	return os.Stdout, nil
 }
 
 func openFileErrorMock(name string, flag int, perm os.FileMode) (*os.File, error) {
 	return nil, errors.New("the OpenFile error test")
 }
+
+func nowMock() time.Time {
+	return time.Now().Add(time.Hour * 24)
+}

file_logger_test.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/no-src/log/formatter"
 	"github.com/no-src/log/level"
+	"github.com/no-src/log/option"
 )
 
 func TestFileLogger(t *testing.T) {
@@ -81,12 +82,16 @@ func TestConsoleLoggerAndFileLogger(t *testing.T) {
 	testLogs(t)
 }
 
-func TestFileLogger_WithMultiInitFile(t *testing.T) {
-	fLogger, err := NewFileLogger(level.DebugLevel, "./multi_init_file_logs", "ns")
+func TestFileLogger_WithSplitDate(t *testing.T) {
+	fLogger, err := NewFileLoggerWithOption(option.FileLoggerOption{
+		Level:      level.DebugLevel,
+		LogDir:     "./split_date_logs",
+		FilePrefix: "ns",
+		SplitDate:  true,
+	})
 	if err != nil {
 		t.Fatal(err)
 	}
-	fLogger.(*fileLogger).initFile()
 	InitDefaultLogger(fLogger)
 	defer Close()
 	testLogs(t)

option/file_logger_option.go

@@ -13,4 +13,5 @@ type FileLoggerOption struct {
 	FilePrefix    string
 	AutoFlush     bool
 	FlushInterval time.Duration
+	SplitDate     bool
 }