Skip to main content
We strongly recommend only using cockroach debug job-trace when working directly with the .
The command connects to your cluster and collects trace payloads for a running, traceable ( or ). The trace payloads are helpful for debugging why a job is not running as expected or to add more context to logs gathered from the command. The node that cockroach debug job-trace is run against will communicate to all nodes in the cluster in order to retrieve the trace payloads. This will deliver a zip file that contains trace files for all the nodes participating in the execution of the job. The files hold information on the executing job’s , which describe the sub-operations being performed. Specifically, these files will contain the spans that have not yet completed and are associated with the execution of that particular job. Using this command for a job that is not currently running will result in an empty zip file.

​
Synopsis

See for details on capturing a job_id.

​
Subcommands

While the cockroach 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.

​
Flags

The debug job-trace subcommand supports the following general-use and client connection flags.

​
General

​
Client connection

​
Files

The cockroach debug job-trace command will output a zip file to where the command is run (<job_id-job-trace.zip). The zip file will contain trace files for all the nodes participating in the job’s execution. For example, node1-trace.txt. See the page for more information on trace responses.

​
Example

​
Generate a job-trace zip file

To generate the job-trace zip file, use your to pull the trace spans:
You will find the zip file in the directory you ran the command from:

​
See also