|
| 1 | +Usage of vtgr: |
| 2 | + --abort_rebootstrap |
| 3 | + don't allow vtgr to rebootstrap an existing group |
| 4 | + --alsologtostderr |
| 5 | + log to standard error as well as files |
| 6 | + --catch-sigpipe |
| 7 | + catch and ignore SIGPIPE on stdout and stderr if specified |
| 8 | + --clusters_to_watch string |
| 9 | + 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" |
| 10 | + --consul_auth_static_file string |
| 11 | + JSON File to read the topos/tokens from. |
| 12 | + --cpu_profile string |
| 13 | + deprecated: use '-pprof=cpu' instead |
| 14 | + --datadog-agent-host string |
| 15 | + host to send spans to. if empty, no tracing will be done |
| 16 | + --datadog-agent-port string |
| 17 | + port to send spans to. if empty, no tracing will be done |
| 18 | + --db_config string |
| 19 | + full path to db config file that will be used by VTGR |
| 20 | + --db_flavor string |
| 21 | + mysql flavor override (default MySQL56) |
| 22 | + --db_port int |
| 23 | + local mysql port, set this to enable local fast check |
| 24 | + --emit_stats |
| 25 | + If set, emit stats to push-based monitoring and stats backends |
| 26 | + --enable_heartbeat_check |
| 27 | + enable heartbeat checking, set together with -group_heartbeat_threshold |
| 28 | + --gr_port int |
| 29 | + port to bootstrap a mysql group (default 33061) |
| 30 | + --group_heartbeat_threshold int |
| 31 | + VTGR will trigger backoff on inconsistent state if the group heartbeat staleness exceeds this threshold (in seconds). Should be used along with -enable_heartbeat_check |
| 32 | + --grpc_auth_mode string |
| 33 | + Which auth plugin implementation to use (eg: static) |
| 34 | + --grpc_auth_mtls_allowed_substrings string |
| 35 | + List of substrings of at least one of the client certificate names (separated by colon). |
| 36 | + --grpc_auth_static_client_creds string |
| 37 | + when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server |
| 38 | + --grpc_auth_static_password_file string |
| 39 | + JSON File to read the users/passwords from. |
| 40 | + --grpc_ca string |
| 41 | + server CA to use for gRPC connections, requires TLS, and enforces client certificate check |
| 42 | + --grpc_cert string |
| 43 | + server certificate to use for gRPC connections, requires grpc_key, enables TLS |
| 44 | + --grpc_compression string |
| 45 | + Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy |
| 46 | + --grpc_crl string |
| 47 | + path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake |
| 48 | + --grpc_enable_optional_tls |
| 49 | + enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port |
| 50 | + --grpc_enable_tracing |
| 51 | + Enable GRPC tracing |
| 52 | + --grpc_initial_conn_window_size int |
| 53 | + gRPC initial connection window size |
| 54 | + --grpc_initial_window_size int |
| 55 | + gRPC initial window size |
| 56 | + --grpc_keepalive_time duration |
| 57 | + 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) |
| 58 | + --grpc_keepalive_timeout duration |
| 59 | + 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) |
| 60 | + --grpc_key string |
| 61 | + server private key to use for gRPC connections, requires grpc_cert, enables TLS |
| 62 | + --grpc_max_connection_age duration |
| 63 | + Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s) |
| 64 | + --grpc_max_connection_age_grace duration |
| 65 | + Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s) |
| 66 | + --grpc_max_message_size int |
| 67 | + Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216) |
| 68 | + --grpc_port int |
| 69 | + Port to listen on for gRPC calls |
| 70 | + --grpc_prometheus |
| 71 | + Enable gRPC monitoring with Prometheus |
| 72 | + --grpc_server_ca string |
| 73 | + path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients |
| 74 | + --grpc_server_initial_conn_window_size int |
| 75 | + gRPC server initial connection window size |
| 76 | + --grpc_server_initial_window_size int |
| 77 | + gRPC server initial window size |
| 78 | + --grpc_server_keepalive_enforcement_policy_min_time duration |
| 79 | + gRPC server minimum keepalive time (default 10s) |
| 80 | + --grpc_server_keepalive_enforcement_policy_permit_without_stream |
| 81 | + gRPC server permit client keepalive pings even when there are no active streams (RPCs) |
| 82 | + --jaeger-agent-host string |
| 83 | + host and port to send spans to. if empty, no tracing will be done |
| 84 | + --keep_logs duration |
| 85 | + keep logs for this long (using ctime) (zero to keep forever) |
| 86 | + --keep_logs_by_mtime duration |
| 87 | + keep logs for this long (using mtime) (zero to keep forever) |
| 88 | + --lameduck-period duration |
| 89 | + keep running at least this long after SIGTERM before stopping (default 50ms) |
| 90 | + --log_backtrace_at value |
| 91 | + when logging hits line file:N, emit a stack trace |
| 92 | + --log_dir string |
| 93 | + If non-empty, write log files in this directory |
| 94 | + --log_err_stacks |
| 95 | + log stack traces for errors |
| 96 | + --log_rotate_max_size uint |
| 97 | + size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) |
| 98 | + --logtostderr |
| 99 | + log to standard error instead of files |
| 100 | + --mem-profile-rate int |
| 101 | + deprecated: use '-pprof=mem' instead (default 524288) |
| 102 | + --mutex-profile-fraction int |
| 103 | + deprecated: use '-pprof=mutex' instead |
| 104 | + --mysql_auth_server_static_file string |
| 105 | + JSON File to read the users/passwords from. |
| 106 | + --mysql_auth_server_static_string string |
| 107 | + JSON representation of the users/passwords config. |
| 108 | + --mysql_auth_static_reload_interval duration |
| 109 | + Ticker to reload credentials |
| 110 | + --mysql_clientcert_auth_method string |
| 111 | + client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password) |
| 112 | + --mysql_server_flush_delay duration |
| 113 | + Delay after which buffered response will be flushed to the client. (default 100ms) |
| 114 | + --mysql_server_version string |
| 115 | + MySQL server version to advertise. |
| 116 | + --onclose_timeout duration |
| 117 | + wait no more than this for OnClose handlers before stopping (default 1ns) |
| 118 | + --onterm_timeout duration |
| 119 | + wait no more than this for OnTermSync handlers before stopping (default 10s) |
| 120 | + --pid_file string |
| 121 | + If set, the process will write its pid to the named file, and delete it on graceful shutdown. |
| 122 | + --ping_tablet_timeout duration |
| 123 | + time to wait when we ping a tablet (default 2s) |
| 124 | + --pprof string |
| 125 | + enable profiling |
| 126 | + --purge_logs_interval duration |
| 127 | + how often try to remove old logs (default 1h0m0s) |
| 128 | + --refresh_interval duration |
| 129 | + refresh interval to load tablets (default 10s) |
| 130 | + --remote_operation_timeout duration |
| 131 | + time to wait for a remote operation (default 30s) |
| 132 | + --scan_interval duration |
| 133 | + scan interval to diagnose and repair (default 3s) |
| 134 | + --scan_repair_timeout duration |
| 135 | + time to wait for a Diagnose and repair operation (default 3s) |
| 136 | + --security_policy string |
| 137 | + 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) |
| 138 | + --service_map value |
| 139 | + comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-vtworker |
| 140 | + --sql-max-length-errors int |
| 141 | + truncate queries in error logs to the given length (default unlimited) |
| 142 | + --sql-max-length-ui int |
| 143 | + truncate queries in debug UIs to the given length (default 512) (default 512) |
| 144 | + --stats_backend string |
| 145 | + The name of the registered push-based monitoring/stats backend to use |
| 146 | + --stats_combine_dimensions string |
| 147 | + List of dimensions to be combined into a single "all" value in exported stats vars |
| 148 | + --stats_common_tags string |
| 149 | + Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 |
| 150 | + --stats_drop_variables string |
| 151 | + Variables to be dropped from the list of exported variables. |
| 152 | + --stats_emit_period duration |
| 153 | + Interval between emitting stats to all registered backends (default 1m0s) |
| 154 | + --stderrthreshold value |
| 155 | + logs at or above this threshold go to stderr (default 1) |
| 156 | + --tablet_manager_grpc_ca string |
| 157 | + the server ca to use to validate servers when connecting |
| 158 | + --tablet_manager_grpc_cert string |
| 159 | + the cert to use to connect |
| 160 | + --tablet_manager_grpc_concurrency int |
| 161 | + concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) |
| 162 | + --tablet_manager_grpc_connpool_size int |
| 163 | + number of tablets to keep tmclient connections open to (default 100) |
| 164 | + --tablet_manager_grpc_crl string |
| 165 | + the server crl to use to validate server certificates when connecting |
| 166 | + --tablet_manager_grpc_key string |
| 167 | + the key to use to connect |
| 168 | + --tablet_manager_grpc_server_name string |
| 169 | + the server name to use to validate server certificate |
| 170 | + --tablet_manager_protocol string |
| 171 | + the protocol to use to talk to vttablet (default grpc) |
| 172 | + --topo_consul_lock_delay duration |
| 173 | + LockDelay for consul session. (default 15s) |
| 174 | + --topo_consul_lock_session_checks string |
| 175 | + List of checks for consul session. (default serfHealth) |
| 176 | + --topo_consul_lock_session_ttl string |
| 177 | + TTL for consul session. |
| 178 | + --topo_consul_watch_poll_duration duration |
| 179 | + time of the long poll for watch queries. (default 30s) |
| 180 | + --topo_etcd_lease_ttl int |
| 181 | + Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) |
| 182 | + --topo_etcd_tls_ca string |
| 183 | + path to the ca to use to validate the server cert when connecting to the etcd topo server |
| 184 | + --topo_etcd_tls_cert string |
| 185 | + path to the client cert to use to connect to the etcd topo server, requires topo_etcd_tls_key, enables TLS |
| 186 | + --topo_etcd_tls_key string |
| 187 | + path to the client key to use to connect to the etcd topo server, enables TLS |
| 188 | + --topo_global_root string |
| 189 | + the path of the global topology data in the global topology server |
| 190 | + --topo_global_server_address string |
| 191 | + the address of the global topology server |
| 192 | + --topo_implementation string |
| 193 | + the topology implementation to use |
| 194 | + --topo_zk_auth_file string |
| 195 | + auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass |
| 196 | + --topo_zk_base_timeout duration |
| 197 | + zk base timeout (see zk.Connect) (default 30s) |
| 198 | + --topo_zk_max_concurrency int |
| 199 | + maximum number of pending requests to send to a Zookeeper server. (default 64) |
| 200 | + --topo_zk_tls_ca string |
| 201 | + the server ca to use to validate servers when connecting to the zk topo server |
| 202 | + --topo_zk_tls_cert string |
| 203 | + the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS |
| 204 | + --topo_zk_tls_key string |
| 205 | + the key to use to connect to the zk topo server, enables TLS |
| 206 | + --tracer string |
| 207 | + tracing service to use (default noop) |
| 208 | + --tracing-enable-logging |
| 209 | + whether to enable logging in the tracing service |
| 210 | + --tracing-sampling-rate value |
| 211 | + sampling rate for the probabilistic jaeger sampler (default 0.1) |
| 212 | + --tracing-sampling-type value |
| 213 | + sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) |
| 214 | + --v value |
| 215 | + log level for V logs |
| 216 | + --version |
| 217 | + print binary version |
| 218 | + --vmodule value |
| 219 | + comma-separated list of pattern=N settings for file-filtered logging |
| 220 | + --vtgr_config string |
| 221 | + config file for vtgr |
0 commit comments