Backport of operator debug: fix pprof interval handling into release/…

…1.5.x (#20214)

Co-authored-by: Tim Gross <tgross@hashicorp.com>

.changelog/20206.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+cli: Fixed a bug where `operator debug` did not respect the `-pprof-interval` flag and would take only one profile
+```

command/operator_debug.go

@@ -195,8 +195,8 @@ Debug Options:
 
   -pprof-interval=<pprof-interval>
     The interval between pprof collections. Set interval equal to
-    duration to capture a single snapshot. Defaults to 250ms or
-   -pprof-duration, whichever is less.
+    duration to capture a single snapshot. Defaults to 30s or
+    -pprof-duration, whichever is more.
 
   -server-id=<server1>,<server2>
     Comma separated list of Nomad server names to monitor for logs, API
@@ -365,7 +365,7 @@ func (c *OperatorDebugCommand) Run(args []string) int {
 	flags.BoolVar(&allowStale, "stale", false, "")
 	flags.StringVar(&output, "output", "", "")
 	flags.StringVar(&pprofDuration, "pprof-duration", "1s", "")
-	flags.StringVar(&pprofInterval, "pprof-interval", "250ms", "")
+	flags.StringVar(&pprofInterval, "pprof-interval", "30s", "")
 	flags.BoolVar(&c.verbose, "verbose", false, "")
 
 	c.consul = &external{tls: &api.TLSConfig{}}
@@ -432,7 +432,7 @@ func (c *OperatorDebugCommand) Run(args []string) int {
 		c.Ui.Error(fmt.Sprintf("Error parsing pprof-interval: %s: %s", pprofInterval, err.Error()))
 		return 1
 	}
-	if pi.Seconds() > pd.Seconds() {
+	if pi.Seconds() < pd.Seconds() {
 		pi = pd
 	}
 	c.pprofInterval = pi
@@ -1028,27 +1028,27 @@ func (c *OperatorDebugCommand) collectPprof(path, id string, client *api.Client,
 
 	// goroutine debug type 1 = legacy text format for human readable output
 	opts.Debug = 1
-	c.savePprofProfile(path, "goroutine", opts, client)
+	c.savePprofProfile(path, "goroutine", opts, client, interval)
 
 	// goroutine debug type 2 = goroutine stacks in panic format
 	opts.Debug = 2
-	c.savePprofProfile(path, "goroutine", opts, client)
+	c.savePprofProfile(path, "goroutine", opts, client, interval)
 
 	// Reset to pprof binary format
 	opts.Debug = 0
 
-	c.savePprofProfile(path, "goroutine", opts, client)    // Stack traces of all current goroutines
-	c.savePprofProfile(path, "trace", opts, client)        // A trace of execution of the current program
-	c.savePprofProfile(path, "heap", opts, client)         // A sampling of memory allocations of live objects. You can specify the gc GET parameter to run GC before taking the heap sample.
-	c.savePprofProfile(path, "allocs", opts, client)       // A sampling of all past memory allocations
-	c.savePprofProfile(path, "threadcreate", opts, client) // Stack traces that led to the creation of new OS threads
+	c.savePprofProfile(path, "goroutine", opts, client, interval)    // Stack traces of all current goroutines
+	c.savePprofProfile(path, "trace", opts, client, interval)        // A trace of execution of the current program
+	c.savePprofProfile(path, "heap", opts, client, interval)         // A sampling of memory allocations of live objects. You can specify the gc GET parameter to run GC before taking the heap sample.
+	c.savePprofProfile(path, "allocs", opts, client, interval)       // A sampling of all past memory allocations
+	c.savePprofProfile(path, "threadcreate", opts, client, interval) // Stack traces that led to the creation of new OS threads
 }
 
 // savePprofProfile retrieves a pprof profile and writes to disk
-func (c *OperatorDebugCommand) savePprofProfile(path string, profile string, opts api.PprofOptions, client *api.Client) {
-	fileName := fmt.Sprintf("%s.prof", profile)
+func (c *OperatorDebugCommand) savePprofProfile(path string, profile string, opts api.PprofOptions, client *api.Client, interval int) {
+	fileName := fmt.Sprintf("%s_%04d.prof", profile, interval)
 	if opts.Debug > 0 {
-		fileName = fmt.Sprintf("%s-debug%d.txt", profile, opts.Debug)
+		fileName = fmt.Sprintf("%s-debug%d_%04d.txt", profile, opts.Debug, interval)
 	}
 
 	bs, err := retrievePprofProfile(profile, opts, client, c.queryOpts())

command/operator_debug_test.go

@@ -451,14 +451,14 @@ func TestDebug_CapturedFiles(t *testing.T) {
 	}
 
 	pprofFiles := []string{
-		"allocs.prof",
-		"goroutine-debug1.txt",
-		"goroutine-debug2.txt",
-		"goroutine.prof",
-		"heap.prof",
+		"allocs_0000.prof",
+		"goroutine-debug1_0000.txt",
+		"goroutine-debug2_0000.txt",
+		"goroutine_0000.prof",
+		"heap_0000.prof",
 		"profile_0000.prof",
-		"threadcreate.prof",
-		"trace.prof",
+		"threadcreate_0000.prof",
+		"trace_0000.prof",
 	}
 
 	clientFiles := []string{

website/content/docs/commands/operator/debug.mdx

@@ -67,10 +67,9 @@ true.
 - `-pprof-duration=<duration>`: Duration for pprof
   collection. Defaults to 1s or `-duration`, whichever is less.
 
-- `-pprof-interval=<pprof-interval>`: The interval between pprof
-    collections. Set interval equal to duration to capture a single
-    snapshot. Defaults to 250ms or `-pprof-duration`, whichever is
-    less.
+- `-pprof-interval=30s`: The interval between pprof collections. Set interval
+    equal to pprof duration to capture a single snapshot. Defaults to 30s or
+    `-pprof-duration`, whichever is more.
 
 - `-server-id=<server1>,<server2>`: Comma separated list of Nomad server names to
   monitor for logs, API outputs, and pprof profiles. Accepts server names, "leader", or