Merge pull request #2675 from saschagrunert/heaptrack

Add Heaptrack client config API

Author: openshift-merge-bot[bot]

pkg/client/client.go

@@ -13,6 +13,7 @@ import (
 	"path/filepath"
 	"slices"
 	"strconv"
+	"strings"
 	"sync"
 	"syscall"
 	"time"
@@ -28,10 +29,11 @@ import (
 )
 
 const (
-	binaryName     = "conmonrs"
-	socketName     = "conmon.sock"
-	pidFileName    = "pidfile"
-	defaultTimeout = 10 * time.Second
+	binaryName          = "conmonrs"
+	socketName          = "conmon.sock"
+	pidFileName         = "pidfile"
+	defaultTimeout      = 10 * time.Second
+	heaptrackBinaryName = "heaptrack"
 )
 
 var (
@@ -97,6 +99,9 @@ type ConmonServerConfig struct {
 
 	// Tracing can be used to enable OpenTelemetry tracing.
 	Tracing *Tracing
+
+	// Heaptrack can be used to memory profile the server.
+	Heaptrack *Heaptrack
 }
 
 // Tracing is the structure for managing server-side OpenTelemetry tracing.
@@ -112,6 +117,20 @@ type Tracing struct {
 	Tracer trace.Tracer
 }
 
+// Heaptrack is the structure for configuring the memory profiling.
+type Heaptrack struct {
+	// Enabled tells the server to run with heaptrack enabled.
+	Enabled bool
+
+	// BinaryPath is the path to the heaptrack binary. Can be empty to lookup
+	// the local $PATH variable.
+	BinaryPath string
+
+	// OutputPath is the storage path for the memory profile. Can be empty to
+	// use the current directory for storing the profile.
+	OutputPath string
+}
+
 // NewConmonServerConfig creates a new ConmonServerConfig instance for the
 // required arguments. Optional arguments are pointing to their corresponding
 // default values.
@@ -191,6 +210,10 @@ func New(config *ConmonServerConfig) (client *ConmonClient, retErr error) {
 
 	cl.serverPID = pid
 
+	if config.Heaptrack != nil && config.Heaptrack.Enabled {
+		go cl.attachHeaptrack(config, pid)
+	}
+
 	// Cleanup the background server process
 	// if we fail any of the next steps
 	defer func() {
@@ -1642,3 +1665,34 @@ func (c *ConmonClient) ServePortForwardContainer(
 
 	return &ServePortForwardContainerResult{URL: url}, nil
 }
+
+func (c *ConmonClient) attachHeaptrack(config *ConmonServerConfig, pid uint32) {
+	c.logger.Infof("Attaching heaptrack to PID %d", pid)
+
+	args := []string{"--record-only"}
+
+	if config.Heaptrack.OutputPath != "" {
+		args = append(args, "-o", config.Heaptrack.OutputPath)
+	}
+
+	args = append(args, "-p", strconv.FormatUint(uint64(pid), 10))
+
+	entrypoint := config.Heaptrack.BinaryPath
+	if entrypoint == "" {
+		path, err := exec.LookPath(heaptrackBinaryName)
+		if err != nil {
+			c.logger.Errorf("Unable to find heaptrack path: %v", err)
+
+			return
+		}
+
+		entrypoint = path
+	}
+
+	c.logger.Debugf("Running heaptrack via: %s %s", entrypoint, strings.Join(args, " "))
+
+	cmd := exec.Command(entrypoint, args...)
+	if err := cmd.Run(); err != nil {
+		c.logger.Errorf("Unable to run heaptrack: %v", err)
+	}
+}