Add PgBouncer metrics

A generator converts YAML with comments to JSON to avoid errors at
runtime and comments in the binary.

Co-authored-by: Chris Bandy <[email protected]>
Issue: PGO-2054

Author: dsessler7

Makefile

@@ -254,16 +254,16 @@ generate-kuttl: ## Generate kuttl tests
 ##@ Generate
 
 .PHONY: check-generate
-check-generate: ## Check crd, deepcopy functions, and rbac generation
-check-generate: generate-crd
-check-generate: generate-deepcopy
-check-generate: generate-rbac
+check-generate: ## Check everything generated is also committed
+check-generate: generate
 	git diff --exit-code -- config/crd
 	git diff --exit-code -- config/rbac
+	git diff --exit-code -- internal/collector
 	git diff --exit-code -- pkg/apis
 
 .PHONY: generate
-generate: ## Generate crd, deepcopy functions, and rbac
+generate: ## Generate everything
+generate: generate-collector
 generate: generate-crd
 generate: generate-deepcopy
 generate: generate-rbac
@@ -276,6 +276,10 @@ generate-crd: tools/controller-gen
 		paths='./pkg/apis/...' \
 		output:dir='config/crd/bases' # {directory}/{group}_{plural}.yaml
 
+.PHONY: generate-collector
+generate-collector: ## Generate OTel Collector files
+	$(GO) generate ./internal/collector
+
 .PHONY: generate-deepcopy
 generate-deepcopy: ## Generate DeepCopy functions
 generate-deepcopy: tools/controller-gen

internal/collector/generate_json.go

@@ -0,0 +1,48 @@
+// Copyright 2024 - 2025 Crunchy Data Solutions, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build generate
+
+//go:generate go run generate_json.go
+
+package main
+
+import (
+	"bytes"
+	"log/slog"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"sigs.k8s.io/yaml"
+)
+
+func main() {
+	cwd := need(os.Getwd())
+	yamlFileNames := []string{}
+
+	slog.Info("Reading", "directory", cwd)
+	for _, entry := range need(os.ReadDir(cwd)) {
+		if entry.Type() == 0 && strings.HasSuffix(entry.Name(), ".yaml") {
+			yamlFileNames = append(yamlFileNames, entry.Name())
+		}
+	}
+
+	for _, yamlName := range yamlFileNames {
+		slog.Info("Reading", "file", yamlName)
+		jsonData := need(yaml.YAMLToJSONStrict(need(os.ReadFile(yamlName))))
+		jsonPath := filepath.Join("generated", strings.TrimSuffix(yamlName, ".yaml")+".json")
+
+		slog.Info("Writing", "file", jsonPath)
+		must(os.WriteFile(jsonPath, append(bytes.TrimSpace(jsonData), '\n'), 0o644))
+	}
+}
+
+func must(err error) { need(0, err) }
+func need[V any](v V, err error) V {
+	if err != nil {
+		panic(err)
+	}
+	return v
+}

internal/collector/generated/.gitattributes

