From 4a067a4c8c7298bccb7af3c6e55f2f03e5e79208 Mon Sep 17 00:00:00 2001
From: shaoyue <shaoyue.chen@zilliz.com>
Date: Wed, 6 Dec 2023 10:26:35 +0800
Subject: [PATCH] enhance: Add proxy.ginLogSkipPaths (#28945)

Fix #28944

/cc @xiaofan-luan

Signed-off-by: shaoyue.chen <shaoyue.chen@zilliz.com>
---
 configs/milvus.yaml                    |  1 +
 internal/distributed/proxy/service.go  |  6 +++++-
 pkg/util/paramtable/component_param.go | 10 ++++++++++
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/configs/milvus.yaml b/configs/milvus.yaml
index d15d14f610..f3e289e1c8 100644
--- a/configs/milvus.yaml
+++ b/configs/milvus.yaml
@@ -198,6 +198,7 @@ proxy:
   # Whether to produce gin logs.\n
   # please adjust in embedded Milvus: false
   ginLogging: true
+  ginLogSkipPaths: "/" # skipped url path for gin log split by comma
   maxTaskNum: 1024 # max task number of proxy task queue
   accessLog:
     enable: true
diff --git a/internal/distributed/proxy/service.go b/internal/distributed/proxy/service.go
index e36ed0f30e..75304b72ed 100644
--- a/internal/distributed/proxy/service.go
+++ b/internal/distributed/proxy/service.go
@@ -173,7 +173,11 @@ func (s *Server) registerHTTPServer() {
 
 func (s *Server) startHTTPServer(errChan chan error) {
 	defer s.wg.Done()
-	ginHandler := gin.Default()
+	ginHandler := gin.New()
+	ginLogger := gin.LoggerWithConfig(gin.LoggerConfig{
+		SkipPaths: proxy.Params.ProxyCfg.GinLogSkipPaths.GetAsStrings(),
+	})
+	ginHandler.Use(ginLogger, gin.Recovery())
 	ginHandler.Use(func(c *gin.Context) {
 		_, err := strconv.ParseBool(c.Request.Header.Get(httpserver.HTTPHeaderAllowInt64))
 		if err != nil {
diff --git a/pkg/util/paramtable/component_param.go b/pkg/util/paramtable/component_param.go
index cc5e9026d7..d86f44c595 100644
--- a/pkg/util/paramtable/component_param.go
+++ b/pkg/util/paramtable/component_param.go
@@ -915,6 +915,7 @@ type proxyConfig struct {
 	MaxShardNum                  ParamItem `refreshable:"true"`
 	MaxDimension                 ParamItem `refreshable:"true"`
 	GinLogging                   ParamItem `refreshable:"false"`
+	GinLogSkipPaths              ParamItem `refreshable:"false"`
 	MaxUserNum                   ParamItem `refreshable:"true"`
 	MaxRoleNum                   ParamItem `refreshable:"true"`
 	MaxTaskNum                   ParamItem `refreshable:"false"`
@@ -1044,6 +1045,15 @@ please adjust in embedded Milvus: false`,
 	}
 	p.GinLogging.Init(base.mgr)
 
+	p.GinLogSkipPaths = ParamItem{
+		Key:          "proxy.ginLogSkipPaths",
+		Version:      "2.3.0",
+		DefaultValue: "/",
+		Doc:          "skip url path for gin log",
+		Export:       true,
+	}
+	p.GinLogSkipPaths.Init(base.mgr)
+
 	p.MaxUserNum = ParamItem{
 		Key:          "proxy.maxUserNum",
 		DefaultValue: "100",