Adding nginx_proxy access_log format ability

Author: tataruty

apis/v1alpha2/nginxproxy_types.go

@@ -297,6 +297,17 @@ type NginxLogging struct {
 	// +optional
 	// +kubebuilder:default=info
 	AgentLevel *AgentLogLevel `json:"agentLevel,omitempty"`
+
+	// LogFormats defines custom log formats that can be used in access logs.
+	// Each log format must have a unique name.
+	//
+	// +optional
+	LogFormats []LogFormat `json:"logFormats,omitempty"`
+
+	// AccessLogs defines the access log settings, including the log file path, format, and optional parameters.
+	//
+	// +optional
+	AccessLogs []AccessLog `json:"accessLogs,omitempty"`
 }
 
 // NginxErrorLogLevel type defines the log level of error logs for NGINX.
@@ -352,6 +363,21 @@ const (
 	AgentLogLevelFatal AgentLogLevel = "fatal"
 )
 
+// LogFormat defines a custom log format for NGINX.
+type LogFormat struct {
+	Name   string `json:"name"`
+	Format string `json:"format"`
+}
+
+// AccessLog defines the configuration for an NGINX access log.
+type AccessLog struct {
+	Path      string `json:"path"`
+	Format    string `json:"format"`
+	Buffer    string `json:"buffer,omitempty"`
+	Condition string `json:"condition,omitempty"`
+	Gzip      bool   `json:"gzip,omitempty"`
+}
+
 // NginxPlus specifies NGINX Plus additional settings. These will only be applied if NGINX Plus is being used.
 type NginxPlus struct {
 	// AllowedAddresses specifies IPAddresses or CIDR blocks to the allow list for accessing the NGINX Plus API.

apis/v1alpha2/zz_generated.deepcopy.go

@@ -8016,6 +8016,28 @@ spec:
               logging:
                 description: Logging defines logging related settings for NGINX.
                 properties:
+                  accessLogs:
+                    description: AccessLogs defines the access log settings, including
+                      the log file path, format, and optional parameters.
+                    items:
+                      description: AccessLog defines the configuration for an NGINX
+                        access log.
+                      properties:
+                        buffer:
+                          type: string
+                        condition:
+                          type: string
+                        format:
+                          type: string
+                        gzip:
+                          type: boolean
+                        path:
+                          type: string
+                      required:
+                      - format
+                      - path
+                      type: object
+                    type: array
                   agentLevel:
                     default: info
                     description: |-
@@ -8045,6 +8067,22 @@ spec:
                     - alert
                     - emerg
                     type: string
+                  logFormats:
+                    description: |-
+                      LogFormats defines custom log formats that can be used in access logs.
+                      Each log format must have a unique name.
+                    items:
+                      description: LogFormat defines a custom log format for NGINX.
+                      properties:
+                        format:
+                          type: string
+                        name:
+                          type: string
+                      required:
+                      - format
+                      - name
+                      type: object
+                    type: array
                 type: object
               metrics:
                 description: |-

config/crd/bases/gateway.nginx.org_nginxproxies.yaml

@@ -8601,6 +8601,28 @@ spec:
               logging:
                 description: Logging defines logging related settings for NGINX.
                 properties:
+                  accessLogs:
+                    description: AccessLogs defines the access log settings, including
+                      the log file path, format, and optional parameters.
+                    items:
+                      description: AccessLog defines the configuration for an NGINX
+                        access log.
+                      properties:
+                        buffer:
+                          type: string
+                        condition:
+                          type: string
+                        format:
+                          type: string
+                        gzip:
+                          type: boolean
+                        path:
+                          type: string
+                      required:
+                      - format
+                      - path
+                      type: object
+                    type: array
                   agentLevel:
                     default: info
                     description: |-
@@ -8630,6 +8652,22 @@ spec:
                     - alert
                     - emerg
                     type: string
+                  logFormats:
+                    description: |-
+                      LogFormats defines custom log formats that can be used in access logs.
+                      Each log format must have a unique name.
+                    items:
+                      description: LogFormat defines a custom log format for NGINX.
+                      properties:
+                        format:
+                          type: string
+                        name:
+                          type: string
+                      required:
+                      - format
+                      - name
+                      type: object
+                    type: array
                 type: object
               metrics:
                 description: |-

deploy/crds.yaml

@@ -406,9 +406,15 @@ func (p *NginxProvisioner) buildNginxConfigMaps(
 		workerConnections = *nProxyCfg.WorkerConnections
 	}
 
+	// Add LogFormats and AccessLogs to mainFields
+	logFormats := addLogFormatToNginxConfig(logging)
+	accessLogs := addAccessLogsToNginxConfig(logging)
+
 	mainFields := map[string]interface{}{
 		"ErrorLevel":        logLevel,
 		"WorkerConnections": workerConnections,
+		"LogFormats":        logFormats,
+		"AccessLogs":        accessLogs,
 	}
 
 	// Create events ConfigMap data using template
@@ -1427,3 +1433,49 @@ func DetermineNginxImageName(
 
 	return fmt.Sprintf("%s:%s", image, tag), pullPolicy
 }
+
+func addLogFormatToNginxConfig(logging *ngfAPIv1alpha2.NginxLogging) []ngfAPIv1alpha2.LogFormat {
+	logFormats := []ngfAPIv1alpha2.LogFormat{}
+	if logging == nil {
+		return logFormats
+	}
+
+	for _, lf := range logging.LogFormats {
+		logFormats = append(logFormats, ngfAPIv1alpha2.LogFormat{
+			Name:   lf.Name,
+			Format: lf.Format,
+		})
+	}
+
+	if len(logFormats) == 0 {
+		logFormats = append(logFormats, ngfAPIv1alpha2.LogFormat{
+			Name:   "default",
+			Format: "$remote_addr - [$time_local] \"$request\" $status $body_bytes_sent",
+		})
+	}
+
+	return logFormats
+}
+
+func addAccessLogsToNginxConfig(logging *ngfAPIv1alpha2.NginxLogging) []ngfAPIv1alpha2.AccessLog {
+	accessLogs := []ngfAPIv1alpha2.AccessLog{}
+	if logging == nil {
+		return accessLogs
+	}
+
+	for _, al := range logging.AccessLogs {
+		accessLogs = append(accessLogs, ngfAPIv1alpha2.AccessLog{
+			Path:   al.Path,
+			Format: al.Format,
+		})
+	}
+
+	if len(accessLogs) == 0 {
+		accessLogs = append(accessLogs, ngfAPIv1alpha2.AccessLog{
+			Path:   "/var/log/nginx/access.log",
+			Format: "default",
+		})
+	}
+
+	return accessLogs
+}