luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

debug: update CLI docs 

To clarify how trace is captured.

Also remove the minimum seconds check, because that is already done in prepare()
This commit is contained in:
Daniel Nephin 2022-02-15 18:16:12 -05:00
parent 5bd73fc218
commit c6993bda15
2 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
command/debug/debug.go
View File

@ -400,15 +400,11 @@ func makeIntervalDir(base string, now time.Time) (string, error) {
func (c *cmd) captureLongRunning(ctx context.Context) error { func (c *cmd) captureLongRunning(ctx context.Context) error {
g := new(errgroup.Group) 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) { if c.captureTarget(targetProfiles) {
g.Go(func() error { g.Go(func() error {
// use ctx without a timeout to allow the profile to finish sending // 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 { g.Go(func() error {

2
website/content/commands/debug.mdx
View File

@ -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. | | `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. | | `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. | | `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 ## Examples