Support log to single file and stdout (#724)

bfenetworks · iyangsj · Jun 21, 2021 · Apr 8, 2021 · Apr 9, 2021 · Apr 9, 2021
commit 2b7d38317dfe042432243ef4584079c61ec6036a
diff --git a/bfe_modules/mod_access/conf_mod_access.go b/bfe_modules/mod_access/conf_mod_access.go
@@ -19,22 +19,16 @@ import (
 )
 
 import (
-	"github.com/baidu/go-lib/log/log4go"
 	gcfg "gopkg.in/gcfg.v1"
 )
 
 import (
-	"github.com/bfenetworks/bfe/bfe_util"
+	"github.com/bfenetworks/bfe/bfe_util/access_log"
 )
 
 // ConfModAccess holds the config of access module.
 type ConfModAccess struct {
-	Log struct {
-		LogPrefix   string // log file prefix
-		LogDir      string // log file dir
-		RotateWhen  string // rotate time
-		BackupCount int    // log file backup number
-	}
+	Log access_log.LogConfig
 
 	Template struct {
 		RequestTemplate string // access log formate string
@@ -63,21 +57,9 @@ func ConfLoad(filePath string, confRoot string) (*ConfModAccess, error) {
 }
 
 func (cfg *ConfModAccess) Check(confRoot string) error {
-	if cfg.Log.LogPrefix == "" {
-		return fmt.Errorf("ModAccess.LogPrefix is empty")
-	}
-
-	if cfg.Log.LogDir == "" {
-		return fmt.Errorf("ModAccess.LogDir is empty")
-	}
-	cfg.Log.LogDir = bfe_util.ConfPathProc(cfg.Log.LogDir, confRoot)
-
-	if !log4go.WhenIsValid(cfg.Log.RotateWhen) {
-		return fmt.Errorf("ModAccess.RotateWhen invalid: %s", cfg.Log.RotateWhen)
-	}
-
-	if cfg.Log.BackupCount <= 0 {
-		return fmt.Errorf("ModAccess.BackupCount should > 0: %d", cfg.Log.BackupCount)
+	err := cfg.Log.Check(confRoot)
+	if err != nil {
+		return err
 	}
 
 	if cfg.Template.RequestTemplate == "" {
@@ -87,7 +69,6 @@ func (cfg *ConfModAccess) Check(confRoot string) error {
 	if cfg.Template.SessionTemplate == "" {
 		return fmt.Errorf("ModAccess.SessionTemplate not set")
 	}
-
 	return nil
 }
 

diff --git a/bfe_modules/mod_access/mod_access.go b/bfe_modules/mod_access/mod_access.go
@@ -92,8 +92,7 @@ func (m *ModuleAccess) init(conf *ConfModAccess, cbs *bfe_module.BfeCallbacks, w
 		return fmt.Errorf("%s.Init(): CheckLogFormat %s", m.name, err.Error())
 	}
 
-	m.logger, err = access_log.LoggerInit(conf.Log.LogPrefix, conf.Log.LogDir,
-		conf.Log.RotateWhen, conf.Log.BackupCount)
+	m.logger, err = access_log.LoggerInit(conf.Log)
 	if err != nil {
 		return fmt.Errorf("%s.Init(): create logger", m.name)
 	}
@@ -148,8 +147,7 @@ func (m *ModuleAccess) requestLogHandler(req *bfe_basic.Request, res *bfe_http.R
 		}
 	}
 
-	byteStr.WriteString("\n")
-	m.logger.Info(byteStr.Bytes())
+	m.logger.Info(byteStr.String())
 
 	return bfe_module.BfeHandlerGoOn
 }
@@ -173,8 +171,7 @@ func (m *ModuleAccess) sessionLogHandler(session *bfe_basic.Session) int {
 		}
 	}
 
-	byteStr.WriteString("\n")
-	m.logger.Info(byteStr.Bytes())
+	m.logger.Info(byteStr.String())
 
 	return bfe_module.BfeHandlerGoOn
 }
diff --git a/bfe_modules/mod_key_log/conf_mod_key_log.go b/bfe_modules/mod_key_log/conf_mod_key_log.go
@@ -15,51 +15,24 @@
 package mod_key_log
 
 import (
-	"fmt"
-)
-
-import (
-	"github.com/baidu/go-lib/log/log4go"
 	gcfg "gopkg.in/gcfg.v1"
 )
 
 import (
-	"github.com/bfenetworks/bfe/bfe_util"
+	"github.com/bfenetworks/bfe/bfe_util/access_log"
 )
 
 // ConfModKeyLog represents the basic config for mod_key_log.
 type ConfModKeyLog struct {
 	Basic struct {
 		DataPath string // path of config data (key_log)
 	}
-	Log struct {
-		LogPrefix   string // log file prefix
-		LogDir      string // log file dir
-		RotateWhen  string // rotate time
-		BackupCount int    // log file backup number
-	}
+	Log access_log.LogConfig
 }
 
 // Check validates module config
 func (cfg *ConfModKeyLog) Check(confRoot string) error {
-	if cfg.Log.LogPrefix == "" {
-		return fmt.Errorf("LogPrefix is empty")
-	}
-
-	if cfg.Log.LogDir == "" {
-		return fmt.Errorf("LogDir is empty")
-	}
-	cfg.Log.LogDir = bfe_util.ConfPathProc(cfg.Log.LogDir, confRoot)
-
-	if !log4go.WhenIsValid(cfg.Log.RotateWhen) {
-		return fmt.Errorf("RotateWhen invalid: %s", cfg.Log.RotateWhen)
-	}
-
-	if cfg.Log.BackupCount <= 0 {
-		return fmt.Errorf("BackupCount should > 0: %d", cfg.Log.BackupCount)
-	}
-
-	return nil
+	return cfg.Log.Check(confRoot)
 }
 
 // ConfLoad loads config from file

diff --git a/bfe_modules/mod_key_log/mod_key_log.go b/bfe_modules/mod_key_log/mod_key_log.go
@@ -117,8 +117,7 @@ func (m *ModuleKeyLog) Init(cbs *bfe_module.BfeCallbacks, whs *web_monitor.WebHa
 	}
 
 	// init logger
-	m.logger, err = access_log.LoggerInit(m.conf.Log.LogPrefix, m.conf.Log.LogDir,
-		m.conf.Log.RotateWhen, m.conf.Log.BackupCount)
+	m.logger, err = access_log.LoggerInit(m.conf.Log)
 	if err != nil {
 		return fmt.Errorf("%s.Init():create logger:%s", m.name, err.Error())
 	}

diff --git a/bfe_modules/mod_waf/conf_mod_waf.go b/bfe_modules/mod_waf/conf_mod_waf.go
@@ -13,18 +13,14 @@
 // limitations under the License.
 package mod_waf
 
-import (
-	"fmt"
-)
-
 import (
 	"github.com/baidu/go-lib/log"
-	"github.com/baidu/go-lib/log/log4go"
 	"gopkg.in/gcfg.v1"
 )
 
 import (
 	"github.com/bfenetworks/bfe/bfe_util"
+	"github.com/bfenetworks/bfe/bfe_util/access_log"
 )
 
 const (
@@ -35,12 +31,7 @@ type ConfModWaf struct {
 	Basic struct {
 		ProductRulePath string // path of waf rule data
 	}
-	Log struct {
-		LogPrefix   string // log file prefix
-		LogDir      string // log file dir
-		RotateWhen  string // rotate time
-		BackupCount int    // log file backup number
-	}
+	Log access_log.LogConfig
 }
 
 func (cfg *ConfModWaf) Check(confRoot string) error {
@@ -51,24 +42,7 @@ func (cfg *ConfModWaf) Check(confRoot string) error {
 
 	cfg.Basic.ProductRulePath = bfe_util.ConfPathProc(cfg.Basic.ProductRulePath, confRoot)
 
-	if cfg.Log.LogPrefix == "" {
-		return fmt.Errorf("ConfModWaf.LogPrefix is empty")
-	}
-
-	if cfg.Log.LogDir == "" {
-		return fmt.Errorf("ConfModWaf.LogDir is empty")
-	}
-	cfg.Log.LogDir = bfe_util.ConfPathProc(cfg.Log.LogDir, confRoot)
-
-	if !log4go.WhenIsValid(cfg.Log.RotateWhen) {
-		return fmt.Errorf("ConfModWaf.RotateWhen invalid: %s", cfg.Log.RotateWhen)
-	}
-
-	if cfg.Log.BackupCount <= 0 {
-		return fmt.Errorf("ConfModWaf.BackupCount should > 0: %d", cfg.Log.BackupCount)
-	}
-
-	return nil
+	return cfg.Log.Check(confRoot)
 }
 
 func ConfLoad(filePath string, confRoot string) (*ConfModWaf, error) {

diff --git a/bfe_modules/mod_waf/conf_mod_waf_test.go b/bfe_modules/mod_waf/conf_mod_waf_test.go
@@ -14,6 +14,7 @@
 package mod_waf
 
 import (
+	"github.com/bfenetworks/bfe/bfe_util/access_log"
 	"reflect"
 	"testing"
 )
@@ -23,12 +24,7 @@ func TestConfModWafCheck(t *testing.T) {
 		Basic struct {
 			ProductRulePath string
 		}
-		Log struct {
-			LogPrefix   string
-			LogDir      string
-			RotateWhen  string
-			BackupCount int
-		}
+		Log access_log.LogConfig
 	}
 	type args struct {
 		confRoot string
@@ -47,12 +43,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig{
 					LogPrefix:   "waf",
 					LogDir:      "../log",
 					RotateWhen:  "NEXTHOUR",
@@ -72,12 +63,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "waf",
 					LogDir:      "../log",
 					RotateWhen:  "NEXTHOUR",
@@ -97,12 +83,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "waf",
 					LogDir:      "../log",
 					RotateWhen:  "NEXTHOUR",
@@ -122,12 +103,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "",
 					LogDir:      "../log",
 					RotateWhen:  "NEXTHOUR",
@@ -147,12 +123,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "waf",
 					LogDir:      "",
 					RotateWhen:  "NEXTHOUR",
@@ -172,12 +143,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "waf",
 					LogDir:      "",
 					RotateWhen:  "NEXTHOUR",
@@ -197,12 +163,7 @@ func TestConfModWafCheck(t *testing.T) {
 				}{
 					ProductRulePath: "mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "waf",
 					LogDir:      "../log",
 					RotateWhen:  "HHHH",
@@ -251,12 +212,7 @@ func TestConfLoad(t *testing.T) {
 				}{
 					ProductRulePath: "testdata/mod_waf/waf_rule.data",
 				},
-				Log: struct {
-					LogPrefix   string
-					LogDir      string
-					RotateWhen  string
-					BackupCount int
-				}{
+				Log: access_log.LogConfig {
 					LogPrefix:   "waf",
 					LogDir:      "log",
 					RotateWhen:  "NEXTHOUR",

diff --git a/bfe_modules/mod_waf/waf_log.go b/bfe_modules/mod_waf/waf_log.go
@@ -37,8 +37,7 @@ func (wf *wafLogger) Init(conf *ConfModWaf) error {
 	var err error
 	// WAF LOG Demo:[2020/08/25 13:40:58 CST] [INFO] [69613] {"Rule":"RuleBashCmd","Type":"Block","Hit":true ...
 	logFormatter := "[%D %T] [%L] [%P] %M"
-	wf.log, err = access_log.LoggerInitWithFormat(conf.Log.LogPrefix, conf.Log.LogDir,
-		conf.Log.RotateWhen, conf.Log.BackupCount, logFormatter)
+	wf.log, err = access_log.LoggerInitWithFormat(conf.Log, logFormatter)
 	if err != nil {
 		return fmt.Errorf("WafLogger.Init(): create logger error:%v", err)
 	}