cockroach debug list-files shows the files that will be collected by using .
The files listed include logs, heap profiles, goroutine dumps, and CPU profiles. Other generated by
cockroach debug zip are not listed by cockroach debug list-files.Subcommands
While thecockroach debug command has a few subcommands, users are expected to use only the , , , , , and subcommands.
We recommend using the and subcommands only when directed by the .
The other debug subcommands are useful only to Cockroach Labs. Output of debug commands may contain sensitive or secret information.
Synopsis
Flags
Thedebug list-files subcommand supports the following general-use, client connection, and logging flags.
General
| Flag | Description |
|---|---|
--exclude-files | to exclude from the generated .zip. This can be used to limit the size of the generated .zip, and affects logs, heap profiles, goroutine dumps, and/or CPU profiles. The files are specified as a comma-separated list of glob patterns. For example: --exclude-files=\*.log Note that this flag is applied after--include\_files. |
--exclude-nodes | Specify nodes to exclude from inspection as a comma-separated list or range of node IDs. For example: --exclude-nodes=1,10,13-15 |
--files-from | Start timestamp for log file, goroutine dump, and heap profile collection. This can be used to limit the size of the generated .zip, which is increased by these files. The timestamp uses the format YYYY-MM-DD, followed optionally by HH:MM:SS or HH:MM. For example: --files-from='2021-07-01 15:00' When specifying a narrow time window, we recommend adding extra seconds/minutes to account for uncertainties such as clock drift. Default: 48 hours before now |
--files-until | End timestamp for log file, goroutine dump, and heap profile collection. This can be used to limit the size of the generated .zip, which is increased by these files. The timestamp uses the format YYYY-MM-DD, followed optionally by HH:MM:SS or HH:MM. For example: --files-until='2021-07-01 16:00' When specifying a narrow time window, we recommend adding extra seconds/minutes to account for uncertainties such as clock drift. Default: 24 hours beyond now (to include files created during .zip creation) |
--format | Specify a format to display table rows. This can be tsv, csv, table, records, sql, raw, or html. Default:table (interactive sessions), tsv (non-interactive sessions) |
--include-files | to include in the generated .zip. This can be used to limit the size of the generated .zip, and affects logs, heap profiles, goroutine dumps, and/or CPU profiles. The files are specified as a comma-separated list of glob patterns. For example: --include-files=\*.pprof Note that this flag is applied before--exclude-files. |
--nodes | Specify nodes to inspect as a comma-separated list or range of node IDs. For example: --nodes=1,10,13-15 |
Client connection
Logging
While thecockroach debug command has a few subcommands, users are expected to use only the , , , , , and subcommands.
We recommend using the and subcommands only when directed by the .
The other debug subcommands are useful only to Cockroach Labs. Output of debug commands may contain sensitive or secret information.
Examples
List all collected files
cockroach debug zip are not listed by cockroach debug list-files.