OS Manuals

/usr/bin/demo

All the binaries built by Vitess

From vitess-21-binaries 21.0.6-r4 (enterprise-packages), captured 2026-11-08 by running demo --help (exit 0). permalink

W1108 04:59:48.304194       2 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/tmp]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
W1108 04:59:48.305601       2 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/tmp]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
Usage of /usr/bin/demo:
      --alsologtostderr                                                  log to standard error as well as files
      --bind-address string                                              Bind address for the server. If empty, the server will listen on all available unicast and anycast IP addresses of the local system.
      --catch-sigpipe                                                    catch and ignore SIGPIPE on stdout and stderr if specified
      --config-file string                                               Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
      --config-file-not-found-handling ConfigFileNotFoundHandling        Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
      --config-name string                                               Name of the config file (without extension) to search for. (default "vtconfig")
      --config-path strings                                              Paths to search for config files in. (default [/tmp])
      --config-persistence-min-interval duration                         minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
      --config-type string                                               Config file type (omit to infer config type from file extension).
      --duration duration                                                total duration the demo runs (default 10m0s)
      --grpc_auth_mode string                                            Which auth plugin implementation to use (eg: static)
      --grpc_auth_mtls_allowed_substrings string                         List of substrings of at least one of the client certificate names (separated by colon).
      --grpc_auth_static_password_file string                            JSON File to read the users/passwords from.
      --grpc_bind_address string                                         Bind address for gRPC calls. If empty, listen on all addresses.
      --grpc_ca string                                                   server CA to use for gRPC connections, requires TLS, and enforces client certificate check
      --grpc_cert string                                                 server certificate to use for gRPC connections, requires grpc_key, enables TLS
      --grpc_crl string                                                  path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
      --grpc_enable_optional_tls                                         enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
      --grpc_key string                                                  server private key to use for gRPC connections, requires grpc_cert, enables TLS
      --grpc_max_connection_age duration                                 Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s)
      --grpc_max_connection_age_grace duration                           Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s)
      --grpc_port int                                                    Port to listen on for gRPC calls. If zero, do not listen.
      --grpc_server_ca string                                            path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
      --grpc_server_initial_conn_window_size int                         gRPC server initial connection window size
      --grpc_server_initial_window_size int                              gRPC server initial window size
      --grpc_server_keepalive_enforcement_policy_min_time duration       gRPC server minimum keepalive time (default 10s)
      --grpc_server_keepalive_enforcement_policy_permit_without_stream   gRPC server permit client keepalive pings even when there are no active streams (RPCs)
      --grpc_server_keepalive_time duration                              After a duration of this time, if the server doesn't see any activity, it pings the client to see if the transport is still alive. (default 10s)
      --grpc_server_keepalive_timeout duration                           After having pinged for keepalive check, the server waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s)
  -h, --help                                                             display usage and exit
      --keep_logs duration                                               keep logs for this long (using ctime) (zero to keep forever)
      --keep_logs_by_mtime duration                                      keep logs for this long (using mtime) (zero to keep forever)
      --lag_update_interval duration                                     interval at which the current replication lag will be broadcast to the throttler (default 5s)
      --lameduck-period duration                                         keep running at least this long after SIGTERM before stopping (default 50ms)
      --log_backtrace_at traceLocations                                  when logging hits line file:N, emit a stack trace
      --log_dir string                                                   If non-empty, write log files in this directory
      --log_err_stacks                                                   log stack traces for errors
      --log_link string                                                  If non-empty, add symbolic links in this directory to the log files
      --log_rotate_max_size uint                                         size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
      --logbuflevel int                                                  Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; ...). Has limited applicability on non-prod platforms.
      --logtostderr                                                      log to standard error instead of files
      --max-stack-size int                                               configure the maximum stack size in bytes (default 67108864)
      --onclose_timeout duration                                         wait no more than this for OnClose handlers before stopping (default 10s)
      --onterm_timeout duration                                          wait no more than this for OnTermSync handlers before stopping (default 10s)
      --pid_file string                                                  If set, the process will write its pid to the named file, and delete it on graceful shutdown.
      --port int                                                         port for the server
      --pprof strings                                                    enable profiling
      --pprof-http                                                       enable pprof http endpoints
      --purge_logs_interval duration                                     how often try to remove old logs (default 1h0m0s)
      --rate int                                                         maximum rate of the throttled demo server at the start (default 1000)
      --replica_degration_duration duration                              duration a simulated degration should take (default 10s)
      --replica_degration_interval duration                              simulate a throughput degration of the replica every X interval (i.e. the replica applies transactions at a slower rate for -reparent_duration and the replication lag might go up)
      --stderrthreshold severityFlag                                     logs at or above this threshold go to stderr (default 1)
      --table-refresh-interval int                                       interval in milliseconds to refresh tables in status page with refreshRequired class
      --v Level                                                          log level for V logs
  -v, --version                                                          print binary version
      --vmodule vModuleFlag                                              comma-separated list of pattern=N settings for file-filtered logging
