COCKROACH-DEBUG-CHECK-LOG-CONFIG(1)

NAME

cockroach-debug-check-log-config - test the log config passed via --log

SYNOPSIS

cockroach debug check-log-config [flags]

DESCRIPTION

test the log config passed via --log

OPTIONS

-h, --help[=false]
    help for check-log-config

--only-channels=
    selection of channels to include in the output diagram.

-s, --store=

The file path to a storage device. This flag must be specified separately for
 each storage device, for example:

--store=/mnt/ssd01 --store=/mnt/ssd02 --store=/mnt/hda1

For each store, the "attrs" and "size" fields can be used to specify device
 attributes and a maximum store size (see below). When one or both of these
 fields are set, the "path" field label must be used for the path to the
 storage device, for example:

--store=path=/mnt/ssd01,attrs=ssd,size=20GiB

In most cases, node-level attributes are preferable to store-level attributes.
 However, the "attrs" field can be used to match capabilities for storage
 of individual databases or tables. For example, an OLTP database would
 probably want to allocate space for its tables only on solid state devices,
 whereas append-only time series might prefer cheaper spinning drives. Typical
 attributes include whether the store is flash (ssd), spinny disk (hdd),
 or in-memory (mem), as well as speeds and other specs. Attributes can be
 arbitrary strings separated by colons, for example:

--store=path=/mnt/hda1,attrs=hdd:7200rpm

The store size in the "size" field is not a guaranteed maximum but is
 used when calculating free space for rebalancing purposes. The size can be
 specified either in a bytes-based unit or as a percentage of hard drive space,
 for example:

--store=path=/mnt/ssd01,size=10000000000 -> 10000000000 bytes
   --store=path=/mnt/ssd01,size=20GB -> 20000000000 bytes
   --store=path=/mnt/ssd01,size=20GiB -> 21474836480 bytes
   --store=path=/mnt/ssd01,size=0.02TiB -> 21474836480 bytes
   --store=path=/mnt/ssd01,size=20% -> 20% of available space
   --store=path=/mnt/ssd01,size=0.2 -> 20% of available space
   --store=path=/mnt/ssd01,size=.2 -> 20% of available space

For an in-memory store, the "type" and "size" fields are required, and the
 "path" field is forbidden. The "type" field must be set to "mem", and the
 "size" field must be set to the true maximum bytes or percentage of available
 memory that the store may consume, for example:

--store=type=mem,size=20GiB
   --store=type=mem,size=90%

Optionally, to configure admission control enforcement to prevent disk
 bandwidth saturation, the "provisioned-rate" field can be specified with the
 "disk-name" and an optional "bandwidth". The bandwidth is used to override
 the value of the cluster setting, kvadmission.store.provisioned_bandwidth. For
 example:

--store=provisioned-rate=disk-name=nvme1n1
   --store=provisioned-rate=disk-name=sdb:bandwidth=250MiB/s

Commas are forbidden in all values, since they are used to separate fields.
 Also, if you use equal signs in the file path to a store, you must use the
 "path" field label. (default is 'cockroach-data' in current directory except
 for mt commands which use 'cockroach-data-tenant-X' for tenant 'X')

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