Parse external request id from request headers, and print it in access log

custom/conf/app.example.ini

@@ -576,6 +576,22 @@ ROUTER = console
 ;; The routing level will default to that of the system but individual router level can be set in
 ;; [log.<mode>.router] LEVEL
 ;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;; Print request id which parsed from request headers in router log
+;; * e.g:
+;; * In reuqest Header:         X-Request-ID: test-id-123
+;; * Configuration in app.ini:  REQUEST_ID_HEADERS = X-Request-ID
+;; * Print in log:              2023/02/14 13:18:50 [63eb19ba] [test-id-123] ...
+;; 
+;; If you configure more than one in the .ini file, it will match in the order of configuration, 
+;; and the first match will be finally printed in the log.
+;; * e.g:
+;; * In reuqest Header:         X-Trace-ID: test-trace-id-123
+;; * Configuration in app.ini:  REQUEST_ID_HEADERS = X-Request-ID, X-Trace-ID, X-Req-ID
+;; * Print in log:              2023/02/14 13:18:50 [63eb19ba] [test-trace-id-123] ...
+;;
+;; REQUEST_ID_HEADERS = 
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -854,6 +854,7 @@ Default templates for project boards:
 - `DISABLE_ROUTER_LOG`: **false**: Mute printing of the router log.
 - `ROUTER`: **console**: The mode or name of the log the router should log to. (If you set this to `,` it will log to default Gitea logger.)
   NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take effect. Configure each mode in per mode log subsections `\[log.modename.router\]`.
+- `REQUEST_ID_HEADERS`: **\<empty\>**: You can configure multiple values that are splited by comma here. It will match in the order of configuration, and the first match will be finally printed in the log. You can refer to the `app.example.ini` file for examples
 
 ### Access Log (`log`)
 

docs/content/doc/advanced/config-cheat-sheet.zh-cn.md

@@ -77,14 +77,12 @@ menu:
 - `START_SSH_SERVER`: 是否启用内部SSH服务器。
 - `SSH_PORT`: SSH端口，默认为 `22`。
 - `OFFLINE_MODE`: 针对静态和头像文件禁用 CDN。
-- `DISABLE_ROUTER_LOG`: 关闭日志中的路由日志。
 - `CERT_FILE`: 启用HTTPS的证书文件。
 - `KEY_FILE`: 启用HTTPS的密钥文件。
 - `STATIC_ROOT_PATH`: 存放模板和静态文件的根目录，默认是 Gitea 的根目录。
 - `STATIC_CACHE_TIME`: **6h**: 静态资源文件，包括 `custom/`, `public/` 和所有上传的头像的浏览器缓存时间。
 - `ENABLE_GZIP`: 启用实时生成的数据启用 GZIP 压缩，不包括静态资源。
 - `LANDING_PAGE`: 未登录用户的默认页面，可选 `home` 或 `explore`。
-
 - `LFS_START_SERVER`: 是否启用 git-lfs 支持. 可以为 `true` 或 `false`， 默认是 `false`。
 - `LFS_JWT_SECRET`: LFS 认证密钥，改成自己的。
 - `LFS_CONTENT_PATH`: **已废弃**, 存放 lfs 命令上传的文件的地方，默认是 `data/lfs`。**废弃** 请使用 `[lfs]` 的设置。
@@ -263,6 +261,8 @@ test01.xls: application/vnd.ms-excel; charset=binary
 - `ROOT_PATH`: 日志文件根目录。
 - `MODE`: 日志记录模式，默认是为 `console`。如果要写到多个通道，用逗号分隔
 - `LEVEL`: 日志级别，默认为`Trace`。
+- `DISABLE_ROUTER_LOG`: 关闭日志中的路由日志。
+- `REQUEST_ID_HEADERS`: 从Request Header中匹配指定Key，并将匹配到的值输出到router log中。如果在该参数中配置多个Key， 请用逗号分割，程序将按照配置的顺序进行匹配，示例可以参考`app.example.ini`文件。
 
 ## Cron (`cron`)
 

modules/setting/log.go

