Merge 8998f31a3b into 86889532aa

internal/ingress/controller/config/config.go

@@ -546,6 +546,7 @@ func NewDefault() Configuration {
 			CustomHTTPErrors:            []int{},
 			WhitelistSourceRange:        []string{},
 			SkipAccessLogURLs:           []string{},
+			SkipAccessLogHTTPStatuses:   []string{},
 			LimitRate:                   0,
 			LimitRateAfter:              0,
 		},

internal/ingress/controller/template/configmap.go

@@ -34,6 +34,7 @@ import (
 const (
 	customHTTPErrors          = "custom-http-errors"
 	skipAccessLogUrls         = "skip-access-log-urls"
+	skipAccessLogHTTPStatuses = "skip-access-log-http-statuses"
 	whitelistSourceRange      = "whitelist-source-range"
 	proxyRealIPCIDR           = "proxy-real-ip-cidr"
 	bindAddress               = "bind-address"
@@ -56,6 +57,7 @@ func ReadConfig(src map[string]string) config.Configuration {
 
 	errors := make([]int, 0)
 	skipUrls := make([]string, 0)
+	skipHTTPStatuses := make([]string, 0)
 	whitelist := make([]string, 0)
 	proxylist := make([]string, 0)
 	hideHeaderslist := make([]string, 0)
@@ -83,6 +85,10 @@ func ReadConfig(src map[string]string) config.Configuration {
 		delete(conf, skipAccessLogUrls)
 		skipUrls = strings.Split(val, ",")
 	}
+	if val, ok := conf[skipAccessLogHTTPStatuses]; ok {
+		delete(conf, skipAccessLogHTTPStatuses)
+		skipHTTPStatuses = strings.Split(val, ",")
+	}
 	if val, ok := conf[whitelistSourceRange]; ok {
 		delete(conf, whitelistSourceRange)
 		whitelist = append(whitelist, strings.Split(val, ",")...)
@@ -137,6 +143,7 @@ func ReadConfig(src map[string]string) config.Configuration {
 	to := config.NewDefault()
 	to.CustomHTTPErrors = filterErrors(errors)
 	to.SkipAccessLogURLs = skipUrls
+	to.SkipAccessLogHTTPStatuses = skipHTTPStatuses
 	to.WhitelistSourceRange = whitelist
 	to.ProxyRealIPCIDR = proxylist
 	to.BindAddressIpv4 = bindAddressIpv4List

internal/ingress/controller/template/configmap_test.go

@@ -37,6 +37,7 @@ func TestMergeConfigMapToStruct(t *testing.T) {
 		"proxy-read-timeout":            "1",
 		"proxy-send-timeout":            "2",
 		"skip-access-log-urls":          "/log,/demo,/test",
+		"skip-access-log-http-statuses": "^[23],204,302,^201",
 		"use-proxy-protocol":            "true",
 		"disable-access-log":            "true",
 		"access-log-path":               "/var/log/test/access.log",
@@ -54,6 +55,7 @@ func TestMergeConfigMapToStruct(t *testing.T) {
 	def.AccessLogPath = "/var/log/test/access.log"
 	def.ErrorLogPath = "/var/log/test/error.log"
 	def.SkipAccessLogURLs = []string{"/log", "/demo", "/test"}
+	def.SkipAccessLogHTTPStatuses = []string{"^[23]", "204", "302", "^201"}
 	def.ProxyReadTimeout = 1
 	def.ProxySendTimeout = 2
 	def.EnableDynamicTLSRecords = false

internal/ingress/defaults/main.go

@@ -95,6 +95,12 @@ type Backend struct {
 	// By default this list is empty
 	SkipAccessLogURLs []string `json:"skip-access-log-urls,-"`
 
+	// SkipAccessLogHTTPStatuses sets a list of HTTP statuses that should not appear in the NGINX access log
+	// The status strings provided are interpreted by an NGINX map as regex
+	// This is useful with statuses like 2xx and 3xx that make "complex" reading the logs
+	// By default this list is empty
+	SkipAccessLogHTTPStatuses []string `json:"skip-access-log-http-statuses,-"`
+
 	// Enables or disables the redirect (301) to the HTTPS port
 	SSLRedirect bool `json:"ssl-redirect"`
 

rootfs/etc/nginx/template/nginx.tmpl

@@ -157,9 +157,20 @@ http {
 
     {{/* map urls that should not appear in access.log */}}
     {{/* http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log */}}
-    map $request_uri $loggable {
+    map $request_uri $loggable_request_url {
         {{ range $reqUri := $cfg.SkipAccessLogURLs }}
         {{ $reqUri }} 0;{{ end }}
+    }
+
+    {{/* map HTTP statuses that should not appear in access.log */}}
+    {{/* http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log */}}
+    map $status $loggable_http_status {
+        {{ range $reqHTTPStatus := $cfg.SkipAccessLogHTTPStatuses }}
+        ~{{ $reqHTTPStatus }} 0;{{ end }}
+    }
+
+    map "${loggable_request_url}${loggable_http_status}" $loggable {
+        ~0  0;
         default 1;
     }