Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
absolutelightning committed Jun 7, 2023
1 parent 9d72a26 commit 9b9bb8d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions website/content/commands/debug.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ or otherwise.
`Usage: consul debug [options]`

By default, the debug command will capture an archive at the current path for
all targets for 2 minutes.
all targets for 5 minutes.

#### Command Options

- `-duration` - Optional, the total time to capture data for from the target agent. Must
be greater than the interval and longer than 10 seconds. Defaults to 2 minutes.
be greater than the interval and longer than 10 seconds. Defaults to 5 minutes.

- `-interval` - Optional, the interval at which to capture dynamic data, such as heap
and metrics. Must be longer than 5 seconds. Defaults to 30 seconds.
Expand Down Expand Up @@ -79,7 +79,7 @@ information when `debug` is running. By default, it captures all information.
| `host` | Information about resources on the host running the target agent such as CPU, memory, and disk. |
| `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. |
| `logs` | `TRACE` 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`](/consul/docs/agent/config/config-files#enable_debug) is set to `true` on the target agent or ACLs are enable and an ACL token with `operator:read` is provided. |

## Examples
Expand Down

0 comments on commit 9b9bb8d

Please sign in to comment.