@@ -273,6 +273,7 @@ func newRouterLogService() {
 	Cfg.Section("log").Key("ROUTER").MustString("console")
 	// Allow [log]  DISABLE_ROUTER_LOG to override [server] DISABLE_ROUTER_LOG
 	DisableRouterLog = Cfg.Section("log").Key("DISABLE_ROUTER_LOG").MustBool(DisableRouterLog)
+	RequestIDHeaders = Cfg.Section("log").Key("REQUEST_ID_HEADERS").Strings(",")
 
 	if !DisableRouterLog {
 		options := newDefaultLogOptions()

modules/setting/setting.go

@@ -365,11 +365,10 @@ var (
 	LogRootPath        string
 	EnableSSHLog       bool
 	EnableXORMLog      bool
-
-	DisableRouterLog bool
-
-	EnableAccessLog   bool
-	AccessLogTemplate string
+	DisableRouterLog   bool
+	EnableAccessLog    bool
+	AccessLogTemplate  string
+	RequestIDHeaders   []string
 
 	// Time settings
 	TimeFormat string

modules/web/routing/logger.go

@@ -9,6 +9,7 @@ import (
 
 	"code.gitea.io/gitea/modules/context"
 	"code.gitea.io/gitea/modules/log"
+	"code.gitea.io/gitea/modules/setting"
 )
 
 // NewLoggerHandler is a handler that will log routing to the router log taking account of
@@ -35,15 +36,34 @@ var (
 
 func logPrinter(logger log.Logger) func(trigger Event, record *requestRecord) {
 	return func(trigger Event, record *requestRecord) {
-		if trigger == StartEvent {
-			if !logger.IsTrace() {
-				// for performance, if the "started" message shouldn't be logged, we just return as early as possible
-				// developers can set the router log level to TRACE to get the "started" request messages.
-				return
+		if trigger == StartEvent && !logger.IsTrace() {
+			// for performance, if the "started" message shouldn't be logged, we just return as early as possible
+			// developers can set the router log level to TRACE to get the "started" request messages.
+			return
+		}
+
+		var requestID string
+		if len(setting.RequestIDHeaders) > 0 {
+			for _, key := range setting.RequestIDHeaders {
+				headerVal := record.request.Header.Get(key)
+				if record.request.Header.Get(key) != "" {
+					requestID = headerVal
+					break
+				}
 			}
+		}
+		var format string
+		var v []interface{}
+		if requestID != "" {
+			format = "[%s] "
+			v = append(v, requestID)
+		}
+		if trigger == StartEvent {
 			// when a request starts, we have no information about the handler function information, we only have the request path
 			req := record.request
-			logger.Trace("router: %s %v %s for %s", startMessage, log.ColoredMethod(req.Method), req.RequestURI, req.RemoteAddr)
+			format += "router: %s %v %s for %s"
+			v = append(v, startMessage, log.ColoredMethod(req.Method), req.RequestURI, req.RemoteAddr)
+			logger.Trace(format, v...)
 			return
 		}
 
@@ -64,23 +84,21 @@ func logPrinter(logger log.Logger) func(trigger Event, record *requestRecord) {
 				level = log.INFO
 				message = pollingMessage
 			}
-			_ = logger.Log(0, level, "router: %s %v %s for %s, elapsed %v @ %s",
-				message,
-				log.ColoredMethod(req.Method), req.RequestURI, req.RemoteAddr,
-				log.ColoredTime(time.Since(record.startTime)),
-				handlerFuncInfo,
-			)
+			format += "router: %s %v %s for %s, elapsed %v @ %s"
+			v = append(v, message, log.ColoredMethod(req.Method), req.RequestURI,
+				req.RemoteAddr, log.ColoredTime(time.Since(record.startTime)), handlerFuncInfo)
+			_ = logger.Log(0, level, format, v...)
 			return
 		}
 
 		if panicErr != nil {
-			_ = logger.Log(0, log.WARN, "router: %s %v %s for %s, panic in %v @ %s, err=%v",
-				failedMessage,
+			format += "router: %s %v %s for %s, panic in %v @ %s, err=%v"
+			v = append(v, failedMessage,
 				log.ColoredMethod(req.Method), req.RequestURI, req.RemoteAddr,
 				log.ColoredTime(time.Since(record.startTime)),
 				handlerFuncInfo,
-				panicErr,
-			)
+				panicErr)
+			_ = logger.Log(0, log.WARN, format, v...)
 			return
 		}
 
@@ -95,11 +113,11 @@ func logPrinter(logger log.Logger) func(trigger Event, record *requestRecord) {
 			message = unknownHandlerMessage
 		}
 
-		_ = logger.Log(0, level, "router: %s %v %s for %s, %v %v in %v @ %s",
-			message,
+		format += "router: %s %v %s for %s, %v %v in %v @ %s"
+		v = append(v, message,
 			log.ColoredMethod(req.Method), req.RequestURI, req.RemoteAddr,
 			log.ColoredStatus(status), log.ColoredStatus(status, http.StatusText(status)), log.ColoredTime(time.Since(record.startTime)),
-			handlerFuncInfo,
-		)
+			handlerFuncInfo)
+		_ = logger.Log(0, level, format, v...)
 	}
 }