| title | summary | toc | key |
|---|---|---|---|
cockroach debug list-files |
Learn the command for listing the files collected in the debug zip. |
true |
debug-list-files.html |
The cockroach debug list-files command shows the files that will be collected by using cockroach debug zip.
{{site.data.alerts.callout_info}}
The files listed include logs, heap profiles, goroutine dumps, and CPU profiles. Other files generated by cockroach debug zip are not listed by cockroach debug list-files.
{{site.data.alerts.end}}
{% include {{ page.version.version }}/misc/debug-subcommands.md %}
$ cockroach debug list-files {flags}The debug list-files subcommand supports the following general-use, client connection, and logging flags.
| Flag | Description |
|---|---|
--exclude-files |
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=*.logNote 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:--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 |
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=*.pprofNote 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 |
{% include {{ page.version.version }}/sql/connection-parameters.md %}
--cluster-name | The cluster name to use to verify the cluster's identity. If the cluster has a cluster name, you must include this flag. For more information, see cockroach start.
--disable-cluster-name-verification | Disables the cluster name check for this command. This flag must be paired with --cluster-name. For more information, see cockroach start.
{% include {{ page.version.version }}/misc/debug-subcommands.md %}
{% include_cached copy-clipboard.html %}
$ cockroach debug list-files{{site.data.alerts.callout_info}}
The files listed include logs, heap profiles, goroutine dumps, and CPU profiles. Other files generated by cockroach debug zip are not listed by cockroach debug list-files.
{{site.data.alerts.end}}
{% include_cached copy-clipboard.html %}
$ cockroach debug list-files --include-files=*.log{% include_cached copy-clipboard.html %}
$ cockroach debug list-files --format=tsv