mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2025-10-14 03:59:13 +00:00
Compare commits
1 commit
6d8589d7b5
...
f7f54086f6
Author | SHA1 | Date | |
---|---|---|---|
![]() |
f7f54086f6 |
2 changed files with 29 additions and 101 deletions
128
logger/logger.go
128
logger/logger.go
|
@ -1,29 +1,21 @@
|
||||||
// Package logger provides logging functionality for the 3x-ui panel with
|
// Package logger provides logging functionality for the 3x-ui panel with
|
||||||
// dual-backend logging (console/syslog and file) and buffered log storage for web UI.
|
// buffered log storage and multiple log levels.
|
||||||
package logger
|
package logger
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
|
||||||
"runtime"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/mhsanaei/3x-ui/v2/config"
|
|
||||||
"github.com/op/go-logging"
|
"github.com/op/go-logging"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
maxLogBufferSize = 10240 // Maximum log entries kept in memory
|
|
||||||
logFileName = "3xui.log" // Log file name
|
|
||||||
timeFormat = "2006/01/02 15:04:05" // Log timestamp format
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
var (
|
||||||
logger *logging.Logger
|
logger *logging.Logger
|
||||||
logFile *os.File
|
|
||||||
|
|
||||||
// logBuffer maintains recent log entries in memory for web UI retrieval
|
// addToBuffer appends a log entry into the in-memory ring buffer used for
|
||||||
|
// retrieving recent logs via the web UI. It keeps the buffer bounded to avoid
|
||||||
|
// uncontrolled growth.
|
||||||
logBuffer []struct {
|
logBuffer []struct {
|
||||||
time string
|
time string
|
||||||
level logging.Level
|
level logging.Level
|
||||||
|
@ -31,98 +23,35 @@ var (
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
// InitLogger initializes dual logging backends: console/syslog and file.
|
func init() {
|
||||||
// Console logging uses the specified level, file logging always uses DEBUG level.
|
InitLogger(logging.INFO)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InitLogger initializes the logger with the specified logging level.
|
||||||
func InitLogger(level logging.Level) {
|
func InitLogger(level logging.Level) {
|
||||||
newLogger := logging.MustGetLogger("x-ui")
|
newLogger := logging.MustGetLogger("x-ui")
|
||||||
backends := make([]logging.Backend, 0, 2)
|
var err error
|
||||||
|
|
||||||
// Console/syslog backend with configurable level
|
|
||||||
if consoleBackend := initDefaultBackend(); consoleBackend != nil {
|
|
||||||
leveledBackend := logging.AddModuleLevel(consoleBackend)
|
|
||||||
leveledBackend.SetLevel(level, "x-ui")
|
|
||||||
backends = append(backends, leveledBackend)
|
|
||||||
}
|
|
||||||
|
|
||||||
// File backend with DEBUG level for comprehensive logging
|
|
||||||
if fileBackend := initFileBackend(); fileBackend != nil {
|
|
||||||
leveledBackend := logging.AddModuleLevel(fileBackend)
|
|
||||||
leveledBackend.SetLevel(logging.DEBUG, "x-ui")
|
|
||||||
backends = append(backends, leveledBackend)
|
|
||||||
}
|
|
||||||
|
|
||||||
multiBackend := logging.MultiLogger(backends...)
|
|
||||||
newLogger.SetBackend(multiBackend)
|
|
||||||
logger = newLogger
|
|
||||||
}
|
|
||||||
|
|
||||||
// initDefaultBackend creates the console/syslog logging backend.
|
|
||||||
// Windows: Uses stderr directly (no syslog support)
|
|
||||||
// Unix-like: Attempts syslog, falls back to stderr
|
|
||||||
func initDefaultBackend() logging.Backend {
|
|
||||||
var backend logging.Backend
|
var backend logging.Backend
|
||||||
includeTime := false
|
var format logging.Formatter
|
||||||
|
ppid := os.Getppid()
|
||||||
|
|
||||||
if runtime.GOOS == "windows" {
|
backend, err = logging.NewSyslogBackend("")
|
||||||
// Windows: Use stderr directly (no syslog support)
|
|
||||||
backend = logging.NewLogBackend(os.Stderr, "", 0)
|
|
||||||
includeTime = true
|
|
||||||
} else {
|
|
||||||
// Unix-like: Try syslog, fallback to stderr
|
|
||||||
if syslogBackend, err := logging.NewSyslogBackend(""); err != nil {
|
|
||||||
fmt.Fprintf(os.Stderr, "syslog backend disabled: %v\n", err)
|
|
||||||
backend = logging.NewLogBackend(os.Stderr, "", 0)
|
|
||||||
includeTime = os.Getppid() > 0
|
|
||||||
} else {
|
|
||||||
backend = syslogBackend
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return logging.NewBackendFormatter(backend, newFormatter(includeTime))
|
|
||||||
}
|
|
||||||
|
|
||||||
// initFileBackend creates the file logging backend.
|
|
||||||
// Creates log directory and truncates log file on startup for fresh logs.
|
|
||||||
func initFileBackend() logging.Backend {
|
|
||||||
logDir := config.GetLogFolder()
|
|
||||||
if err := os.MkdirAll(logDir, 0o750); err != nil {
|
|
||||||
fmt.Fprintf(os.Stderr, "failed to create log folder %s: %v\n", logDir, err)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
logPath := filepath.Join(logDir, logFileName)
|
|
||||||
file, err := os.OpenFile(logPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0o660)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(os.Stderr, "failed to open log file %s: %v\n", logPath, err)
|
println(err)
|
||||||
return nil
|
backend = logging.NewLogBackend(os.Stderr, "", 0)
|
||||||
|
}
|
||||||
|
if ppid > 0 && err != nil {
|
||||||
|
format = logging.MustStringFormatter(`%{time:2006/01/02 15:04:05} %{level} - %{message}`)
|
||||||
|
} else {
|
||||||
|
format = logging.MustStringFormatter(`%{level} - %{message}`)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Close previous log file if exists
|
backendFormatter := logging.NewBackendFormatter(backend, format)
|
||||||
if logFile != nil {
|
backendLeveled := logging.AddModuleLevel(backendFormatter)
|
||||||
_ = logFile.Close()
|
backendLeveled.SetLevel(level, "x-ui")
|
||||||
}
|
newLogger.SetBackend(backendLeveled)
|
||||||
logFile = file
|
|
||||||
|
|
||||||
backend := logging.NewLogBackend(file, "", 0)
|
logger = newLogger
|
||||||
return logging.NewBackendFormatter(backend, newFormatter(true))
|
|
||||||
}
|
|
||||||
|
|
||||||
// newFormatter creates a log formatter with optional timestamp.
|
|
||||||
func newFormatter(withTime bool) logging.Formatter {
|
|
||||||
format := `%{level} - %{message}`
|
|
||||||
if withTime {
|
|
||||||
format = `%{time:` + timeFormat + `} %{level} - %{message}`
|
|
||||||
}
|
|
||||||
return logging.MustStringFormatter(format)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CloseLogger closes the log file and cleans up resources.
|
|
||||||
// Should be called during application shutdown.
|
|
||||||
func CloseLogger() {
|
|
||||||
if logFile != nil {
|
|
||||||
_ = logFile.Close()
|
|
||||||
logFile = nil
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Debug logs a debug message and adds it to the log buffer.
|
// Debug logs a debug message and adds it to the log buffer.
|
||||||
|
@ -185,10 +114,9 @@ func Errorf(format string, args ...any) {
|
||||||
addToBuffer("ERROR", fmt.Sprintf(format, args...))
|
addToBuffer("ERROR", fmt.Sprintf(format, args...))
|
||||||
}
|
}
|
||||||
|
|
||||||
// addToBuffer adds a log entry to the in-memory ring buffer for web UI retrieval.
|
|
||||||
func addToBuffer(level string, newLog string) {
|
func addToBuffer(level string, newLog string) {
|
||||||
t := time.Now()
|
t := time.Now()
|
||||||
if len(logBuffer) >= maxLogBufferSize {
|
if len(logBuffer) >= 10240 {
|
||||||
logBuffer = logBuffer[1:]
|
logBuffer = logBuffer[1:]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -198,7 +126,7 @@ func addToBuffer(level string, newLog string) {
|
||||||
level logging.Level
|
level logging.Level
|
||||||
log string
|
log string
|
||||||
}{
|
}{
|
||||||
time: t.Format(timeFormat),
|
time: t.Format("2006/01/02 15:04:05"),
|
||||||
level: logLevel,
|
level: logLevel,
|
||||||
log: newLog,
|
log: newLog,
|
||||||
})
|
})
|
||||||
|
|
|
@ -103,7 +103,7 @@ func (s *Server) initRouter() (*gin.Engine, error) {
|
||||||
if basePath != "/" && !strings.HasSuffix(basePath, "/") {
|
if basePath != "/" && !strings.HasSuffix(basePath, "/") {
|
||||||
basePath += "/"
|
basePath += "/"
|
||||||
}
|
}
|
||||||
// logger.Debug("sub: Setting base_path to:", basePath)
|
logger.Debug("sub: Setting base_path to:", basePath)
|
||||||
engine.Use(func(c *gin.Context) {
|
engine.Use(func(c *gin.Context) {
|
||||||
c.Set("base_path", basePath)
|
c.Set("base_path", basePath)
|
||||||
})
|
})
|
||||||
|
|
Loading…
Reference in a new issue