Added log_name directive

caddyserver · May 11, 2024 · aea0e75 · aea0e75
1 parent 1b12d34
commit aea0e75
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 14 deletions.
diff --git a/caddyconfig/httpcaddyfile/builtins.go b/caddyconfig/httpcaddyfile/builtins.go
@@ -51,6 +51,7 @@ func init() {
 	RegisterDirective("log", parseLog)
 	RegisterHandlerDirective("skip_log", parseLogSkip)
 	RegisterHandlerDirective("log_skip", parseLogSkip)
+	RegisterHandlerDirective("log_name", parseLogName)
 }
 
 // parseBind parses the bind directive. Syntax:
@@ -914,7 +915,7 @@ func parseLogHelper(h Helper, globalLogNames map[string]struct{}) ([]ConfigValue
 	// this is useful for setting up loggers per subdomain in a site block
 	// with a wildcard domain
 	customHostnames := []string{}
-	noLoggerNames := false
+	noHostname := false
 	for h.NextBlock(0) {
 		switch h.Val() {
 		case "hostnames":
@@ -1004,7 +1005,7 @@ func parseLogHelper(h Helper, globalLogNames map[string]struct{}) ([]ConfigValue
 			if h.NextArg() {
 				return nil, h.ArgErr()
 			}
-			noLoggerNames = true
+			noHostname = true
 
 		default:
 			return nil, h.Errf("unrecognized subdirective: %s", h.Val())
@@ -1013,7 +1014,7 @@ func parseLogHelper(h Helper, globalLogNames map[string]struct{}) ([]ConfigValue
 
 	var val namedCustomLog
 	val.hostnames = customHostnames
-	val.noLoggerNames = noLoggerNames
+	val.noHostname = noHostname
 	isEmptyConfig := reflect.DeepEqual(cl, new(caddy.CustomLog))
 
 	// Skip handling of empty logging configs
@@ -1064,3 +1065,12 @@ func parseLogSkip(h Helper) (caddyhttp.MiddlewareHandler, error) {
 	}
 	return caddyhttp.VarsMiddleware{"log_skip": true}, nil
 }
+
+// parseLogName parses the log_name directive. Syntax:
+//
+// log_name <names...>
+func parseLogName(h Helper) (caddyhttp.MiddlewareHandler, error) {
+	h.Next()
+	access_logger_names := h.RemainingArgs()
+	return caddyhttp.VarsMiddleware{"access_logger_names": access_logger_names}, nil
+}
diff --git a/caddyconfig/httpcaddyfile/directives.go b/caddyconfig/httpcaddyfile/directives.go
@@ -53,6 +53,7 @@ var defaultDirectiveOrder = []string{
 	"log_append",
 	"skip_log", // TODO: deprecated, renamed to log_skip
 	"log_skip",
+	"log_name",
 
 	"header",
 	"copy_response_headers", // only in reverse_proxy's handle_response

diff --git a/caddyconfig/httpcaddyfile/httptype.go b/caddyconfig/httpcaddyfile/httptype.go
@@ -797,7 +797,7 @@ func (st *ServerType) serversFromPairings(
 			sblockLogHosts := sblock.hostsFromKeys(true)
 			for _, cval := range sblock.pile["custom_log"] {
 				ncl := cval.Value.(namedCustomLog)
-				if ncl.noLoggerNames {
+				if ncl.noHostname {
 					continue
 				}
 				if sblock.hasHostCatchAllKey() && len(ncl.hostnames) == 0 {
@@ -1601,10 +1601,10 @@ func (c counter) nextGroup() string {
 }
 
 type namedCustomLog struct {
-	name          string
-	hostnames     []string
-	log           *caddy.CustomLog
-	noLoggerNames bool
+	name       string
+	hostnames  []string
+	log        *caddy.CustomLog
+	noHostname bool
 }
 
 // sbAddrAssociation is a mapping from a list of

diff --git a/caddytest/integration/caddyfile_adapt/log_filter_with_header.txt b/caddytest/integration/caddyfile_adapt/log_filter_with_header.txt
@@ -12,7 +12,7 @@ localhost {
 	}
 	@healthCheck `header_regexp('User-Agent', '^some-regexp$') || path('/healthz*')`
 	handle @healthCheck {
-		vars access_logger_names "health_check_log,general_log"
+		log_name "health_check_log" "general_log"
 		respond "Healthy"
 	}
 
@@ -89,7 +89,10 @@ localhost {
 														{
 															"handle": [
 																{
-																	"access_logger_names": "health_check_log,general_log",
+																	"access_logger_names": [
+																		"health_check_log",
+																		"general_log"
+																	],
 																	"handler": "vars"
 																},
 																{

diff --git a/modules/caddyhttp/logging.go b/modules/caddyhttp/logging.go
@@ -80,10 +80,11 @@ func (slc ServerLogConfig) wrapLogger(logger *zap.Logger, req *http.Request) []*
 	}
 	hosts := slc.getLoggerHosts(hostWithoutPort)
 	loggers := make([]*zap.Logger, 0, len(hosts))
-	if access_logger_names := GetVar(req.Context(), AccessLoggerNameVarKey); access_logger_names != nil {
-		accessLoggerNamesSlice := strings.Split(access_logger_names.(string), ",")
-		for _, loggerName := range accessLoggerNamesSlice {
-			loggers = append(loggers, logger.Named(loggerName))
+	if names := GetVar(req.Context(), AccessLoggerNameVarKey); names != nil {
+		if namesSlice, ok := names.([]any); ok {
+			for _, loggerName := range namesSlice {
+				loggers = append(loggers, logger.Named(loggerName.(string)))
+			}
 		}
 		return loggers
 	}