COCKROACH-DEBUG(1)

NAME

cockroach-debug - debugging commands

SYNOPSIS

cockroach debug [command] [flags]

DESCRIPTION

Various commands for debugging.

These commands are useful for extracting data from the data files of a process that has failed and cannot restart.

OPTIONS

-h, --help[=false]
    help for debug

OPTIONS INHERITED FROM PARENT COMMANDS

--enterprise-require-fips-ready[=false]
    abort if FIPS readiness checks fail

--log=

Logging configuration, expressed using YAML syntax. For example, you can
 change the default logging directory with: --log='file-defaults: {dir: ...}'.
 See the documentation for more options and details. To preview how the log
 configuration is applied, or preview the default configuration, you can use
 the 'cockroach debug check-log-config' sub-command.

--log-config-file=

File name to read the logging configuration from. This has the same effect as
 passing the content of the file via the --log flag.

--log-config-vars=[]

Environment variables that will be expanded if present in the body of the
 logging configuration.

--log-dir=

--log-dir=XXX is an alias for --log='file-defaults: {dir: XXX}'.

--logtostderr[=UNKNOWN]

--logtostderr=XXX is an alias for --log='sinks: {stderr: {filter: XXX}}'. If
 no value is specified, the default value for the command is inferred: INFO for
 server commands, WARNING for client commands.

--redactable-logs=false

--redactable-logs=XXX is an alias for --log='file-defaults: {redactable:
 XXX}}'.

--vmodule=
    comma-separated list of pattern=N settings for file-filtered logging (significantly hurts performance)

SEE ALSO

cockroach(1), cockroach-debug-ballast(1), cockroach-debug-check-log-config(1), cockroach-debug-check-store(1), cockroach-debug-compact(1), cockroach-debug-declarative-corpus-validate(1), cockroach-debug-declarative-print-rules(1), cockroach-debug-decode-key(1), cockroach-debug-decode-proto(1), cockroach-debug-decode-value(1), cockroach-debug-doctor(1), cockroach-debug-encryption-active-key(1), cockroach-debug-encryption-decrypt(1), cockroach-debug-encryption-registry-list(1), cockroach-debug-encryption-status(1), cockroach-debug-enterprise-check-fips(1), cockroach-debug-env(1), cockroach-debug-estimate-gc(1), cockroach-debug-gossip-values(1), cockroach-debug-intent-count(1), cockroach-debug-job-cleanup-job-info(1), cockroach-debug-job-trace(1), cockroach-debug-keys(1), cockroach-debug-list-files(1), cockroach-debug-merge-logs(1), cockroach-debug-pebble(1), cockroach-debug-raft-log(1), cockroach-debug-range-data(1), cockroach-debug-range-descriptors(1), cockroach-debug-recover(1), cockroach-debug-reset-quorum(1), cockroach-debug-resolve-txn-id(1), cockroach-debug-send-kv-batch(1), cockroach-debug-statement-bundle(1), cockroach-debug-synctest(1), cockroach-debug-tsdump(1), cockroach-debug-zip(1)

HISTORY

13-May-2026 Auto generated by spf13/cobra