@@ -0,0 +1,2 @@
+# https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github
+/*.json linguist-generated=true

internal/collector/generated/pgbouncer_metrics_queries.json

@@ -38,6 +38,7 @@ func AddToPod(
 	inInstanceConfigMap *corev1.ConfigMap,
 	outPod *corev1.PodSpec,
 	volumeMounts []corev1.VolumeMount,
+	sqlQueryPassword string,
 ) {
 	if !feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
 		return
@@ -69,6 +70,12 @@ func AddToPod(
 		Image:           "ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:0.116.1",
 		ImagePullPolicy: inCluster.Spec.ImagePullPolicy,
 		Command:         []string{"/otelcol-contrib", "--config", "/etc/otel-collector/config.yaml"},
+		Env: []corev1.EnvVar{
+			{
+				Name:  "PGPASSWORD",
+				Value: sqlQueryPassword,
+			},
+		},
 
 		SecurityContext: initialize.RestrictedSecurityContext(),
 		VolumeMounts:    append(volumeMounts, configVolumeMount),

internal/collector/instance.go

@@ -10,3 +10,4 @@ const OneSecondBatchProcessor = "batch/1s"
 const SubSecondBatchProcessor = "batch/200ms"
 const Prometheus = "prometheus"
 const Metrics = "metrics"
+const SqlQuery = "sqlquery"

internal/collector/naming.go

@@ -0,0 +1,53 @@
+// Copyright 2024 - 2025 Crunchy Data Solutions, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package collector
+
+import (
+	"context"
+
+	"github.com/crunchydata/postgres-operator/internal/feature"
+	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
+)
+
+func EnablePatroniMetrics(ctx context.Context,
+	inCluster *v1beta1.PostgresCluster,
+	outConfig *Config,
+) {
+	if feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+		// Add Prometheus exporter
+		outConfig.Exporters[Prometheus] = map[string]any{
+			"endpoint": "0.0.0.0:8889",
+		}
+
+		// Add Prometheus Receiver
+		outConfig.Receivers[Prometheus] = map[string]any{
+			"config": map[string]any{
+				"scrape_configs": []map[string]any{
+					{
+						"job_name": "patroni",
+						"scheme":   "https",
+						"tls_config": map[string]any{
+							"insecure_skip_verify": true,
+						},
+						"scrape_interval": "10s",
+						"static_configs": []map[string]any{
+							{
+								"targets": []string{
+									"0.0.0.0:8008",
+								},
+							},
+						},
+					},
+				},
+			},
+		}
+
+		// Add Metrics Pipeline
+		outConfig.Pipelines[Metrics] = Pipeline{
+			Receivers: []ComponentID{Prometheus},
+			Exporters: []ComponentID{Prometheus},
+		}
+	}
+}

internal/collector/patroni.go

@@ -0,0 +1,61 @@
+// Copyright 2024 - 2025 Crunchy Data Solutions, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package collector
+
+import (
+	"context"
+	_ "embed"
+	"encoding/json"
+	"fmt"
+	"slices"
+
+	"github.com/crunchydata/postgres-operator/internal/feature"
+	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
+)
+
+// https://pkg.go.dev/embed
+//
+//go:embed "generated/pgbouncer_metrics_queries.json"
+var pgBouncerMetricsQueries json.RawMessage
+
+// NewConfigForPgBouncerPod creates a config for the OTel collector container
+// that runs as a sidecar in the pgBouncer Pod
+func NewConfigForPgBouncerPod(
+	ctx context.Context, cluster *v1beta1.PostgresCluster, sqlQueryUsername string,
+) *Config {
+	if cluster.Spec.Proxy == nil || cluster.Spec.Proxy.PGBouncer == nil {
+		// pgBouncer is disabled; return nil
+		return nil
+	}
+
+	config := NewConfig()
+
+	EnablePgBouncerMetrics(ctx, config, sqlQueryUsername)
+
+	return config
+}
+
+func EnablePgBouncerMetrics(ctx context.Context, config *Config, sqlQueryUsername string) {
+	if feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
+		// Add Prometheus exporter
+		config.Exporters[Prometheus] = map[string]any{
+			"endpoint": "0.0.0.0:8889",
+		}
+
+		// Add SqlQuery Receiver
+		config.Receivers[SqlQuery] = map[string]any{
+			"driver": "postgres",
+			"datasource": fmt.Sprintf(`host=localhost dbname=pgbouncer port=5432 user=%s password=${env:PGPASSWORD}`,
+				sqlQueryUsername),
+			"queries": slices.Clone(pgBouncerMetricsQueries),
+		}
+
+		// Add Metrics Pipeline
+		config.Pipelines[Metrics] = Pipeline{
+			Receivers: []ComponentID{SqlQuery},
+			Exporters: []ComponentID{Prometheus},
+		}
+	}
+}

internal/collector/pgbouncer.go

@@ -0,0 +1,99 @@
+# This list of queries configures an OTel SQL Query Receiver to read pgMonitor
+# metrics from PgBouncer.
+#
+# https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/-/receiver/sqlqueryreceiver#metrics-queries
+# https://github.com/CrunchyData/pgmonitor/blob/v5.1.1/sql_exporter/common/crunchy_pgbouncer_121_collector.yml
+
+  - sql: "SHOW CLIENTS"
+    metrics:
+      - metric_name: ccp_pgbouncer_clients_wait_seconds
+        value_column: wait
+        attribute_columns: ["database", "user", "state", "application_name", "link"]
+        description: "Current waiting time in seconds"
+
+  - sql: "SHOW DATABASES"
+    metrics:
+      - metric_name: ccp_pgbouncer_databases_pool_size
+        value_column: pool_size
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: "Maximum number of server connections"
+
+      - metric_name: ccp_pgbouncer_databases_min_pool_size
+        value_column: min_pool_size
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: "Minimum number of server connections"
+
+      - metric_name: ccp_pgbouncer_databases_reserve_pool
+        value_column: reserve_pool
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: "Maximum number of additional connections for this database"
+
+      - metric_name: ccp_pgbouncer_databases_max_connections
+        value_column: max_connections
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: >-
+          Maximum number of allowed connections for this database,
+          as set by max_db_connections, either globally or per database
+
+      - metric_name: ccp_pgbouncer_databases_current_connections
+        value_column: current_connections
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: "Current number of connections for this database"
+
+      - metric_name: ccp_pgbouncer_databases_paused
+        value_column: paused
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: "1 if this database is currently paused, else 0"
+
+      - metric_name: ccp_pgbouncer_databases_disabled
+        value_column: disabled
+        attribute_columns: ["name", "host", "port", "database", "force_user", "pool_mode"]
+        description: "1 if this database is currently disabled, else 0"
+
+  - sql: "SHOW LISTS"
+    metrics:
+      - metric_name: ccp_pgbouncer_lists_item_count
+        value_column: items
+        attribute_columns: ["list"]
+        description: "Count of items registered with pgBouncer"
+
+  - sql: "SHOW POOLS"
+    metrics:
+      - metric_name: ccp_pgbouncer_pools_client_active
+        value_column: cl_active
+        attribute_columns: ["database", "user"]
+        description: >-
+          Client connections that are either linked to server connections or
+          are idle with no queries waiting to be processed
+
+      - metric_name: ccp_pgbouncer_pools_client_waiting
+        value_column: cl_waiting
+        attribute_columns: ["database", "user"]
+        description: "Client connections that have sent queries but have not yet got a server connection"
+
+      - metric_name: ccp_pgbouncer_pools_server_active
+        value_column: sv_active
+        attribute_columns: ["database", "user"]
+        description: "Server connections that are linked to a client"
+
+      - metric_name: ccp_pgbouncer_pools_server_idle
+        value_column: sv_idle
+        attribute_columns: ["database", "user"]
+        description: "Server connections that are unused and immediately usable for client queries"
+
+      - metric_name: ccp_pgbouncer_pools_server_used
+        value_column: sv_used
+        attribute_columns: ["database", "user"]
+        description: >-
+          Server connections that have been idle for more than server_check_delay,
+          so they need server_check_query to run on them before they can be used again
+
+  - sql: "SHOW SERVERS"
+    metrics:
+      - metric_name: ccp_pgbouncer_servers_close_needed
+        value_column: close_needed
+        attribute_columns: ["database", "user", "state", "application_name", "link"]
+        description: >-
+          1 if the connection will be closed as soon as possible,
+          because a configuration file reload or DNS update changed the connection information
+          or RECONNECT was issued

internal/collector/pgbouncer_metrics_queries.yaml

@@ -7,47 +7,13 @@ package collector
 import (
 	"context"
 
-	"github.com/crunchydata/postgres-operator/internal/feature"
+	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 )
 
-func NewConfigForPostgresPod(ctx context.Context) *Config {
+func NewConfigForPostgresPod(ctx context.Context, inCluster *v1beta1.PostgresCluster) *Config {
 	config := NewConfig()
 
-	if feature.Enabled(ctx, feature.OpenTelemetryMetrics) {
-		// Add Prometheus exporter
-		config.Exporters[Prometheus] = map[string]any{
-			"endpoint": "0.0.0.0:8889",
-		}
-
-		// Add Prometheus Receiver
-		config.Receivers[Prometheus] = map[string]any{
-			"config": map[string]any{
-				"scrape_configs": []map[string]any{
-					{
-						"job_name": "patroni",
-						"scheme":   "https",
-						"tls_config": map[string]any{
-							"insecure_skip_verify": true,
-						},
-						"scrape_interval": "10s",
-						"static_configs": []map[string]any{
-							{
-								"targets": []string{
-									"0.0.0.0:8008",
-								},
-							},
-						},
-					},
-				},
-			},
-		}
-
-		// Add Metrics Pipeline
-		config.Pipelines[Metrics] = Pipeline{
-			Receivers: []ComponentID{Prometheus},
-			Exporters: []ComponentID{Prometheus},
-		}
-	}
+	EnablePatroniMetrics(ctx, inCluster, config)
 
 	return config
 }