Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Refactor: default log level to warn (#20001)

Wang Qi7b9b5ba51ec6
diff --git a/cmd/ragflow_server.go b/cmd/ragflow_server.go
index d4f551eb18..14fbd06dd8 100644
--- a/cmd/ragflow_server.go
+++ b/cmd/ragflow_server.go
@@ -81,7 +81,7 @@ type serverArgs struct {
mode *string // admin | api | ingestor | syncer
helpFlag bool
versionFlag bool
- debugLog bool
+ logLevel *string
migrateDB bool
configPath *string // Used by admin, api; user defined config path
initSuperUser bool // Used by admin;
@@ -204,6 +204,12 @@ func parseArgs() (*serverArgs, error) {
arg := os.Args[i]
if key, value, ok := strings.Cut(arg, "="); ok {
switch key {
+ case "--log-level":
+ if err := validateLogLevel(value); err != nil {
+ return nil, err
+ }
+ args.logLevel = &value
+ continue
case "--mcp-host":
args.mcpHost = value
continue
@@ -255,8 +261,16 @@ func parseArgs() (*serverArgs, error) {
args.helpFlag = true
case "-v", "--version":
args.versionFlag = true
- case "--debug":
- args.debugLog = true
+ case "--log-level":
+ if i+1 >= len(os.Args) {
+ return nil, errors.New("--log-level requires a value")
+ }
+ i++
+ level := os.Args[i]
+ if err := validateLogLevel(level); err != nil {
+ return nil, err
+ }
+ args.logLevel = &level
case "-f", "--config":
if i+1 >= len(os.Args) {
return nil, fmt.Errorf("%s requires a value", arg)
@@ -320,6 +334,26 @@ func parseArgs() (*serverArgs, error) {
return args, nil
}
+func validateLogLevel(level string) error {
+ switch level {
+ case "debug", "info", "warn", "error":
+ return nil
+ default:
+ return fmt.Errorf("invalid --log-level %q: must be debug, info, warn, or error", level)
+ }
+}
+
+func selectedLogLevel(args *serverArgs, configured string) string {
+ level := configured
+ if level == "" {
+ level = "warn"
+ }
+ if args.logLevel != nil {
+ level = *args.logLevel
+ }
+ return level
+}
+
func applyMCPEnv(args *serverArgs) error {
if value, ok := os.LookupEnv("RAGFLOW_MCP_HOST"); ok {
args.mcpHost = value
@@ -410,7 +444,7 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, " --name string \tServer name (ingestor and syncer)\n")
fmt.Fprintf(os.Stderr, " --init-superuser\tInitialize superuser account (admin)\n")
fmt.Fprintf(os.Stderr, " -v, --version \tPrint version information and exit\n")
- fmt.Fprintf(os.Stderr, " --debug \tEnable debug-level logging\n")
+ fmt.Fprintf(os.Stderr, " --log-level string\tLog level: debug, info, warn, error (default: warn)\n")
fmt.Fprintf(os.Stderr, " --profile \tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \tShow this help message and exit\n\n")
fmt.Fprintf(os.Stderr, "API MCP options:\n")
@@ -433,7 +467,7 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, " --port int \tServer port (overrides config file)\n")
fmt.Fprintf(os.Stderr, " -f --config string\tPath to configuration file\n")
fmt.Fprintf(os.Stderr, " -v, --version \tPrint version information and exit\n")
- fmt.Fprintf(os.Stderr, " --debug \tEnable debug-level logging\n")
+ fmt.Fprintf(os.Stderr, " --log-level string\tLog level: debug, info, warn, error (default: warn)\n")
fmt.Fprintf(os.Stderr, " --profile \t\tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \tShow this help message and exit\n")
fmt.Fprintf(os.Stderr, "\nMCP options:\n")
@@ -453,7 +487,7 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, " --port int \t\t\tServer port (overrides config file)\n")
fmt.Fprintf(os.Stderr, " --init-superuser\t\t\tInitialize superuser account\n")
fmt.Fprintf(os.Stderr, " -v, --version \t\t\tPrint version information and exit\n")
- fmt.Fprintf(os.Stderr, " --debug \t\t\tEnable debug-level logging\n")
+ fmt.Fprintf(os.Stderr, " --log-level string\t\tLog level: debug, info, warn, error (default: warn)\n")
fmt.Fprintf(os.Stderr, " --profile \t\t\tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \t\t\tShow this help message and exit\n")
case *args.mode == "ingestor":
@@ -464,7 +498,7 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, " --name string\t\t\tIngestion server name (default: \"default_ingestion\")\n")
fmt.Fprintf(os.Stderr, " --admin-host string\tAdmin server host:port (overrides config file)\n")
fmt.Fprintf(os.Stderr, " -v, --version \t\tPrint version information and exit\n")
- fmt.Fprintf(os.Stderr, " --debug \t\tEnable debug-level logging\n")
+ fmt.Fprintf(os.Stderr, " --log-level string\tLog level: debug, info, warn, error (default: warn)\n")
fmt.Fprintf(os.Stderr, " --profile \t\tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \t\tShow this help message and exit\n")
case *args.mode == "syncer":
@@ -475,7 +509,7 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, " --name string\t\t\tSync service server name (default: \"default_syncer\")\n")
fmt.Fprintf(os.Stderr, " --admin-host string\tAdmin server host:port (overrides config file)\n")
fmt.Fprintf(os.Stderr, " -v, --version \t\tPrint version information and exit\n")
- fmt.Fprintf(os.Stderr, " --debug \t\tEnable debug-level logging\n")
+ fmt.Fprintf(os.Stderr, " --log-level string\tLog level: debug, info, warn, error (default: warn)\n")
fmt.Fprintf(os.Stderr, " --profile \t\tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \t\tShow this help message and exit\n")
}
@@ -525,10 +559,7 @@ func main() {
}
logFileName = fmt.Sprintf("%s.log", serverName)
- logLevel := "info"
- if arguments.debugLog {
- logLevel = "debug"
- }
+ logLevel := selectedLogLevel(arguments, "")
// Temporary pre-config logger: STDOUT ONLY (empty FileOutput). The port
// is not known yet, so a file here would be an orphaned log (e.g.
@@ -602,15 +633,8 @@ func main() {
logConfig := globalConfig.GetLogConfig()
- // Reinitialize logger with configured level if different
- logLevel = logConfig.Level
- if logLevel == "" {
- logLevel = "info"
- }
-
- if arguments.debugLog {
- logLevel = "debug"
- }
+ // Reinitialize logger with the configured level and CLI overrides.
+ logLevel = selectedLogLevel(arguments, logConfig.Level)
globalConfig.SetLogLevel(logLevel)
@@ -784,10 +808,7 @@ func runMigrate(ctx context.Context, args *serverArgs) error {
return fmt.Errorf("initialize local variables: %w", err)
}
- logLevel := "info"
- if args.debugLog {
- logLevel = "debug"
- }
+ logLevel := selectedLogLevel(args, "")
if err := common.InitLogger(logLevel, common.FileOutput{Filename: serverName + ".log", Path: "logs"}, serverName); err != nil {
return fmt.Errorf("initialize logger: %w", err)
}
@@ -803,12 +824,7 @@ func runMigrate(ctx context.Context, args *serverArgs) error {
globalConfig := server.GetConfig()
server.SetServerName(serverName)
logConfig := globalConfig.GetLogConfig()
- if logConfig.Level != "" {
- logLevel = logConfig.Level
- }
- if args.debugLog {
- logLevel = "debug"
- }
+ logLevel = selectedLogLevel(args, logConfig.Level)
globalConfig.SetLogLevel(logLevel)
common.SyncLog()
diff --git a/cmd/ragflow_server_test.go b/cmd/ragflow_server_test.go
index a9c1005f4c..ae72f5c407 100644
--- a/cmd/ragflow_server_test.go
+++ b/cmd/ragflow_server_test.go
@@ -289,6 +289,50 @@ func TestParseArgsMigrateIsStandalone(t *testing.T) {
}
}
+func TestParseArgsLogLevel(t *testing.T) {
+ for _, level := range []string{"debug", "info", "warn", "error"} {
+ for _, argv := range [][]string{{"--api", "--log-level", level}, {"--migrate", "--log-level=" + level}} {
+ args, err := parseArgsForTest(t, argv...)
+ if err != nil {
+ t.Fatalf("parseArgs(%v) error = %v", argv, err)
+ }
+ if got := selectedLogLevel(args, "info"); got != level {
+ t.Errorf("selectedLogLevel(%v) = %q, want %q", argv, got, level)
+ }
+ }
+ }
+
+ for _, argv := range [][]string{{"--api", "--log-level"}, {"--api", "--log-level=trace"}, {"--api", "--log-level", "fatal"}} {
+ if _, err := parseArgsForTest(t, argv...); err == nil {
+ t.Errorf("parseArgs(%v) error = nil, want error", argv)
+ }
+ }
+}
+
+func TestSelectedLogLevelPrecedence(t *testing.T) {
+ args, err := parseArgsForTest(t, "--api")
+ if err != nil {
+ t.Fatalf("parseArgs(--api) error = %v", err)
+ }
+ if got := selectedLogLevel(args, ""); got != "warn" {
+ t.Errorf("default log level = %q, want warn", got)
+ }
+ if got := selectedLogLevel(args, "info"); got != "info" {
+ t.Errorf("configured log level = %q, want info", got)
+ }
+
+ args, err = parseArgsForTest(t, "--api", "--log-level", "error")
+ if err != nil {
+ t.Fatalf("parseArgs with --log-level error = %v", err)
+ }
+ if got := selectedLogLevel(args, "info"); got != "error" {
+ t.Errorf("--log-level log level = %q, want error", got)
+ }
+ if _, err := parseArgsForTest(t, "--api", "--debug"); err == nil {
+ t.Error("parseArgs(--debug) error = nil, want unknown parameter error")
+ }
+}
+
func TestParseArgsMigrateRejectsMode(t *testing.T) {
for _, mode := range []string{"--api", "--admin", "--ingestor", "--syncer"} {
if _, err := parseArgsForTest(t, mode, "--migrate"); err == nil {
diff --git a/docker/launch_backend_service.sh b/docker/launch_backend_service.sh
index 5275a10aae..8fa2de7038 100755
--- a/docker/launch_backend_service.sh
+++ b/docker/launch_backend_service.sh
@@ -104,7 +104,7 @@ task_exe(){
task_name="ragflow_server --ingestor"
task_cmd=("bin/ragflow_server" "--ingestor")
if [[ "$DEBUG_MODE" -eq 1 ]]; then
- task_cmd+=("--debug")
+ task_cmd+=("--log-level" "debug")
fi
fi
local retry_count=0
@@ -140,8 +140,10 @@ run_server(){
prepare_for_go
server_name="ragflow_server"
server_cmd=("bin/ragflow_server" "--api")
- fi
- if [[ "$DEBUG_MODE" -eq 1 ]]; then
+ if [[ "$DEBUG_MODE" -eq 1 ]]; then
+ server_cmd+=("--log-level" "debug")
+ fi
+ elif [[ "$DEBUG_MODE" -eq 1 ]]; then
server_cmd+=("--debug")
fi
local retry_count=0
@@ -174,7 +176,7 @@ run_admin_server(){
server_name="admin_server"
server_cmd=("bin/ragflow_server" "--admin")
if [[ "$DEBUG_MODE" -eq 1 ]]; then
- server_cmd+=("--debug")
+ server_cmd+=("--log-level" "debug")
fi
fi
local retry_count=0
@@ -206,7 +208,7 @@ run_data_sync(){
server_name="ragflow_server --syncer"
sync_cmd=("bin/ragflow_server" "--syncer")
if [[ "$DEBUG_MODE" -eq 1 ]]; then
- sync_cmd+=("--debug")
+ sync_cmd+=("--log-level" "debug")
fi
fi
local retry_count=0
diff --git a/internal/server/config/log_config.go b/internal/server/config/log_config.go
index c11997866f..da07b807b9 100644
--- a/internal/server/config/log_config.go
+++ b/internal/server/config/log_config.go
@@ -40,7 +40,7 @@ import (
// defaults (100 MB / 10 files / 30 days) and there is no operator-meaningful
// reason to distinguish "not set" from "0".
type LogConfig struct {
- Level string `mapstructure:"level"` // debug, info, warn, error; default "info"
+ Level string `mapstructure:"level"` // debug, info, warn, error; default "warn"
Format string `mapstructure:"format"` // json, text (reserved for future use); default "json"
Path string `mapstructure:"path"` // per-binary file override; empty = use cmd/* hardcoded default
MaxSize int `mapstructure:"max_size"` // MB before rotation; default 100
@@ -52,7 +52,7 @@ type LogConfig struct {
func (c *Config) ParseLogConfig(v *viper.Viper) error {
// Default Log config. Rotation defaults come from common so they stay
// in sync with the logger's own fallback values.
- c.log.Level = "info"
+ c.log.Level = "warn"
c.log.Format = "json"
c.log.Path = "logs"
c.log.MaxSize = common.DefaultLogMaxSizeMB