Skip to main content
The cockroach debug upload uploads a debug.zip file generated by to , directly from the machine where the file is stored. The command detects the file type automatically; only debug.zip files are supported. Uploads are authenticated with an API key issued by Cockroach Labs for your cluster. To request an API key, open a ticket in the Support Portal.
The files produced by cockroach debug zip can contain highly , such as usernames, hashed passwords, and possibly table data. Generate the .zip file with the to redact sensitive data before uploading it.
The machine that runs the command must be able to reach:
  • Cockroach Labs’ upload endpoint: crdb-diagnostics-endpoint.cockroachlabs.com
  • Google Cloud Storage: storage.googleapis.com:443
If outbound connections are restricted, either allow egress to these hosts or route the upload through a forward proxy with the --proxy flag.

​
Synopsis

​
Subcommands

While the cockroach debug command has a few subcommands, users are expected to use only the , , , , , , and subcommands. Cockroach Labs recommends 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.

​
Flags

The debug upload subcommand supports the following flags.

​
Examples

​
Upload a debug.zip file

Set the API key in the COCKROACH_CRL_SUPPORT_API_KEY environment variable or pass it with the --crl-support-api-key flag. To associate the upload with an existing support ticket, pass the ticket ID:
The command prints the upload session ID when the upload starts. When the upload completes, it prints the number of bytes uploaded and the transfer rate.

​
Resume an interrupted upload

Failed transfers are retried automatically. If the upload still fails after the automatic retries, or is interrupted before it completes, the command output includes the upload session ID. Re-run the command with the --resume-session flag to continue the upload from where it stopped:

​
Upload through a forward proxy

If the machine cannot reach the upload endpoint directly, pass the proxy URL with the --proxy flag or set the HTTPS_PROXY environment variable:

​
See also