feat: expose env var GHFS_LOG_QUEUE_SIZE to config log queue size

Author: marjune163

README.md

@@ -347,16 +347,21 @@ ghfs [options]
 
 ## Environment variables
 
+### GHFS_CPU_PROFILE_FILE
+Generate Go's CPU pprof profile to specific file path.
+
 ### GHFS_PID_FILE
 Specify PID file path. PID will be written into the file on application startup.
 
+### GHFS_LOG_QUEUE_SIZE
+Specify the size of queue to hold logs that have not been written to destination.
+If it is full, sending logs will be blocked until the queue has free space.
+Defaults to 256.
+
 ### GHFS_QUIET
 To prevent outputting additional information on console, like accessible URLs, etc,
 set value to "1".
 
-### GHFS_CPU_PROFILE_FILE
-Generate Go's CPU pprof profile to specific file path.
-
 ## Shortcut key for default theme
 - `←`, `→`: move focus between path items
 - `Ctrl`/`Opt` + `←`: move focus to first path item

README.zh-CN.md

@@ -337,15 +337,20 @@ ghfs [选项]
 
 ## 环境变量
 
+### GHFS_CPU_PROFILE_FILE
+生成Go的CPU pprof profile到指定的文件路径。
+
 ### GHFS_PID_FILE
 指定进程ID文件路径。进程ID会在应用启动时被写入文件。
 
+### GHFS_LOG_QUEUE_SIZE
+指定日志队列的长度，用于临时保存暂未写入目的地的日志。
+如果队列满，日志发送将被阻塞，直到队列有空余空间。
+默认值为256。
+
 ### GHFS_QUIET
 为避免在控制台输出额外信息，例如可访问的URL等，可将值设为“1”。
 
-### GHFS_CPU_PROFILE_FILE
-生成Go的CPU pprof profile到指定的文件路径。
-
 ## 默认主题的快捷键
 - `←`, `→`：使焦点在路径项之间移动
 - `Ctrl`/`Opt` + `←`：把焦点移动到第一个路径项

src/main.go

@@ -5,10 +5,12 @@ import (
 	"mjpclab.dev/ghfs/src/app"
 	"mjpclab.dev/ghfs/src/param"
 	"mjpclab.dev/ghfs/src/serverError"
+	"mjpclab.dev/ghfs/src/serverLog"
 	"mjpclab.dev/ghfs/src/setting"
 	"mjpclab.dev/ghfs/src/version"
 	"os"
 	"os/signal"
+	"strconv"
 	"syscall"
 )
 
@@ -69,6 +71,14 @@ func Main() (ok bool) {
 		defer StopCPUProfile(cpuProfileFile)
 	}
 
+	// log queue size
+	if len(settings.LogQueueSize) > 0 {
+		logQueueSize, err := strconv.Atoi(settings.LogQueueSize)
+		if err == nil && logQueueSize > 0 {
+			serverLog.SetLogQueueSize(logQueueSize)
+		}
+	}
+
 	// app
 	appInst, errs := app.NewApp(params, settings)
 	if serverError.CheckError(errs...) {

src/serverLog/buffer.go

@@ -5,9 +5,14 @@ import (
 	"time"
 )
 
-const chanBuffer = 128
 const logEnding = '\n'
 
+var logQueueSize = 256
+
+func SetLogQueueSize(size int) {
+	logQueueSize = size
+}
+
 func NewBuffer(cap int) []byte {
 	// prefix: 20 bytes, suffix '\n' 1 byte
 	buf := make([]byte, 0, 21+cap)

src/serverLog/fileDest.go

@@ -12,7 +12,7 @@ type fileDest struct {
 }
 
 func newFileDest(fsPath string, file *os.File, info os.FileInfo) *fileDest {
-	ch := make(chan []byte, chanBuffer)
+	ch := make(chan []byte, logQueueSize)
 
 	dest := &fileDest{
 		fsPath: fsPath,

src/serverLog/writerDest.go

@@ -11,7 +11,7 @@ type writerDest struct {
 }
 
 func newWriterDest(w io.Writer) *writerDest {
-	ch := make(chan []byte, chanBuffer)
+	ch := make(chan []byte, logQueueSize)
 
 	dest := &writerDest{
 		w:  w,

src/setting/main.go

@@ -8,17 +8,20 @@ import (
 type Setting struct {
 	CPUProfileFile string
 	PidFile        string
+	LogQueueSize   string
 	Quiet          bool
 }
 
 func ParseFromEnv() *Setting {
 	cpuProfileFile := os.Getenv("GHFS_CPU_PROFILE_FILE")
 	pidFile := os.Getenv("GHFS_PID_FILE")
+	logQueueSize := os.Getenv("GHFS_LOG_QUEUE_SIZE")
 	quiet := util.GetBoolEnv("GHFS_QUIET")
 
 	return &Setting{
 		CPUProfileFile: cpuProfileFile,
 		PidFile:        pidFile,
+		LogQueueSize:   logQueueSize,
 		Quiet:          quiet,
 	}
 }