From c6993bda1562cedbb776998e44fcc370e183ecdb Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Tue, 15 Feb 2022 18:16:12 -0500 Subject: [PATCH] debug: update CLI docs To clarify how trace is captured. Also remove the minimum seconds check, because that is already done in prepare() --- command/debug/debug.go | 8 ++------ website/content/commands/debug.mdx | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/command/debug/debug.go b/command/debug/debug.go index acbe36d93..587462a4b 100644 --- a/command/debug/debug.go +++ b/command/debug/debug.go @@ -400,15 +400,11 @@ func makeIntervalDir(base string, now time.Time) (string, error) { func (c *cmd) captureLongRunning(ctx context.Context) error { g := new(errgroup.Group) - // Capture a profile/trace with a minimum of 1s - s := c.duration.Seconds() - if s < 1 { - s = 1 - } + if c.captureTarget(targetProfiles) { g.Go(func() error { // use ctx without a timeout to allow the profile to finish sending - return c.captureProfile(ctx, s) + return c.captureProfile(ctx, c.duration.Seconds()) }) g.Go(func() error { diff --git a/website/content/commands/debug.mdx b/website/content/commands/debug.mdx index ded40e58e..58434cb16 100644 --- a/website/content/commands/debug.mdx +++ b/website/content/commands/debug.mdx @@ -78,7 +78,7 @@ information when `debug` is running. By default, it captures all information. | `members` | A list of all the WAN and LAN members in the cluster. | | `metrics` | Metrics from the in-memory metrics endpoint in the target, captured at the interval. | | `logs` | `DEBUG` level logs for the target agent, captured for the duration. | -| `pprof` | Golang heap, CPU, goroutine, and trace profiling. CPU and traces are captured for `duration` in a single file while heap and goroutine are separate snapshots for each `interval`. This information is not retrieved unless [`enable_debug`](/docs/agent/options#enable_debug) is set to `true` on the target agent or ACLs are enable and an ACL token with `operator:read` is provided. | +| `pprof` | Golang heap, CPU, goroutine, and trace profiling. CPU profile is captured for `duration` in a single file, trace is captured for a single `interval`, while heap and goroutine are separate snapshots for each `interval`. This information is not retrieved unless [`enable_debug`](/docs/agent/options#enable_debug) is set to `true` on the target agent or ACLs are enable and an ACL token with `operator:read` is provided. | ## Examples