Configure Patroni Logs to be stored in a file

This commit updates the Patroni configuration so that the instance
Pod logs go to a file on the 'pgdata' volume instead of to stdout.
This file is located at /pgdata/patroni/log/patroni.log.

This is accomplished by setting 'log.dir' in the Patroni YAML
configuration. Setting 'log.file_size' to 0 means that the log
file will not rollover.

- https://patroni.readthedocs.io/en/latest/yaml_configuration.html#log
- https://github.com/patroni/patroni/blob/v3.3.4/patroni/log.py#L431-L432
- https://docs.python.org/3.11/library/logging.handlers.html#rotatingfilehandler

Issue: PGO-1701

Author: tjmoore4

internal/naming/names.go

@@ -131,6 +131,10 @@ const (
 )
 
 const (
+	// PatroniPGDataLogPath is the Patroni default log path configuration used by the
+	// PostgreSQL instance.
+	PatroniPGDataLogPath = "/pgdata/patroni/log"
+
 	// PGBackRestRepoContainerName is the name assigned to the container used to run pgBackRest
 	PGBackRestRepoContainerName = "pgbackrest"
 

internal/patroni/config.go

@@ -50,6 +50,17 @@ func clusterYAML(
 		// lifetime.
 		"scope": naming.PatroniScope(cluster),
 
+		// Configure the Patroni log path directory
+		// - https://patroni.readthedocs.io/en/latest/yaml_configuration.html#log
+		//
+		// Setting file_size to 0 means that there will be no rollover.
+		// - https://github.com/patroni/patroni/blob/v3.3.4/patroni/log.py#L431-L432
+		// - https://docs.python.org/3.11/library/logging.handlers.html#rotatingfilehandler
+		"log": map[string]any{
+			"dir":       naming.PatroniPGDataLogPath,
+			"file_size": 0,
+		},
+
 		// Use Kubernetes Endpoints for the distributed configuration store (DCS).
 		// These values cannot change during the cluster's lifetime.
 		//

internal/patroni/config_test.go

@@ -58,6 +58,9 @@ kubernetes:
   role_label: postgres-operator.crunchydata.com/role
   scope_label: postgres-operator.crunchydata.com/patroni
   use_endpoints: true
+log:
+  dir: /pgdata/patroni/log
+  file_size: 0
 postgresql:
   authentication:
     replication:
@@ -116,6 +119,9 @@ kubernetes:
   role_label: postgres-operator.crunchydata.com/role
   scope_label: postgres-operator.crunchydata.com/patroni
   use_endpoints: true
+log:
+  dir: /pgdata/patroni/log
+  file_size: 0
 postgresql:
   authentication:
     replication:

internal/postgres/config.go

@@ -291,9 +291,9 @@ chmod +x /tmp/pg_rewind_tde.sh
 `
 	}
 
-	args := []string{version, walDir, naming.PGBackRestPGDataLogPath}
+	args := []string{version, walDir, naming.PGBackRestPGDataLogPath, naming.PatroniPGDataLogPath}
 	script := strings.Join([]string{
-		`declare -r expected_major_version="$1" pgwal_directory="$2" pgbrLog_directory="$3"`,
+		`declare -r expected_major_version="$1" pgwal_directory="$2" pgbrLog_directory="$3" patroniLog_directory="$4"`,
 
 		// Function to print the permissions of a file or directory and its parents.
 		bashPermissions,
@@ -369,6 +369,11 @@ chmod +x /tmp/pg_rewind_tde.sh
 		`install --directory --mode=0775 "${pgbrLog_directory}" ||`,
 		`halt "$(permissions "${pgbrLog_directory}" ||:)"`,
 
+		// Create the Patroni log directory.
+		`results 'Patroni log directory' "${patroniLog_directory}"`,
+		`install --directory --mode=0775 "${patroniLog_directory}" ||`,
+		`halt "$(permissions "${patroniLog_directory}" ||:)"`,
+
 		// Copy replication client certificate files
 		// from the /pgconf/tls/replication directory to the /tmp/replication directory in order
 		// to set proper file permissions. This is required because the group permission settings

internal/postgres/reconcile_test.go

@@ -230,7 +230,7 @@ initContainers:
   - -ceu
   - --
   - |-
-    declare -r expected_major_version="$1" pgwal_directory="$2" pgbrLog_directory="$3"
+    declare -r expected_major_version="$1" pgwal_directory="$2" pgbrLog_directory="$3" patroniLog_directory="$4"
     permissions() { while [[ -n "$1" ]]; do set "${1%/*}" "$@"; done; shift; stat -Lc '%A %4u %4g %n' "$@"; }
     halt() { local rc=$?; >&2 echo "$@"; exit "${rc/#0/1}"; }
     results() { printf '::postgres-operator: %s::%s\n' "$@"; }
@@ -270,6 +270,9 @@ initContainers:
     results 'pgBackRest log directory' "${pgbrLog_directory}"
     install --directory --mode=0775 "${pgbrLog_directory}" ||
     halt "$(permissions "${pgbrLog_directory}" ||:)"
+    results 'Patroni log directory' "${patroniLog_directory}"
+    install --directory --mode=0775 "${patroniLog_directory}" ||
+    halt "$(permissions "${patroniLog_directory}" ||:)"
     install -D --mode=0600 -t "/tmp/replication" "/pgconf/tls/replication"/{tls.crt,tls.key,ca.crt}
 
 
@@ -286,6 +289,7 @@ initContainers:
   - "11"
   - /pgdata/pg11_wal
   - /pgdata/pgbackrest/log
+  - /pgdata/patroni/log
   env:
   - name: PGDATA
     value: /pgdata/pg11
@@ -473,7 +477,7 @@ volumes:
 
 		// Startup moves WAL files to data volume.
 		assert.DeepEqual(t, pod.InitContainers[0].Command[4:],
-			[]string{"startup", "11", "/pgdata/pg11_wal", "/pgdata/pgbackrest/log"})
+			[]string{"startup", "11", "/pgdata/pg11_wal", "/pgdata/pgbackrest/log", "/pgdata/patroni/log"})
 	})
 
 	t.Run("WithAdditionalConfigFiles", func(t *testing.T) {
@@ -703,7 +707,7 @@ volumes:
 
 		// Startup moves WAL files to WAL volume.
 		assert.DeepEqual(t, pod.InitContainers[0].Command[4:],
-			[]string{"startup", "11", "/pgwal/pg11_wal", "/pgdata/pgbackrest/log"})
+			[]string{"startup", "11", "/pgwal/pg11_wal", "/pgdata/pgbackrest/log", "/pgdata/patroni/log"})
 	})
 }