生产部署整改阶段检查点
This commit is contained in:
1 parent
f3348cf95d
commit
92d4b3d398
56 files changed
+4178
-240
No files matched your search
@@ -4,35 +4,26 @@ import (
|
||||
"io"
|
||||
"log/slog"
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
type Logger struct {
|
||||
*slog.Logger
|
||||
file *os.File
|
||||
closer io.Closer
|
||||
}
|
||||
|
||||
func New(logDir string, level slog.Level) (*Logger, error) {
|
||||
if err := os.MkdirAll(logDir, 0o750); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
path := filepath.Join(logDir, "scert.log")
|
||||
file, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o600)
|
||||
fileWriter, err := newDailyFileWriter(logDir)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := file.Chmod(0o600); err != nil {
|
||||
_ = file.Close()
|
||||
return nil, err
|
||||
}
|
||||
writer := io.MultiWriter(os.Stdout, file)
|
||||
writer := io.MultiWriter(os.Stdout, fileWriter)
|
||||
handler := slog.NewJSONHandler(writer, &slog.HandlerOptions{Level: level})
|
||||
return &Logger{Logger: slog.New(handler), file: file}, nil
|
||||
return &Logger{Logger: slog.New(handler), closer: fileWriter}, nil
|
||||
}
|
||||
|
||||
func (l *Logger) Close() error {
|
||||
if l == nil || l.file == nil {
|
||||
if l == nil || l.closer == nil {
|
||||
return nil
|
||||
}
|
||||
return l.file.Close()
|
||||
return l.closer.Close()
|
||||
}
|
||||
@@ -5,8 +5,10 @@ import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestLoggerWritesJSONAndUsesRestrictedPermissions(t *testing.T) {
|
||||
@@ -38,3 +40,110 @@ func TestLoggerWritesJSONAndUsesRestrictedPermissions(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestDailyFileWriterRotatesCapsAndRemovesExpiredLogs(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
now := time.Date(2026, 8, 31, 8, 0, 0, 0, time.Local)
|
||||
oldPath := filepath.Join(directory, "scert-20260701.log")
|
||||
if err := os.WriteFile(oldPath, []byte("old"), 0o600); err != nil {
|
||||
t.Fatalf("写入过期日志失败:%v", err)
|
||||
}
|
||||
oldTime := now.AddDate(0, 0, -60)
|
||||
if err := os.Chtimes(oldPath, oldTime, oldTime); err != nil {
|
||||
t.Fatalf("设置过期日志时间失败:%v", err)
|
||||
}
|
||||
|
||||
writer, err := newDailyFileWriterWithOptions(directory, 32, 30, func() time.Time { return now })
|
||||
if err != nil {
|
||||
t.Fatalf("初始化日志轮转器失败:%v", err)
|
||||
}
|
||||
if _, err := writer.Write([]byte("first-day-entry\n")); err != nil {
|
||||
t.Fatalf("写入首日日志失败:%v", err)
|
||||
}
|
||||
if _, err := os.Stat(oldPath); !os.IsNotExist(err) {
|
||||
t.Fatalf("过期日志未被清理:%v", err)
|
||||
}
|
||||
|
||||
now = now.Add(24 * time.Hour)
|
||||
if _, err := writer.Write([]byte("second-day-entry\n")); err != nil {
|
||||
t.Fatalf("写入次日日志失败:%v", err)
|
||||
}
|
||||
rotatedPath := filepath.Join(directory, "scert-20260831.log")
|
||||
if data, err := os.ReadFile(rotatedPath); err != nil || !strings.Contains(string(data), "first-day-entry") {
|
||||
t.Fatalf("首日日志未正确轮转:data=%q err=%v", data, err)
|
||||
}
|
||||
|
||||
activePath := filepath.Join(directory, "scert.log")
|
||||
before, err := os.Stat(activePath)
|
||||
if err != nil {
|
||||
t.Fatalf("读取活动日志状态失败:%v", err)
|
||||
}
|
||||
large := strings.Repeat("x", 64)
|
||||
if written, err := writer.Write([]byte(large)); err != nil || written != len(large) {
|
||||
t.Fatalf("超过容量的日志写入结果不正确:written=%d err=%v", written, err)
|
||||
}
|
||||
after, err := os.Stat(activePath)
|
||||
if err != nil {
|
||||
t.Fatalf("再次读取活动日志状态失败:%v", err)
|
||||
}
|
||||
if before.Size() != after.Size() || after.Size() > 32 {
|
||||
t.Fatalf("活动日志超过每日容量上限:before=%s after=%s", strconv.FormatInt(before.Size(), 10), strconv.FormatInt(after.Size(), 10))
|
||||
}
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("关闭日志轮转器失败:%v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDailyFileWriterRejectsSymlink(t *testing.T) {
|
||||
if runtime.GOOS == "windows" {
|
||||
t.Skip("Windows 普通用户环境通常无法创建符号链接")
|
||||
}
|
||||
directory := t.TempDir()
|
||||
target := filepath.Join(directory, "target.log")
|
||||
if err := os.WriteFile(target, []byte("target"), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.Symlink(target, filepath.Join(directory, "scert.log")); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := newDailyFileWriter(directory); err == nil {
|
||||
t.Fatal("活动日志是符号链接时应拒绝启动")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDailyFileWriterKeepsDailyCapAfterRestart(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
now := time.Date(2026, 8, 31, 8, 0, 0, 0, time.Local)
|
||||
writer, err := newDailyFileWriterWithOptions(directory, 16, 30, func() time.Time { return now })
|
||||
if err != nil {
|
||||
t.Fatalf("初始化日志轮转器失败:%v", err)
|
||||
}
|
||||
if _, err := writer.Write([]byte("1234567890123456")); err != nil {
|
||||
t.Fatalf("写满每日日志容量失败:%v", err)
|
||||
}
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("关闭日志轮转器失败:%v", err)
|
||||
}
|
||||
|
||||
restarted, err := newDailyFileWriterWithOptions(directory, 16, 30, func() time.Time { return now })
|
||||
if err != nil {
|
||||
t.Fatalf("重启日志轮转器失败:%v", err)
|
||||
}
|
||||
if _, err := restarted.Write([]byte("should-not-be-written")); err != nil {
|
||||
t.Fatalf("容量用尽后写入结果错误:%v", err)
|
||||
}
|
||||
if err := restarted.Close(); err != nil {
|
||||
t.Fatalf("再次关闭日志轮转器失败:%v", err)
|
||||
}
|
||||
|
||||
info, err := os.Stat(filepath.Join(directory, "scert.log"))
|
||||
if err != nil {
|
||||
t.Fatalf("读取活动日志状态失败:%v", err)
|
||||
}
|
||||
if info.Size() != 16 {
|
||||
t.Fatalf("服务重启后每日日志容量被绕过:%d", info.Size())
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join(directory, "scert-20260831.log")); !os.IsNotExist(err) {
|
||||
t.Fatalf("同日重启不应轮转活动日志:%v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,217 @@
|
||||
package logging
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
defaultMaxDailyBytes int64 = 5 * 1024 * 1024
|
||||
defaultRetentionDays = 30
|
||||
)
|
||||
|
||||
var archivedLogPattern = regexp.MustCompile(`^scert-[0-9]{8}(?:-[0-9]{2})?\.log$`)
|
||||
|
||||
type dailyFileWriter struct {
|
||||
mu sync.Mutex
|
||||
directory string
|
||||
activePath string
|
||||
file *os.File
|
||||
day string
|
||||
size int64
|
||||
maxDailyBytes int64
|
||||
retentionDays int
|
||||
now func() time.Time
|
||||
}
|
||||
|
||||
func newDailyFileWriter(directory string) (*dailyFileWriter, error) {
|
||||
return newDailyFileWriterWithOptions(directory, defaultMaxDailyBytes, defaultRetentionDays, time.Now)
|
||||
}
|
||||
|
||||
func newDailyFileWriterWithOptions(directory string, maxDailyBytes int64, retentionDays int, now func() time.Time) (*dailyFileWriter, error) {
|
||||
if maxDailyBytes < 1 {
|
||||
return nil, errors.New("日志每日容量上限必须大于 0")
|
||||
}
|
||||
if retentionDays < 1 {
|
||||
return nil, errors.New("日志保留天数必须大于 0")
|
||||
}
|
||||
if now == nil {
|
||||
now = time.Now
|
||||
}
|
||||
if err := os.MkdirAll(directory, 0o750); err != nil {
|
||||
return nil, fmt.Errorf("创建日志目录失败:%w", err)
|
||||
}
|
||||
if err := os.Chmod(directory, 0o750); err != nil {
|
||||
return nil, fmt.Errorf("设置日志目录权限失败:%w", err)
|
||||
}
|
||||
writer := &dailyFileWriter{
|
||||
directory: directory,
|
||||
activePath: filepath.Join(directory, "scert.log"),
|
||||
maxDailyBytes: maxDailyBytes,
|
||||
retentionDays: retentionDays,
|
||||
now: now,
|
||||
}
|
||||
if err := writer.open(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := writer.cleanupExpired(); err != nil {
|
||||
_ = writer.Close()
|
||||
return nil, err
|
||||
}
|
||||
return writer, nil
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) Write(value []byte) (int, error) {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
|
||||
currentDay := logDay(w.now())
|
||||
if currentDay != w.day {
|
||||
if err := w.rotateLocked(w.day); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
if err := w.openLocked(currentDay); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
if err := w.cleanupExpiredLocked(); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
}
|
||||
if int64(len(value)) > w.maxDailyBytes-w.size {
|
||||
return len(value), nil
|
||||
}
|
||||
written, err := w.file.Write(value)
|
||||
w.size += int64(written)
|
||||
return written, err
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) Close() error {
|
||||
if w == nil {
|
||||
return nil
|
||||
}
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
if w.file == nil {
|
||||
return nil
|
||||
}
|
||||
err := errors.Join(w.file.Sync(), w.file.Close())
|
||||
w.file = nil
|
||||
return err
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) open() error {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
currentDay := logDay(w.now())
|
||||
if info, err := os.Lstat(w.activePath); err == nil {
|
||||
if info.Mode()&os.ModeSymlink != 0 || !info.Mode().IsRegular() {
|
||||
return errors.New("活动日志路径必须是普通文件,不能使用符号链接")
|
||||
}
|
||||
fileDay := info.ModTime().Local().Format("20060102")
|
||||
if fileDay != currentDay {
|
||||
if err := w.rotateExistingLocked(fileDay); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
} else if !errors.Is(err, os.ErrNotExist) {
|
||||
return fmt.Errorf("检查活动日志失败:%w", err)
|
||||
}
|
||||
return w.openLocked(currentDay)
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) openLocked(day string) error {
|
||||
file, err := os.OpenFile(w.activePath, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o600)
|
||||
if err != nil {
|
||||
return fmt.Errorf("打开活动日志失败:%w", err)
|
||||
}
|
||||
if err := file.Chmod(0o600); err != nil {
|
||||
_ = file.Close()
|
||||
return fmt.Errorf("设置活动日志权限失败:%w", err)
|
||||
}
|
||||
info, err := file.Stat()
|
||||
if err != nil {
|
||||
_ = file.Close()
|
||||
return fmt.Errorf("读取活动日志状态失败:%w", err)
|
||||
}
|
||||
w.file = file
|
||||
w.day = day
|
||||
w.size = info.Size()
|
||||
return nil
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) rotateLocked(day string) error {
|
||||
if w.file != nil {
|
||||
if err := errors.Join(w.file.Sync(), w.file.Close()); err != nil {
|
||||
return fmt.Errorf("关闭活动日志失败:%w", err)
|
||||
}
|
||||
w.file = nil
|
||||
}
|
||||
return w.rotateExistingLocked(day)
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) rotateExistingLocked(day string) error {
|
||||
if _, err := os.Lstat(w.activePath); errors.Is(err, os.ErrNotExist) {
|
||||
return nil
|
||||
} else if err != nil {
|
||||
return fmt.Errorf("检查待轮转日志失败:%w", err)
|
||||
}
|
||||
if day == "" {
|
||||
day = logDay(w.now())
|
||||
}
|
||||
for index := 0; index < 100; index++ {
|
||||
name := fmt.Sprintf("scert-%s.log", day)
|
||||
if index > 0 {
|
||||
name = fmt.Sprintf("scert-%s-%02d.log", day, index)
|
||||
}
|
||||
destination := filepath.Join(w.directory, name)
|
||||
if _, err := os.Lstat(destination); errors.Is(err, os.ErrNotExist) {
|
||||
if err := os.Rename(w.activePath, destination); err != nil {
|
||||
return fmt.Errorf("轮转活动日志失败:%w", err)
|
||||
}
|
||||
return nil
|
||||
} else if err != nil {
|
||||
return fmt.Errorf("检查轮转日志失败:%w", err)
|
||||
}
|
||||
}
|
||||
return errors.New("同一天的日志轮转文件数量已达到上限")
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) cleanupExpired() error {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
return w.cleanupExpiredLocked()
|
||||
}
|
||||
|
||||
func (w *dailyFileWriter) cleanupExpiredLocked() error {
|
||||
entries, err := os.ReadDir(w.directory)
|
||||
if err != nil {
|
||||
return fmt.Errorf("读取日志目录失败:%w", err)
|
||||
}
|
||||
cutoff := w.now().AddDate(0, 0, -w.retentionDays)
|
||||
for _, entry := range entries {
|
||||
if !archivedLogPattern.MatchString(entry.Name()) {
|
||||
continue
|
||||
}
|
||||
info, err := entry.Info()
|
||||
if err != nil {
|
||||
return fmt.Errorf("读取历史日志状态失败:%w", err)
|
||||
}
|
||||
if info.Mode()&os.ModeSymlink != 0 || !info.Mode().IsRegular() || !info.ModTime().Before(cutoff) {
|
||||
continue
|
||||
}
|
||||
if err := os.Remove(filepath.Join(w.directory, entry.Name())); err != nil && !errors.Is(err, fs.ErrNotExist) {
|
||||
return fmt.Errorf("删除过期日志失败:%w", err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func logDay(value time.Time) string {
|
||||
return value.Local().Format("20060102")
|
||||
}
|
||||
Reference in new issue
Block a user