SQUASH: Store log positions in the logs directory

Author: cbandy

internal/collector/pgadmin.go

@@ -18,23 +18,18 @@ func EnablePgAdminLogging(ctx context.Context, configmap *corev1.ConfigMap) erro
 		return nil
 	}
 	otelConfig := NewConfig()
-	otelConfig.Extensions["file_storage/pgadmin"] = map[string]any{
-		"directory":        "/var/log/pgadmin/receiver",
-		"create_directory": true,
-		"fsync":            true,
-	}
-	otelConfig.Extensions["file_storage/gunicorn"] = map[string]any{
-		"directory":        "/var/log/gunicorn" + "/receiver",
+	otelConfig.Extensions["file_storage/pgadmin_data_logs"] = map[string]any{
+		"directory":        "/var/lib/pgadmin/logs/receiver",
 		"create_directory": true,
 		"fsync":            true,
 	}
 	otelConfig.Receivers["filelog/pgadmin"] = map[string]any{
 		"include": []string{"/var/lib/pgadmin/logs/pgadmin.log"},
-		"storage": "file_storage/pgadmin",
+		"storage": "file_storage/pgadmin_data_logs",
 	}
 	otelConfig.Receivers["filelog/gunicorn"] = map[string]any{
 		"include": []string{"/var/lib/pgadmin/logs/gunicorn.log"},
-		"storage": "file_storage/gunicorn",
+		"storage": "file_storage/pgadmin_data_logs",
 	}
 
 	otelConfig.Processors["resource/pgadmin"] = map[string]any{
@@ -71,7 +66,7 @@ func EnablePgAdminLogging(ctx context.Context, configmap *corev1.ConfigMap) erro
 	}
 
 	otelConfig.Pipelines["logs/pgadmin"] = Pipeline{
-		Extensions: []ComponentID{"file_storage/pgadmin"},
+		Extensions: []ComponentID{"file_storage/pgadmin_data_logs"},
 		Receivers:  []ComponentID{"filelog/pgadmin"},
 		Processors: []ComponentID{
 			"resource/pgadmin",
@@ -83,7 +78,7 @@ func EnablePgAdminLogging(ctx context.Context, configmap *corev1.ConfigMap) erro
 	}
 
 	otelConfig.Pipelines["logs/gunicorn"] = Pipeline{
-		Extensions: []ComponentID{"file_storage/gunicorn"},
+		Extensions: []ComponentID{"file_storage/pgadmin_data_logs"},
 		Receivers:  []ComponentID{"filelog/gunicorn"},
 		Processors: []ComponentID{
 			"resource/pgadmin",
@@ -95,9 +90,8 @@ func EnablePgAdminLogging(ctx context.Context, configmap *corev1.ConfigMap) erro
 	}
 
 	otelYAML, err := otelConfig.ToYAML()
-	if err != nil {
-		return err
+	if err == nil {
+		configmap.Data["collector.yaml"] = otelYAML
 	}
-	configmap.Data["collector.yaml"] = otelYAML
-	return nil
+	return err
 }

internal/collector/pgadmin_test.go

@@ -41,13 +41,9 @@ collector.yaml: |
     debug:
       verbosity: detailed
   extensions:
-    file_storage/gunicorn:
+    file_storage/pgadmin_data_logs:
       create_directory: true
-      directory: /var/log/gunicorn/receiver
-      fsync: true
-    file_storage/pgadmin:
-      create_directory: true
-      directory: /var/log/pgadmin/receiver
+      directory: /var/lib/pgadmin/logs/receiver
       fsync: true
   processors:
     batch/1s:
@@ -84,15 +80,14 @@ collector.yaml: |
     filelog/gunicorn:
       include:
       - /var/lib/pgadmin/logs/gunicorn.log
-      storage: file_storage/gunicorn
+      storage: file_storage/pgadmin_data_logs
     filelog/pgadmin:
       include:
       - /var/lib/pgadmin/logs/pgadmin.log
-      storage: file_storage/pgadmin
+      storage: file_storage/pgadmin_data_logs
   service:
     extensions:
-    - file_storage/gunicorn
-    - file_storage/pgadmin
+    - file_storage/pgadmin_data_logs
     pipelines:
       logs/gunicorn:
         exporters:

internal/controller/standalone_pgadmin/pod.go

@@ -39,54 +39,28 @@ func pod(
 	outPod *corev1.PodSpec,
 	pgAdminVolume *corev1.PersistentVolumeClaim,
 ) {
-	const (
-		// config and data volume names
-		configVolumeName      = "pgadmin-config"
-		dataVolumeName        = "pgadmin-data"
-		pgAdminLogVolumeName  = "pgadmin-log"
-		gunicornLogVolumeName = "gunicorn-log"
-		scriptVolumeName      = "pgadmin-config-system"
-		tempVolumeName        = "tmp"
-	)
-
 	// create the projected volume of config maps for use in
 	// 1. dynamic server discovery
 	// 2. adding the config variables during pgAdmin startup
-	configVolume := corev1.Volume{Name: configVolumeName}
+	configVolume := corev1.Volume{Name: "pgadmin-config"}
 	configVolume.VolumeSource = corev1.VolumeSource{
 		Projected: &corev1.ProjectedVolumeSource{
 			Sources: podConfigFiles(inConfigMap, *inPGAdmin),
 		},
 	}
 
 	// create the data volume for the persistent database
-	dataVolume := corev1.Volume{Name: dataVolumeName}
+	dataVolume := corev1.Volume{Name: "pgadmin-data"}
 	dataVolume.VolumeSource = corev1.VolumeSource{
 		PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
 			ClaimName: pgAdminVolume.Name,
 			ReadOnly:  false,
 		},
 	}
 
-	// create the temp volume for logs
-	pgAdminLogVolume := corev1.Volume{Name: pgAdminLogVolumeName}
-	pgAdminLogVolume.VolumeSource = corev1.VolumeSource{
-		EmptyDir: &corev1.EmptyDirVolumeSource{
-			Medium: corev1.StorageMediumMemory,
-		},
-	}
-
-	// create the temp volume for gunicorn logs
-	gunicornLogVolume := corev1.Volume{Name: gunicornLogVolumeName}
-	gunicornLogVolume.VolumeSource = corev1.VolumeSource{
-		EmptyDir: &corev1.EmptyDirVolumeSource{
-			Medium: corev1.StorageMediumMemory,
-		},
-	}
-
 	// Volume used to write a custom config_system.py file in the initContainer
 	// which then loads the configs found in the `configVolume`
-	scriptVolume := corev1.Volume{Name: scriptVolumeName}
+	scriptVolume := corev1.Volume{Name: "pgadmin-config-system"}
 	scriptVolume.VolumeSource = corev1.VolumeSource{
 		EmptyDir: &corev1.EmptyDirVolumeSource{
 			Medium: corev1.StorageMediumMemory,
@@ -101,7 +75,7 @@ func pod(
 
 	// create a temp volume for restart pid/other/debugging use
 	// TODO: discuss tmp vol vs. persistent vol
-	tmpVolume := corev1.Volume{Name: tempVolumeName}
+	tmpVolume := corev1.Volume{Name: "tmp"}
 	tmpVolume.VolumeSource = corev1.VolumeSource{
 		EmptyDir: &corev1.EmptyDirVolumeSource{
 			Medium: corev1.StorageMediumMemory,
@@ -142,29 +116,21 @@ func pod(
 		},
 		VolumeMounts: []corev1.VolumeMount{
 			{
-				Name:      configVolumeName,
+				Name:      configVolume.Name,
 				MountPath: configMountPath,
 				ReadOnly:  true,
 			},
 			{
-				Name:      dataVolumeName,
+				Name:      dataVolume.Name,
 				MountPath: "/var/lib/pgadmin",
 			},
 			{
-				Name:      gunicornLogVolumeName,
-				MountPath: "/var/log/gunicorn",
-			},
-			{
-				Name:      pgAdminLogVolumeName,
-				MountPath: "/var/log/pgadmin",
-			},
-			{
-				Name:      scriptVolumeName,
+				Name:      scriptVolume.Name,
 				MountPath: scriptMountPath,
 				ReadOnly:  true,
 			},
 			{
-				Name:      tempVolumeName,
+				Name:      tmpVolume.Name,
 				MountPath: "/tmp",
 			},
 		},
@@ -199,7 +165,7 @@ func pod(
 		VolumeMounts: []corev1.VolumeMount{
 			// Volume to write a custom `config_system.py` file to.
 			{
-				Name:      scriptVolumeName,
+				Name:      scriptVolume.Name,
 				MountPath: scriptMountPath,
 				ReadOnly:  false,
 			},
@@ -210,8 +176,6 @@ func pod(
 	outPod.Volumes = []corev1.Volume{
 		configVolume,
 		dataVolume,
-		pgAdminLogVolume,
-		gunicornLogVolume,
 		scriptVolume,
 		tmpVolume,
 	}

internal/controller/standalone_pgadmin/pod_test.go

@@ -127,10 +127,6 @@ containers:
     readOnly: true
   - mountPath: /var/lib/pgadmin
     name: pgadmin-data
-  - mountPath: /var/log/gunicorn
-    name: gunicorn-log
-  - mountPath: /var/log/pgadmin
-    name: pgadmin-log
   - mountPath: /etc/pgadmin
     name: pgadmin-config-system
     readOnly: true
@@ -226,12 +222,6 @@ volumes:
 - name: pgadmin-data
   persistentVolumeClaim:
     claimName: ""
-- emptyDir:
-    medium: Memory
-  name: pgadmin-log
-- emptyDir:
-    medium: Memory
-  name: gunicorn-log
 - emptyDir:
     medium: Memory
     sizeLimit: 32Ki
@@ -352,10 +342,6 @@ containers:
     readOnly: true
   - mountPath: /var/lib/pgadmin
     name: pgadmin-data
-  - mountPath: /var/log/gunicorn
-    name: gunicorn-log
-  - mountPath: /var/log/pgadmin
-    name: pgadmin-log
   - mountPath: /etc/pgadmin
     name: pgadmin-config-system
     readOnly: true
@@ -455,12 +441,6 @@ volumes:
 - name: pgadmin-data
   persistentVolumeClaim:
     claimName: ""
-- emptyDir:
-    medium: Memory
-  name: pgadmin-log
-- emptyDir:
-    medium: Memory
-  name: gunicorn-log
 - emptyDir:
     medium: Memory
     sizeLimit: 32Ki

internal/controller/standalone_pgadmin/statefulset.go

@@ -122,24 +122,12 @@ func statefulset(
 	pod(pgadmin, configmap, &sts.Spec.Template.Spec, dataVolume)
 
 	if feature.Enabled(ctx, feature.OpenTelemetryLogs) {
-		// Mount for file_storage/pgadmin
-		pgAdminLogVolumeMount := corev1.VolumeMount{
-			Name:      "pgadmin-log",
-			MountPath: "/var/log/pgadmin",
-		}
-		// Mount for file_storage/gunicorn
-		gunicornLogVolumeMount := corev1.VolumeMount{
-			Name:      "gunicorn-log",
-			MountPath: "/var/log/gunicorn",
-		}
 		// Logs for gunicorn and pgadmin write to /var/lib/pgadmin/logs
 		dataVolumeMount := corev1.VolumeMount{
 			Name:      "pgadmin-data",
 			MountPath: "/var/lib/pgadmin",
 		}
 		volumeMounts := []corev1.VolumeMount{
-			pgAdminLogVolumeMount,
-			gunicornLogVolumeMount,
 			dataVolumeMount,
 		}