When OpenTelemetryMetrics enabled, ~ExporterEnabled

Author: tony-landreth

internal/controller/postgrescluster/pgmonitor.go

@@ -62,7 +62,7 @@ func (r *Reconciler) reconcilePGMonitorExporter(ctx context.Context,
 	// the `EnableExporterInPostgreSQL` funcs; that way we are always running
 	// that function against an updated and running pod.
 
-	if pgmonitor.ExporterEnabled(cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if pgmonitor.ExporterEnabled(ctx, cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		sql, err := os.ReadFile(fmt.Sprintf("%s/pg%d/setup.sql", pgmonitor.GetQueriesConfigDir(ctx), cluster.Spec.PostgresVersion))
 		if err != nil {
 			return err
@@ -99,7 +99,7 @@ func (r *Reconciler) reconcilePGMonitorExporter(ctx context.Context,
 		return pgmonitor.EnableExporterInPostgreSQL(ctx, exec, monitoringSecret, pgmonitor.ExporterDB, setup)
 	}
 
-	if !pgmonitor.ExporterEnabled(cluster) && !feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if !pgmonitor.ExporterEnabled(ctx, cluster) && !feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		action = func(ctx context.Context, exec postgres.Executor) error {
 			return pgmonitor.DisableExporterInPostgreSQL(ctx, exec)
 		}
@@ -157,7 +157,7 @@ func (r *Reconciler) reconcileMonitoringSecret(
 		return nil, err
 	}
 
-	if !pgmonitor.ExporterEnabled(cluster) && !feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if !pgmonitor.ExporterEnabled(ctx, cluster) && !feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		// TODO: Checking if the exporter is enabled to determine when monitoring
 		// secret should be created. If more tools are added to the monitoring
 		// suite, they could need the secret when the exporter is not enabled.
@@ -235,7 +235,7 @@ func addPGMonitorExporterToInstancePodSpec(
 	template *corev1.PodTemplateSpec,
 	exporterQueriesConfig, exporterWebConfig *corev1.ConfigMap) {
 
-	if !pgmonitor.ExporterEnabled(cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if !pgmonitor.ExporterEnabled(ctx, cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		return
 	}
 
@@ -385,7 +385,7 @@ func (r *Reconciler) reconcileExporterWebConfig(ctx context.Context,
 		return nil, err
 	}
 
-	if !pgmonitor.ExporterEnabled(cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) || cluster.Spec.Monitoring.PGMonitor.Exporter.CustomTLSSecret == nil {
+	if !pgmonitor.ExporterEnabled(ctx, cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) || cluster.Spec.Monitoring.PGMonitor.Exporter.CustomTLSSecret == nil {
 		// We could still have a NotFound error here so check the err.
 		// If no error that means the configmap is found and needs to be deleted
 		if err == nil {
@@ -442,7 +442,7 @@ func (r *Reconciler) reconcileExporterQueriesConfig(ctx context.Context,
 		return nil, err
 	}
 
-	if !pgmonitor.ExporterEnabled(cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if !pgmonitor.ExporterEnabled(ctx, cluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		// We could still have a NotFound error here so check the err.
 		// If no error that means the configmap is found and needs to be deleted
 		if err == nil {

internal/controller/postgrescluster/pgmonitor_test.go

@@ -39,7 +39,7 @@ func testExporterCollectorsAnnotation(t *testing.T, ctx context.Context, cluster
 				naming.PostgresExporterCollectorsAnnotation: "wrong-value",
 			})
 
-			assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, queriesConfig, webConfig))
+			addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, queriesConfig, webConfig)
 
 			assert.Equal(t, len(template.Spec.Containers), 1)
 			container := template.Spec.Containers[0]
@@ -56,7 +56,7 @@ func testExporterCollectorsAnnotation(t *testing.T, ctx context.Context, cluster
 				naming.PostgresExporterCollectorsAnnotation: "None",
 			})
 
-			assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, queriesConfig, webConfig))
+			addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, queriesConfig, webConfig)
 
 			assert.Equal(t, len(template.Spec.Containers), 1)
 			container := template.Spec.Containers[0]
@@ -71,7 +71,7 @@ func testExporterCollectorsAnnotation(t *testing.T, ctx context.Context, cluster
 					naming.PostgresExporterCollectorsAnnotation: "none",
 				})
 
-				assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, queriesConfig, webConfig))
+				addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, queriesConfig, webConfig)
 				assert.Assert(t, cmp.Contains(strings.Join(template.Spec.Containers[0].Command, "\n"), "--[no-]collector"))
 			})
 		})
@@ -100,7 +100,7 @@ func TestAddPGMonitorExporterToInstancePodSpec(t *testing.T) {
 
 	t.Run("ExporterDisabled", func(t *testing.T) {
 		template := &corev1.PodTemplateSpec{}
-		assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, nil, nil))
+		addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, nil, nil)
 		assert.DeepEqual(t, template, &corev1.PodTemplateSpec{})
 	})
 
@@ -121,8 +121,7 @@ func TestAddPGMonitorExporterToInstancePodSpec(t *testing.T) {
 			},
 		}
 
