Only set logging config for pgadmin when

Author: benjaminjb

internal/controller/standalone_pgadmin/pod.go

@@ -379,39 +379,11 @@ func startupCommand(ctx context.Context, inPgadmin *v1beta1.PGAdmin) []string {
 		// configDatabaseURIPath is the path for mounting the database URI connection string
 		configDatabaseURIPathAbsolutePath = configMountPath + "/" + configDatabaseURIPath
 	)
-	var (
-		maxBackupRetentionNumber = "1"
-		// One day in minutes for pgadmin rotation
-		pgAdminRetentionPeriod = "24 * 60"
-		// Daily rotation for gunicorn rotation
-		gunicornRetentionPeriod = "D"
-	)
-
-	// If the OpenTelemetryLogs Feature is enabled and the user has set a retention period,
-	// we will use those values for pgAdmin log rotation, which is otherwise managed by python.
-	if feature.Enabled(ctx, feature.OpenTelemetryLogs) &&
-		inPgadmin.Spec.Instrumentation != nil &&
-		inPgadmin.Spec.Instrumentation.Logs != nil &&
-		inPgadmin.Spec.Instrumentation.Logs.RetentionPeriod != nil {
-
-		retentionNumber, period := collector.ParseDurationForLogrotate(inPgadmin.Spec.Instrumentation.Logs.RetentionPeriod)
-		// `LOG_ROTATION_MAX_LOG_FILES`` in pgadmin refers to the already rotated logs.
-		// `backupCount` for gunicorn is similar.
-		// Our retention unit is for total number of log files, so subtract 1 to account
-		// for the currently-used log file.
-		maxBackupRetentionNumber = strconv.Itoa(retentionNumber - 1)
-		if period == "hourly" {
-			// If the period is hourly, set the pgadmin
-			// and gunicorn retention periods to hourly.
-			pgAdminRetentionPeriod = "60"
-			gunicornRetentionPeriod = "H"
-		}
-	}
 
 	// The constants set in configSystem will not be overridden through
 	// spec.config.settings.
 	var configSystem = `
-import glob, json, re, os, logging
+import glob, json, re, os
 DEFAULT_BINARY_PATHS = {'pg': sorted([''] + glob.glob('/usr/pgsql-*/bin')).pop()}
 with open('` + configMountPath + `/` + configFilePath + `') as _f:
     _conf, _data = re.compile(r'[A-Z_0-9]+'), json.load(_f)
@@ -423,18 +395,8 @@ if os.path.isfile('` + ldapPasswordAbsolutePath + `'):
 if os.path.isfile('` + configDatabaseURIPathAbsolutePath + `'):
     with open('` + configDatabaseURIPathAbsolutePath + `') as _f:
         CONFIG_DATABASE_URI = _f.read()
-
-DATA_DIR = '` + dataMountPath + `'
-LOG_FILE = '` + LogFileAbsolutePath + `'
-LOG_ROTATION_AGE = ` + pgAdminRetentionPeriod + ` # minutes
-LOG_ROTATION_SIZE = 5 # MiB
-LOG_ROTATION_MAX_LOG_FILES = ` + maxBackupRetentionNumber + `
-
-JSON_LOGGER = True
-CONSOLE_LOG_LEVEL = logging.WARNING
-FILE_LOG_LEVEL = logging.INFO
-FILE_LOG_FORMAT_JSON = {'time': 'created', 'name': 'name', 'level': 'levelname', 'message': 'message'}
 `
+
 	// Gunicorn reads from the `/etc/pgadmin/gunicorn_config.py` file during startup
 	// after all other config files.
 	// - https://docs.gunicorn.org/en/latest/configure.html#configuration-file
