feat: add pprof-server support (#538)

Closes #421

Signed-off-by: Armando Ruocco <[email protected]>

Author: armru

.wordlist.txt

@@ -128,6 +128,7 @@ pluginConfiguration
 podName
 postgres
 postgresql
+pprof
 primaryUpdateStrategy
 rbac
 rc

internal/cmd/instance/main.go

@@ -52,6 +52,13 @@ func NewCmd() *cobra.Command {
 		},
 	}
 
+	cmd.Flags().String("pprof-server",
+		"",
+		"The address where pprof server should be exposed, for example: 0.0.0.0:6061. "+
+			"Empty string means disabled. Disabled by default",
+	)
+	_ = viper.BindPFlag("pprof-server", cmd.Flags().Lookup("pprof-server"))
+
 	_ = viper.BindEnv("namespace", "NAMESPACE")
 	_ = viper.BindEnv("cluster-name", "CLUSTER_NAME")
 	_ = viper.BindEnv("pod-name", "POD_NAME")

internal/cnpgi/instance/manager.go

@@ -52,7 +52,8 @@ func Start(ctx context.Context) error {
 	namespace := viper.GetString("namespace")
 
 	controllerOptions := ctrl.Options{
-		Scheme: scheme,
+		PprofBindAddress: viper.GetString("pprof-server"),
+		Scheme:           scheme,
 		Client: client.Options{
 			// Important: the caching options below are used by
 			// controller-runtime only.

web/docs/misc.md

@@ -74,3 +74,24 @@ spec:
 
 For a complete list of supported options, refer to the
 [official Barman Cloud documentation](https://docs.pgbarman.org/release/latest/).
+
+## Enable the pprof debug server for the sidecar
+
+You can enable the instance sidecar's pprof debug HTTP server by adding the `--pprof-server=<address>` flag to the container's
+arguments via `.spec.instanceSidecarConfiguration.additionalContainerArgs`.
+
+Pass a bind address in the form `<host>:<port>` (for example, `0.0.0.0:6061`).
+An empty value disables the server (disabled by default).
+
+### Example
+
+```yaml
+apiVersion: barmancloud.cnpg.io/v1
+kind: ObjectStore
+metadata:
+  name: my-store
+spec:
+  instanceSidecarConfiguration:
+    additionalContainerArgs:
+      - "--pprof-server=0.0.0.0:6061"
+```