-		assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, nil))
-
+		addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, nil)
 		assert.Equal(t, len(template.Spec.Containers), 2)
 		container := template.Spec.Containers[1]
 
@@ -205,8 +204,7 @@ volumeMounts:
 			},
 		}
 
-		assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, nil))
-
+		addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, nil)
 		assert.Equal(t, len(template.Spec.Containers), 2)
 		container := template.Spec.Containers[1]
 
@@ -255,8 +253,7 @@ name: exporter-config
 			},
 		}
 
-		assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, nil))
-
+		addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, nil)
 		assert.Equal(t, len(template.Spec.Containers), 2)
 		container := template.Spec.Containers[1]
 
@@ -301,8 +298,7 @@ name: exporter-config
 		testConfigMap := new(corev1.ConfigMap)
 		testConfigMap.Name = "test-web-conf"
 
-		assert.NilError(t, addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, testConfigMap))
-
+		addPGMonitorExporterToInstancePodSpec(ctx, cluster, template, exporterQueriesConfig, testConfigMap)
 		assert.Equal(t, len(template.Spec.Containers), 2)
 		container := template.Spec.Containers[1]
 

internal/pgmonitor/postgres.go

@@ -24,7 +24,7 @@ const (
 // PostgreSQLHBAs provides the Postgres HBA rules for allowing the monitoring
 // exporter to be accessible
 func PostgreSQLHBAs(ctx context.Context, inCluster *v1beta1.PostgresCluster, outHBAs *postgres.HBAs) {
-	if ExporterEnabled(inCluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if ExporterEnabled(ctx, inCluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		// Limit the monitoring user to local connections using SCRAM.
 		outHBAs.Mandatory = append(outHBAs.Mandatory,
 			postgres.NewHBA().TCP().User(MonitoringUser).Method("scram-sha-256").Network("127.0.0.0/8"),
@@ -36,7 +36,7 @@ func PostgreSQLHBAs(ctx context.Context, inCluster *v1beta1.PostgresCluster, out
 // PostgreSQLParameters provides additional required configuration parameters
 // that Postgres needs to support monitoring
 func PostgreSQLParameters(ctx context.Context, inCluster *v1beta1.PostgresCluster, outParameters *postgres.Parameters) {
-	if ExporterEnabled(inCluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+	if ExporterEnabled(ctx, inCluster) || feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		// Exporter expects that shared_preload_libraries are installed
 		// pg_stat_statements: https://access.crunchydata.com/documentation/pgmonitor/latest/exporter/
 		// pgnodemx: https://github.com/CrunchyData/pgnodemx

internal/pgmonitor/util.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"os"
 
+	"github.com/crunchydata/postgres-operator/internal/feature"
 	"github.com/crunchydata/postgres-operator/internal/logging"
 	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 )
@@ -26,7 +27,7 @@ func GetQueriesConfigDir(ctx context.Context) string {
 }
 
 // ExporterEnabled returns true if the monitoring exporter is enabled
-func ExporterEnabled(cluster *v1beta1.PostgresCluster) bool {
+func ExporterEnabled(ctx context.Context, cluster *v1beta1.PostgresCluster) bool {
 	if cluster.Spec.Monitoring == nil {
 		return false
 	}
@@ -36,5 +37,8 @@ func ExporterEnabled(cluster *v1beta1.PostgresCluster) bool {
 	if cluster.Spec.Monitoring.PGMonitor.Exporter == nil {
 		return false
 	}
+	if feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+		return false
+	}
 	return true
 }

internal/pgmonitor/util_test.go

@@ -5,24 +5,34 @@
 package pgmonitor
 
 import (
+	"context"
 	"testing"
 
 	"gotest.tools/v3/assert"
 
+	"github.com/crunchydata/postgres-operator/internal/feature"
 	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 )
 
 func TestExporterEnabled(t *testing.T) {
 	cluster := &v1beta1.PostgresCluster{}
-	assert.Assert(t, !ExporterEnabled(cluster))
+	ctx := context.Background()
+	assert.Assert(t, !ExporterEnabled(ctx, cluster))
 
 	cluster.Spec.Monitoring = &v1beta1.MonitoringSpec{}
-	assert.Assert(t, !ExporterEnabled(cluster))
+	assert.Assert(t, !ExporterEnabled(ctx, cluster))
 
 	cluster.Spec.Monitoring.PGMonitor = &v1beta1.PGMonitorSpec{}
-	assert.Assert(t, !ExporterEnabled(cluster))
+	assert.Assert(t, !ExporterEnabled(ctx, cluster))
 
 	cluster.Spec.Monitoring.PGMonitor.Exporter = &v1beta1.ExporterSpec{}
-	assert.Assert(t, ExporterEnabled(cluster))
+	assert.Assert(t, ExporterEnabled(ctx, cluster))
 
+	gate := feature.NewGate()
+	assert.NilError(t, gate.SetFromMap(map[string]bool{
+		feature.OpenTelemetryMetrics: true,
+	}))
+	ctx = feature.NewContext(ctx, gate)
+	cluster.Spec.Monitoring.PGMonitor.Exporter = &v1beta1.ExporterSpec{}
+	assert.Assert(t, !ExporterEnabled(ctx, cluster))
 }