Enable pprof for elastic-agent and beats (#28983) (#29081)

Enable the /debug/pprof/ endpoints for all beats that the elastic-agent
starts. Enable the pprof endpoints on elastic-agent if
agent.monitoring.pprof is true (default true). Agent endpoint can be
toggled in case it is located on a network and not localhost/unix
socket/windows N pipe.

(cherry picked from commit 6ad6bee)

Co-authored-by: Michel Laterman <[email protected]>

x-pack/elastic-agent/CHANGELOG.next.asciidoc

@@ -149,3 +149,4 @@
 - Add diagnostics command to gather beat metadata. {pull}28265[28265]
 - Add diagnostics collect command to gather beat metadata, config, policy, and logs and bundle it into an archive. {pull}28461[28461]
 - Add `KIBANA_FLEET_SERVICE_TOKEN` to Elastic Agent container. {pull}28096[28096]
+- Enable pprof endpoints for beats processes. Allow pprof endpoints for elastic-agent if enabled. {pull}28983[28983]

x-pack/elastic-agent/_meta/config/common.p2.yml.tmpl

@@ -33,6 +33,9 @@ inputs:
 #   logs: true
 #   # enables metrics monitoring
 #   metrics: true
+#   # exposes /debug/pprof/ endpoints
+#   # recommended that these endpoints are only enabled if the monitoring endpoint is set to localhost
+#   pprof: true
 #   # exposes agent metrics using http, by default sockets and named pipes are used
 #   http:
 #       # enables http endpoint

x-pack/elastic-agent/_meta/config/common.reference.p2.yml.tmpl

@@ -107,6 +107,9 @@ inputs:
 #   logs: false
 #   # enables metrics monitoring
 #   metrics: false
+#   # exposes /debug/pprof/ endpoints
+#   # recommended that these endpoints are only enabled if the monitoring endpoint is set to localhost
+#   pprof: true
 #   # exposes agent metrics using http, by default sockets and named pipes are used
 #   http:
 #       # enables http endpoint

x-pack/elastic-agent/_meta/config/elastic-agent.docker.yml.tmpl

@@ -107,6 +107,9 @@ inputs:
 #   logs: false
 #   # enables metrics monitoring
 #   metrics: false
+#   # exposes /debug/pprof/ endpoints
+#   # recommended that these endpoints are only enabled if the monitoring endpoint is set to localhost
+#   pprof: true
 #   # exposes agent metrics using http, by default sockets and named pipes are used
 #   http:
 #       # enables http endpoint

x-pack/elastic-agent/elastic-agent.docker.yml

@@ -107,6 +107,9 @@ inputs:
 #   logs: false
 #   # enables metrics monitoring
 #   metrics: false
+#   # exposes /debug/pprof/ endpoints
+#   # recommended that these endpoints are only enabled if the monitoring endpoint is set to localhost
+#   pprof: true
 #   # exposes agent metrics using http, by default sockets and named pipes are used
 #   http:
 #       # enables http endpoint

x-pack/elastic-agent/elastic-agent.reference.yml

@@ -113,6 +113,9 @@ inputs:
 #   logs: false
 #   # enables metrics monitoring
 #   metrics: false
+#   # exposes /debug/pprof/ endpoints
+#   # recommended that these endpoints are only enabled if the monitoring endpoint is set to localhost
+#   pprof: true
 #   # exposes agent metrics using http, by default sockets and named pipes are used
 #   http:
 #       # enables http endpoint

x-pack/elastic-agent/elastic-agent.yml

@@ -39,6 +39,9 @@ inputs:
 #   logs: true
 #   # enables metrics monitoring
 #   metrics: true
+#   # exposes /debug/pprof/ endpoints
+#   # recommended that these endpoints are only enabled if the monitoring endpoint is set to localhost
+#   pprof: true
 #   # exposes agent metrics using http, by default sockets and named pipes are used
 #   http:
 #       # enables http endpoint

x-pack/elastic-agent/pkg/agent/cmd/run.go

@@ -313,6 +313,10 @@ func setupMetrics(agentInfo *info.AgentInfo, logger *logger.Logger, operatingSys
 	}
 	s.Start()
 
+	if cfg.Pprof {
+		s.AttachPprof()
+	}
+
 	// return server stopper
 	return s.Stop, nil
 }

x-pack/elastic-agent/pkg/core/monitoring/beats/beats_monitor.go

@@ -122,6 +122,7 @@ func (b *Monitor) EnrichArgs(spec program.Spec, pipelineID string, args []string
 		appendix = append(appendix,
 			"-E", "http.enabled=true",
 			"-E", "http.host="+endpoint,
+			"-E", "http.pprof.enabled=true",
 		)
 	}
 

x-pack/elastic-agent/pkg/core/monitoring/config/config.go

@@ -15,6 +15,7 @@ type MonitoringConfig struct {
 	LogMetrics     bool                  `yaml:"-" config:"-"`
 	HTTP           *MonitoringHTTPConfig `yaml:"http" config:"http"`
 	Namespace      string                `yaml:"namespace" config:"namespace"`
+	Pprof          bool                  `yaml:"pprof" config:"pprof"`
 }
 
 // MonitoringHTTPConfig is a config defining HTTP endpoint published by agent
@@ -38,5 +39,6 @@ func DefaultConfig() *MonitoringConfig {
 			Port:    defaultPort,
 		},
 		Namespace: defaultNamespace,
+		Pprof:     true,
 	}
 }