vitess.io/vitess@v0.16.2/go/flags/endtoend/vtorc.txt (about) 1 Usage of vtorc: 2 --alsologtostderr log to standard error as well as files 3 --audit-file-location string File location where the audit logs are to be stored 4 --audit-purge-duration duration Duration for which audit logs are held before being purged. Should be in multiples of days (default 168h0m0s) 5 --audit-to-backend Whether to store the audit log in the VTOrc database 6 --audit-to-syslog Whether to store the audit log in the syslog 7 --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified 8 --clusters_to_watch strings Comma-separated list of keyspaces or keyspace/shards that this instance will monitor and repair. Defaults to all clusters in the topology. Example: "ks1,ks2/-80" 9 --config string config file name 10 --consul_auth_static_file string JSON File to read the topos/tokens from. 11 --emit_stats If set, emit stats to push-based monitoring and stats backends 12 --grpc_auth_static_client_creds string When using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server. 13 --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy 14 --grpc_enable_tracing Enable gRPC tracing. 15 --grpc_initial_conn_window_size int gRPC initial connection window size 16 --grpc_initial_window_size int gRPC initial window size 17 --grpc_keepalive_time duration After a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive. (default 10s) 18 --grpc_keepalive_timeout duration After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s) 19 --grpc_max_message_size int Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216) 20 --grpc_prometheus Enable gRPC monitoring with Prometheus. 21 -h, --help display usage and exit 22 --instance-poll-time duration Timer duration on which VTOrc refreshes MySQL information (default 5s) 23 --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) 24 --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) 25 --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) 26 --lock-timeout duration Maximum time for which a shard/keyspace lock can be acquired for (default 45s) 27 --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) 28 --log_dir string If non-empty, write log files in this directory 29 --log_err_stacks log stack traces for errors 30 --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) 31 --logtostderr log to standard error instead of files 32 --max-stack-size int configure the maximum stack size in bytes (default 67108864) 33 --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 10s) 34 --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) 35 --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. 36 --port int port for the server 37 --pprof strings enable profiling 38 --prevent-cross-cell-failover Prevent VTOrc from promoting a primary in a different cell than the current primary in case of a failover 39 --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) 40 --reasonable-replication-lag duration Maximum replication lag on replicas which is deemed to be acceptable (default 10s) 41 --recovery-period-block-duration duration Duration for which a new recovery is blocked on an instance after running a recovery (default 30s) 42 --recovery-poll-duration duration Timer duration on which VTOrc polls its database to run a recovery (default 1s) 43 --remote_operation_timeout duration time to wait for a remote operation (default 15s) 44 --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) 45 --shutdown_wait_time duration Maximum time to wait for VTOrc to release all the locks that it is holding before shutting down on SIGTERM (default 30s) 46 --snapshot-topology-interval duration Timer duration on which VTOrc takes a snapshot of the current MySQL information it has in the database. Should be in multiple of hours 47 --sqlite-data-file string SQLite Datafile to use as VTOrc's database (default "file::memory:?mode=memory&cache=shared") 48 --stats_backend string The name of the registered push-based monitoring/stats backend to use 49 --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars 50 --stats_common_tags strings Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 51 --stats_drop_variables string Variables to be dropped from the list of exported variables. 52 --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) 53 --stderrthreshold severity logs at or above this threshold go to stderr (default 1) 54 --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting 55 --tablet_manager_grpc_cert string the cert to use to connect 56 --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) 57 --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) 58 --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting 59 --tablet_manager_grpc_key string the key to use to connect 60 --tablet_manager_grpc_server_name string the server name to use to validate server certificate 61 --tablet_manager_protocol string Protocol to use to make tabletmanager RPCs to vttablets. (default "grpc") 62 --topo-information-refresh-duration duration Timer duration on which VTOrc refreshes the keyspace and vttablet records from the topology server (default 15s) 63 --topo_consul_lock_delay duration LockDelay for consul session. (default 15s) 64 --topo_consul_lock_session_checks string List of checks for consul session. (default "serfHealth") 65 --topo_consul_lock_session_ttl string TTL for consul session. 66 --topo_consul_watch_poll_duration duration time of the long poll for watch queries. (default 30s) 67 --topo_etcd_lease_ttl int Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) 68 --topo_etcd_tls_ca string path to the ca to use to validate the server cert when connecting to the etcd topo server 69 --topo_etcd_tls_cert string path to the client cert to use to connect to the etcd topo server, requires topo_etcd_tls_key, enables TLS 70 --topo_etcd_tls_key string path to the client key to use to connect to the etcd topo server, enables TLS 71 --topo_global_root string the path of the global topology data in the global topology server 72 --topo_global_server_address string the address of the global topology server 73 --topo_implementation string the topology implementation to use 74 --topo_k8s_context string The kubeconfig context to use, overrides the 'current-context' from the config 75 --topo_k8s_kubeconfig string Path to a valid kubeconfig file. When running as a k8s pod inside the same cluster you wish to use as the topo, you may omit this and the below arguments, and Vitess is capable of auto-discovering the correct values. https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod 76 --topo_k8s_namespace string The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config 77 --topo_zk_auth_file string auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass 78 --topo_zk_base_timeout duration zk base timeout (see zk.Connect) (default 30s) 79 --topo_zk_max_concurrency int maximum number of pending requests to send to a Zookeeper server. (default 64) 80 --topo_zk_tls_ca string the server ca to use to validate servers when connecting to the zk topo server 81 --topo_zk_tls_cert string the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS 82 --topo_zk_tls_key string the key to use to connect to the zk topo server, enables TLS 83 --v Level log level for V logs 84 -v, --version print binary version 85 --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 86 --wait-replicas-timeout duration Duration for which to wait for replica's to respond when issuing RPCs (default 30s)