Skip to content

Commit

Permalink
Merge pull request #3796 from cockroachdb/debug_zip_doc_updates
Browse files Browse the repository at this point in the history
`cockroach debuz zip` doc updates
  • Loading branch information
Amruta-Ranade committed Oct 4, 2018
2 parents 4361e6d + 812e101 commit 575f8d6
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions v2.1/debug-zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,18 @@ toc: true
The `debug zip` [command](cockroach-commands.html) connects to your cluster and gathers the following information from each active node into a single file (inactive nodes are not included):

- [Log files](debug-and-error-logs.html)
- Cluster events
- Schema change events
- Node liveness
- Gossip data
- Stack traces
- Range lists
- A list of databases and tables
- Heap profiles (**new in v2.0**)
- [Cluster Settings](cluster-settings.html)
- [Metrics](admin-ui-custom-chart-debug-page.html#available-metrics)
- Alerts
- Heap profiles
- **New in v2.1:** Problem ranges

{{site.data.alerts.callout_danger}}The file produced by <code>cockroach debug zip</code> can contain highly sensitive, unanonymized information, such as usernames, passwords, and possibly your table's data. You should share this data only with Cockroach Labs developers and only after determining the most secure method of delivery.{{site.data.alerts.end}}

Expand All @@ -28,8 +33,6 @@ There are two scenarios in which `debug zip` is useful:

- If you experience severe or difficult-to-reproduce issues with your cluster, Cockroach Labs might ask you to send us your cluster's debugging information using `cockroach debug zip`.

{{site.data.alerts.callout_danger}}The file produced by <code>cockroach debug zip</code> can contain highly sensitive, unanonymized information, such as usernames, passwords, and your table's data. You should share this data only with Cockroach Labs developers and only after determining the most secure method of delivery.{{site.data.alerts.end}}

### Collecting log files

When you issue the `debug zip` command, the node that receives the request connects to each other node in the cluster. Once it's connected, the node requests the content of all log files stored on the node, the location of which is determined by the `--log-dir` value when you [started the node](start-a-node.html).
Expand Down

0 comments on commit 575f8d6

Please sign in to comment.