Merge pull request #11 from flyhope/4-log-write-to-file

log write to file

Author: flyhope

comm/config.go

@@ -5,31 +5,45 @@ import (
 	"gopkg.in/yaml.v3"
 	"os"
 	"path/filepath"
-	"strings"
 	"sync"
 )
 
-// ShowKConfig 获取k.yaml配置
-var ShowKConfig = sync.OnceValue(func() *KConfig {
-	config := &KConfig{
+// ShowKubeteaConfig 获取k.yaml配置
+var ShowKubeteaConfig = sync.OnceValue(func() *KubeteaConfig {
+	config := &KubeteaConfig{
 		ClusterByLabel:   "app",
-		ClusterFilters:   []string{"*"},
 		PodCacheLivetime: 10,
+		Log: KubeteaConfigLog{
+			Dir:          "~/.kubetea/logs",
+			FileTotalMax: 10,
+			Level:        logrus.InfoLevel,
+		},
+		ClusterFilters: []string{"*"},
 	}
 
 	// 文件件在才继续加载配置
-	configFilePath := Context.String("config")
-	if strings.HasPrefix(configFilePath, "~") {
-		homeDir, err := os.UserHomeDir()
-		if err != nil {
-			logrus.Warnln(err)
+	configFilePath := FixPath(Context.String("config"))
+
+	_, errStat := os.Stat(configFilePath)
+	if os.IsNotExist(errStat) {
+		configFileDir := filepath.Dir(configFilePath)
+		if errMkdir := os.MkdirAll(configFileDir, os.ModePerm); errMkdir != nil {
+			logrus.Warnln(errMkdir)
 		} else {
-			configFilePath = filepath.Join(homeDir, configFilePath[1:])
+			// 文件不存在，写入一份默认配置
+			yamlData, err := yaml.Marshal(&config)
+			if err != nil {
+				logrus.Warnln(err)
+			} else {
+				errWrite := os.WriteFile(configFilePath, yamlData, 0664)
+				if errWrite != nil {
+					logrus.WithFields(logrus.Fields{"path": configFilePath}).Warnln(errWrite)
+				}
+			}
 		}
-	}
-	_, errStat := os.Stat(configFilePath)
-	if !os.IsNotExist(errStat) {
-		// 读取YAML文件内容
+
+	} else {
+		// 文件存在，读取YAML文件内容
 		yamlFile, err := os.ReadFile(configFilePath)
 		if err != nil {
 			logrus.WithFields(logrus.Fields{"config": configFilePath}).Fatalf("Failed to read YAML file: %v", err)
@@ -45,8 +59,16 @@ var ShowKConfig = sync.OnceValue(func() *KConfig {
 	return config
 })
 
-type KConfig struct {
-	ClusterByLabel   string   `yaml:"cluster_by_label"`
-	ClusterFilters   []string `yaml:"cluster_filters"`
-	PodCacheLivetime uint32   `yaml:"pod_cache_livetime_second"`
+// KubeteaConfig YAML配置定义
+type KubeteaConfig struct {
+	ClusterByLabel   string           `yaml:"cluster_by_label"`
+	PodCacheLivetime uint32           `yaml:"pod_cache_livetime_second"`
+	Log              KubeteaConfigLog `yaml:"log"`
+	ClusterFilters   []string         `yaml:"cluster_filters"`
+}
+
+type KubeteaConfigLog struct {
+	Dir          string       `yaml:"dir"`
+	FileTotalMax int          `yaml:"file_total_max"`
+	Level        logrus.Level `yaml:"level"`
 }

comm/file.go

@@ -0,0 +1,70 @@
+package comm
+
+import (
+	"fmt"
+	"github.com/sirupsen/logrus"
+	"os"
+	"path/filepath"
+	"sort"
+	"strings"
+	"time"
+)
+
+type FileInfo struct {
+	Name    string
+	ModTime time.Time
+}
+
+// DeleteFilesWhtiKeep 删除一个目录下的文件，保留指定个数
+func DeleteFilesWhtiKeep(directory string, keep int) error {
+	// 读取目录中的所有文件信息
+	entries, err := os.ReadDir(directory)
+	if err != nil {
+		return fmt.Errorf("failed to read directory: %w", err)
+	}
+
+	// 将文件信息存储在一个切片中
+	var fileInfos []FileInfo
+	for _, entry := range entries {
+		if !entry.IsDir() {
+			info, errInfo := entry.Info()
+			if errInfo != nil {
+				return fmt.Errorf("failed to get file info: %w", errInfo)
+			}
+			fileInfos = append(fileInfos, FileInfo{Name: entry.Name(), ModTime: info.ModTime()})
+		}
+	}
+
+	// 如果文件数量小于或等于要保留的数量，则无需删除任何文件
+	if len(fileInfos) <= keep {
+		return nil
+	}
+
+	// 按修改时间升序排序
+	sort.Slice(fileInfos, func(i, j int) bool {
+		return fileInfos[i].ModTime.Before(fileInfos[j].ModTime)
+	})
+
+	// 删除最早的文件，直到只剩下保留的数量
+	for i := 0; i < len(fileInfos)-keep; i++ {
+		errRemove := os.Remove(directory + "/" + fileInfos[i].Name)
+		if errRemove != nil {
+			return fmt.Errorf("failed to delete file %s: %w", fileInfos[i].Name, errRemove)
+		}
+	}
+
+	return nil
+}
+
+// FixPath 修正路径，支持 ~
+func FixPath(configFilePath string) string {
+	if strings.HasPrefix(configFilePath, "~") {
+		homeDir, err := os.UserHomeDir()
+		if err != nil {
+			logrus.Warnln(err)
+		} else {
+			configFilePath = filepath.Join(homeDir, configFilePath[1:])
+		}
+	}
+	return configFilePath
+}

comm/logger.go

@@ -0,0 +1,47 @@
+package comm
+
+import (
+	"fmt"
+	"github.com/sirupsen/logrus"
+	"os"
+	"time"
+)
+
+// LogSetStdout 设置日志输出为标准输出
+func LogSetStdout() {
+	logSetDefault()
+	logrus.SetOutput(os.Stdout)
+}
+
+// LogSetFile 设置日志输出为文件
+func LogSetFile() {
+	logrus.SetLevel(ShowKubeteaConfig().Log.Level)
+
+	// 创建日志目录
+	dir := FixPath(ShowKubeteaConfig().Log.Dir)
+	if err := os.MkdirAll(dir, os.ModePerm); err != nil {
+		logrus.Fatal(err)
+	}
+
+	// 扫描目录，删除超过指定数量的日志文件
+	errDel := DeleteFilesWhtiKeep(dir, ShowKubeteaConfig().Log.FileTotalMax)
+
+	// 打开日志文件
+	logFilePath := fmt.Sprintf("%s/%s.log", dir, time.Now().Format(time.DateOnly))
+	fo, err := os.OpenFile(logFilePath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0664)
+	if err != nil {
+		if errDel != nil {
+			logrus.WithFields(logrus.Fields{"dir": dir}).Errorln(errDel)
+		}
+		logrus.WithFields(logrus.Fields{"dir": dir}).Fatal(err)
+	}
+
+	// 设置日志输出路径
+	logSetDefault()
+	logrus.SetOutput(fo)
+}
+
+// 设置默认的日志配置
+func logSetDefault() {
+	logrus.SetReportCaller(true)
+}

k8s/pods.go

@@ -103,7 +103,7 @@ func (p *podCache) needUpdate() bool {
 
 var PodCache = sync.OnceValue(func() *podCache {
 	c := &podCache{
-		livetime: time.Second * time.Duration(comm.ShowKConfig().PodCacheLivetime),
+		livetime: time.Second * time.Duration(comm.ShowKubeteaConfig().PodCacheLivetime),
 		dataRead: make(chan bool),
 	}
 	return c

kubetea.yaml

@@ -5,6 +5,13 @@ cluster_by_label: app
 # pod cache when x second for update
 pod_cache_livetime_second: 5
 
+log:
+  # log write level: 1 fatal, 2 error, 3 warning, 4 info, 5 debug, 6 trace
+  level: 4
+  dir: "~/.kubetea/log"
+  # max log file count, delete old log file when reach this count
+  file_total_max: 10
+
 # show pod group filter
 cluster_filters:
   - *

main.go

@@ -10,13 +10,13 @@ import (
 
 func main() {
 	// 日志配置
-	logrus.SetReportCaller(true)
+	comm.LogSetStdout()
 
 	// 定义入口
 	app := &cli.App{
 		Name: "kubernetes simple cli ui client",
 		Flags: []cli.Flag{
-			&cli.StringFlag{Name: "config", Aliases: []string{"c"}, Value: "~/.kube/kubetea.yaml", Usage: "(optional) path to the kubetea.yaml config file"},
+			&cli.StringFlag{Name: "config", Aliases: []string{"c"}, Value: "~/.kubetea/config.yaml", Usage: "(optional) path to the kubetea.yaml config file"},
 			&cli.StringFlag{Name: "namespace", Aliases: []string{"n"}},
 			&cli.StringFlag{Name: "context"},
 			&cli.StringFlag{Name: "kubeconfig", Aliases: []string{"k"}, Usage: "(optional) absolute path to the kubeconfig file"},

view/action.go

@@ -1,17 +1,20 @@
 package view
 
 import (
+	"github.com/flyhope/kubetea/comm"
 	"github.com/flyhope/kubetea/ui"
 	"github.com/urfave/cli/v2"
 )
 
 // Action 主入口
 func Action(c *cli.Context) error {
+	comm.LogSetFile()
+
 	m, err := ShowCluster()
 	if err != nil {
 		return err
 	}
 
 	_, err = ui.RunProgram(m)
-	return err
+	return nil
 }

view/cluster.go

@@ -21,7 +21,7 @@ type clusterModel struct {
 
 // 更新数据
 func (c *clusterModel) updateData(force bool) {
-	config := comm.ShowKConfig()
+	config := comm.ShowKubeteaConfig()
 	groupLabels := make(map[string]int)
 
 	pods, err := k8s.PodCache().ShowList(force)