@@ -450,12 +412,59 @@ FILE_LOG_FORMAT_JSON = {'time': 'created', 'name': 'name', 'level': 'levelname',
 	// https://docs.python.org/3/library/logging.html#logrecord-attributes.
 	// JsonFormatter is used to format the log: https://pypi.org/project/jsonformatter/
 	var gunicornConfig = `
-import json, re, collections, copy, gunicorn, gunicorn.glogging
+import json, re
 with open('` + configMountPath + `/` + gunicornConfigFilePath + `') as _f:
     _conf, _data = re.compile(r'[a-z_]+'), json.load(_f)
     if type(_data) is dict:
         globals().update({k: v for k, v in _data.items() if _conf.fullmatch(k)})
+`
+
+	// If OTel logs feature gate is enabled, we want to change the pgAdmin/gunicorn logging
+	if feature.Enabled(ctx, feature.OpenTelemetryLogs) && inPgadmin.Spec.Instrumentation != nil {
+
+		var (
+			maxBackupRetentionNumber = "1"
+			// One day in minutes for pgadmin rotation
+			pgAdminRetentionPeriod = "24 * 60"
+			// Daily rotation for gunicorn rotation
+			gunicornRetentionPeriod = "D"
+		)
+
+		// If the user has set a retention period, we will use those values for log rotation,
+		// which is otherwise managed by python.
+		if inPgadmin.Spec.Instrumentation.Logs != nil &&
+			inPgadmin.Spec.Instrumentation.Logs.RetentionPeriod != nil {
+
+			retentionNumber, period := collector.ParseDurationForLogrotate(inPgadmin.Spec.Instrumentation.Logs.RetentionPeriod)
+			// `LOG_ROTATION_MAX_LOG_FILES`` in pgadmin refers to the already rotated logs.
+			// `backupCount` for gunicorn is similar.
+			// Our retention unit is for total number of log files, so subtract 1 to account
+			// for the currently-used log file.
+			maxBackupRetentionNumber = strconv.Itoa(retentionNumber - 1)
+			if period == "hourly" {
+				// If the period is hourly, set the pgadmin
+				// and gunicorn retention periods to hourly.
+				pgAdminRetentionPeriod = "60"
+				gunicornRetentionPeriod = "H"
+			}
+		}
+
+		configSystem = configSystem + `
+import logging
+DATA_DIR = '` + dataMountPath + `'
+LOG_FILE = '` + LogFileAbsolutePath + `'
+LOG_ROTATION_AGE = ` + pgAdminRetentionPeriod + ` # minutes
+LOG_ROTATION_SIZE = 5 # MiB
+LOG_ROTATION_MAX_LOG_FILES = ` + maxBackupRetentionNumber + `
+
+JSON_LOGGER = True
+CONSOLE_LOG_LEVEL = logging.WARNING
+FILE_LOG_LEVEL = logging.INFO
+FILE_LOG_FORMAT_JSON = {'time': 'created', 'name': 'name', 'level': 'levelname', 'message': 'message'}
+`
 
+		gunicornConfig = gunicornConfig + `
+import collections, copy, gunicorn, gunicorn.glogging
 gunicorn.SERVER_SOFTWARE = 'Python'
 logconfig_dict = copy.deepcopy(gunicorn.glogging.CONFIG_DEFAULTS)
 logconfig_dict['loggers']['gunicorn.access']['handlers'] = ['file']
@@ -479,6 +488,7 @@ logconfig_dict['formatters']['json'] = {
   ])
 }
 `
+	}
 
 	args := []string{strings.TrimLeft(configSystem, "\n"), strings.TrimLeft(gunicornConfig, "\n")}
 

internal/controller/standalone_pgadmin/pod_test.go

@@ -146,7 +146,7 @@ initContainers:
     echo "$2" > /etc/pgadmin/gunicorn_config.py
   - startup
   - |
-    import glob, json, re, os, logging
+    import glob, json, re, os
     DEFAULT_BINARY_PATHS = {'pg': sorted([''] + glob.glob('/usr/pgsql-*/bin')).pop()}
     with open('/etc/pgadmin/conf.d/~postgres-operator/pgadmin-settings.json') as _f:
         _conf, _data = re.compile(r'[A-Z_0-9]+'), json.load(_f)
@@ -158,46 +158,12 @@ initContainers:
     if os.path.isfile('/etc/pgadmin/conf.d/~postgres-operator/config-database-uri'):
         with open('/etc/pgadmin/conf.d/~postgres-operator/config-database-uri') as _f:
             CONFIG_DATABASE_URI = _f.read()
-
-    DATA_DIR = '/var/lib/pgadmin'
-    LOG_FILE = '/var/lib/pgadmin/logs/pgadmin.log'
-    LOG_ROTATION_AGE = 24 * 60 # minutes
-    LOG_ROTATION_SIZE = 5 # MiB
-    LOG_ROTATION_MAX_LOG_FILES = 1
-
-    JSON_LOGGER = True
-    CONSOLE_LOG_LEVEL = logging.WARNING
-    FILE_LOG_LEVEL = logging.INFO
-    FILE_LOG_FORMAT_JSON = {'time': 'created', 'name': 'name', 'level': 'levelname', 'message': 'message'}
   - |
-    import json, re, collections, copy, gunicorn, gunicorn.glogging
+    import json, re
     with open('/etc/pgadmin/conf.d/~postgres-operator/gunicorn-config.json') as _f:
         _conf, _data = re.compile(r'[a-z_]+'), json.load(_f)
         if type(_data) is dict:
             globals().update({k: v for k, v in _data.items() if _conf.fullmatch(k)})
-
-    gunicorn.SERVER_SOFTWARE = 'Python'
-    logconfig_dict = copy.deepcopy(gunicorn.glogging.CONFIG_DEFAULTS)
-    logconfig_dict['loggers']['gunicorn.access']['handlers'] = ['file']
-    logconfig_dict['loggers']['gunicorn.error']['handlers'] = ['file']
-    logconfig_dict['handlers']['file'] = {
-      'class': 'logging.handlers.TimedRotatingFileHandler',
-      'filename': '/var/lib/pgadmin/logs/gunicorn.log',
-      'backupCount': 1,
-      'interval': 1, # every one unit (defined by when), rotate
-      'when': 'D',
-      'formatter': 'json',
-    }
-    logconfig_dict['formatters']['json'] = {
-      'class': 'jsonformatter.JsonFormatter',
-      'separators': (',', ':'),
-      'format': collections.OrderedDict([
-        ('time', 'created'),
-        ('name', 'name'),
-        ('level', 'levelname'),
-        ('message', 'message'),
-      ])
-    }
   name: pgadmin-startup
   resources: {}
   securityContext:
@@ -381,7 +347,7 @@ initContainers:
     echo "$2" > /etc/pgadmin/gunicorn_config.py
   - startup
   - |
-    import glob, json, re, os, logging
+    import glob, json, re, os
     DEFAULT_BINARY_PATHS = {'pg': sorted([''] + glob.glob('/usr/pgsql-*/bin')).pop()}
     with open('/etc/pgadmin/conf.d/~postgres-operator/pgadmin-settings.json') as _f:
         _conf, _data = re.compile(r'[A-Z_0-9]+'), json.load(_f)
@@ -394,6 +360,7 @@ initContainers:
         with open('/etc/pgadmin/conf.d/~postgres-operator/config-database-uri') as _f:
             CONFIG_DATABASE_URI = _f.read()
 
+    import logging
     DATA_DIR = '/var/lib/pgadmin'
     LOG_FILE = '/var/lib/pgadmin/logs/pgadmin.log'
     LOG_ROTATION_AGE = 60 # minutes
@@ -405,12 +372,13 @@ initContainers:
     FILE_LOG_LEVEL = logging.INFO
     FILE_LOG_FORMAT_JSON = {'time': 'created', 'name': 'name', 'level': 'levelname', 'message': 'message'}
   - |
-    import json, re, collections, copy, gunicorn, gunicorn.glogging
+    import json, re
     with open('/etc/pgadmin/conf.d/~postgres-operator/gunicorn-config.json') as _f:
         _conf, _data = re.compile(r'[a-z_]+'), json.load(_f)
         if type(_data) is dict:
             globals().update({k: v for k, v in _data.items() if _conf.fullmatch(k)})
 
+    import collections, copy, gunicorn, gunicorn.glogging
     gunicorn.SERVER_SOFTWARE = 'Python'
     logconfig_dict = copy.deepcopy(gunicorn.glogging.CONFIG_DEFAULTS)
     logconfig_dict['loggers']['gunicorn.access']['handlers'] = ['file']