Options (57)
OptionDescriptionSource
--alsologtostderrlog to standard error as well as fileshelp
--bind-address stringBind address for the server.help
--catch-sigpipecatch and ignore SIGPIPE on stdout and stderr if specifiedhelp
--config-file stringFull path of the config file (with extension) to use.help
--config-file-not-found-handling ConfigFileNotFoundHandlingBehavior when a config file is not found.help
--config-name stringName of the config file (without extension) to search for.help
--config-path stringsPaths to search for config files in.help
--config-persistence-min-interval durationminimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done).help
--config-type stringConfig file type (omit to infer config type from file extension).help
--duration durationtotal duration the demo runs (default 10m0s)help
--grpc_auth_mode stringWhich auth plugin implementation to use (eg: static)help
--grpc_auth_mtls_allowed_substrings stringList of substrings of at least one of the client certificate names (separated by colon).help
--grpc_auth_static_password_file stringJSON File to read the users/passwords from.help
--grpc_bind_address stringBind address for gRPC calls.help
--grpc_ca stringserver CA to use for gRPC connections, requires TLS, and enforces client certificate checkhelp
--grpc_cert stringserver certificate to use for gRPC connections, requires grpc_key, enables TLShelp
--grpc_crl stringpath to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshakehelp
--grpc_enable_optional_tlsenable optional TLS mode when a server accepts both TLS and plain-text connections on the same porthelp
--grpc_key stringserver private key to use for gRPC connections, requires grpc_cert, enables TLShelp
--grpc_max_connection_age durationMaximum age of a client connection before GoAway is sent.help
--grpc_max_connection_age_grace durationAdditional grace period after grpc_max_connection_age, after which connections are forcibly closed.help
--grpc_port intPort to listen on for gRPC calls.help
--grpc_server_ca stringpath to server CA in PEM format, which will be combine with server cert, return full certificate chain to clientshelp
--grpc_server_initial_conn_window_size intgRPC server initial connection window sizehelp
--grpc_server_initial_window_size intgRPC server initial window sizehelp
--grpc_server_keepalive_enforcement_policy_min_time durationgRPC server minimum keepalive time (default 10s)help
--grpc_server_keepalive_enforcement_policy_permit_without_streamgRPC server permit client keepalive pings even when there are no active streams (RPCs)help
--grpc_server_keepalive_time durationAfter a duration of this time, if the server doesn't see any activity, it pings the client to see if the transport is still alive.help
--grpc_server_keepalive_timeout durationAfter having pinged for keepalive check, the server waits for a duration of Timeout and if no activity is seen even after that the connection is closed.help
-h, --helpdisplay usage and exithelp
--keep_logs durationkeep logs for this long (using ctime) (zero to keep forever)help
--keep_logs_by_mtime durationkeep logs for this long (using mtime) (zero to keep forever)help
--lag_update_interval durationinterval at which the current replication lag will be broadcast to the throttler (default 5s)help
--lameduck-period durationkeep running at least this long after SIGTERM before stopping (default 50ms)help
--log_backtrace_at traceLocationswhen logging hits line file:N, emit a stack tracehelp
--log_dir stringIf non-empty, write log files in this directoryhelp
--log_err_stackslog stack traces for errorshelp
--log_link stringIf non-empty, add symbolic links in this directory to the log fileshelp
--log_rotate_max_size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)help
--logbuflevel intBuffer log messages logged at this level or lower (-1 means don't buffer;help
--logtostderrlog to standard error instead of fileshelp
--max-stack-size intconfigure the maximum stack size in bytes (default 67108864)help
--onclose_timeout durationwait no more than this for OnClose handlers before stopping (default 10s)help
--onterm_timeout durationwait no more than this for OnTermSync handlers before stopping (default 10s)help
--pid_file stringIf set, the process will write its pid to the named file, and delete it on graceful shutdown.help
--port intport for the serverhelp
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--purge_logs_interval durationhow often try to remove old logs (default 1h0m0s)help
--rate intmaximum rate of the throttled demo server at the start (default 1000)help
--replica_degration_duration durationduration a simulated degration should take (default 10s)help
--replica_degration_interval durationsimulate a throughput degration of the replica every X interval (i.e. the replica applies transactions at a slower rate for -reparent_duration and the replication lag might go up)help
--stderrthreshold severityFlaglogs at or above this threshold go to stderr (default 1)help
--table-refresh-interval intinterval in milliseconds to refresh tables in status page with refreshRequired classhelp
--v Levellog level for V logshelp
-v, --versionprint binary versionhelp
--vmodule vModuleFlagcomma-separated list of pattern=N settings for file-filtered logginghelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.