COCKROACH-DEBUG-SYNCTEST(1)

NAME

cockroach-debug-synctest - Run a log-like workload that can help expose filesystem anomalies

SYNOPSIS

cockroach debug synctest [flags]

DESCRIPTION

synctest is a tool to verify filesystem consistency in the presence of I/O errors. It takes a directory (required to be initially empty and created on demand) into which data will be written and a nemesis script which receives a single argument that is either "on" or "off".

The nemesis script will be called with a parameter of "on" when the filesystem underlying the given directory should be "disturbed". It is called with "off" to restore the undisturbed state (note that "off" must be idempotent).

synctest will run run across multiple "epochs", each terminated by an I/O error injected by the nemesis. After each epoch, the nemesis is turned off and the written data is reopened, checked for data loss, new data is written, and the nemesis turned back on. In the absence of unexpected error or user interrupt, this process continues indefinitely.

OPTIONS

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

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-debug(1)

HISTORY

13-May-2026 Auto generated by spf13/cobra