diff --git a/go/cmd/mysqlctl/mysqlctl.go b/go/cmd/mysqlctl/mysqlctl.go index fb7195240db..9ab2eec1b50 100644 --- a/go/cmd/mysqlctl/mysqlctl.go +++ b/go/cmd/mysqlctl/mysqlctl.go @@ -25,6 +25,8 @@ import ( "os" "time" + "github.com/spf13/pflag" + "vitess.io/vitess/go/cmd" "vitess.io/vitess/go/exit" "vitess.io/vitess/go/flagutil" @@ -248,7 +250,7 @@ func main() { exit.Return(1) } dbconfigs.RegisterFlags(dbconfigs.Dba) - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("mysqlctl", pflag.ExitOnError)) tabletAddr = netutil.JoinHostPort("localhost", int32(*port)) diff --git a/go/cmd/query_analyzer/query_analyzer.go b/go/cmd/query_analyzer/query_analyzer.go index 899aaca4e39..c10c0a285db 100644 --- a/go/cmd/query_analyzer/query_analyzer.go +++ b/go/cmd/query_analyzer/query_analyzer.go @@ -24,6 +24,8 @@ import ( "os" "sort" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/vt/log" "vitess.io/vitess/go/vt/sqlparser" @@ -59,7 +61,7 @@ func (a stats) Less(i, j int) bool { return a[i].Count > a[j].Count } func main() { defer exit.Recover() - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("query_analyzer", pflag.ExitOnError)) for _, filename := range _flag.Args() { fmt.Printf("processing: %s\n", filename) if err := processFile(filename); err != nil { diff --git a/go/cmd/topo2topo/topo2topo.go b/go/cmd/topo2topo/topo2topo.go index c60524eb220..2cf01dcb8c2 100644 --- a/go/cmd/topo2topo/topo2topo.go +++ b/go/cmd/topo2topo/topo2topo.go @@ -22,6 +22,8 @@ import ( "fmt" "os" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/vt/log" "vitess.io/vitess/go/vt/logutil" @@ -53,7 +55,7 @@ func main() { defer exit.RecoverAll() defer logutil.Flush() - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("topo2topo", pflag.ExitOnError)) args := _flag.Args() if len(args) != 0 { flag.Usage() diff --git a/go/cmd/vtbench/vtbench.go b/go/cmd/vtbench/vtbench.go index 07ce10f6013..d0ed7d5e6b0 100644 --- a/go/cmd/vtbench/vtbench.go +++ b/go/cmd/vtbench/vtbench.go @@ -23,6 +23,8 @@ import ( "strings" "time" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/vt/dbconfigs" "vitess.io/vitess/go/vt/log" @@ -104,7 +106,7 @@ func main() { defer exit.Recover() flag.Lookup("logtostderr").Value.Set("true") - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("vtbench", pflag.ExitOnError)) clientProto := vtbench.MySQL switch *protocol { diff --git a/go/cmd/vtclient/vtclient.go b/go/cmd/vtclient/vtclient.go index 731a3873e2f..04239f32cf3 100644 --- a/go/cmd/vtclient/vtclient.go +++ b/go/cmd/vtclient/vtclient.go @@ -31,6 +31,7 @@ import ( "time" "github.com/olekukonko/tablewriter" + "github.com/spf13/pflag" "vitess.io/vitess/go/vt/concurrency" "vitess.io/vitess/go/vt/log" @@ -147,7 +148,7 @@ func main() { } func run() (*results, error) { - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("vtclient", pflag.ExitOnError)) args := _flag.Args() if len(args) == 0 { diff --git a/go/cmd/vtctlclient/main.go b/go/cmd/vtctlclient/main.go index 2b152f38b37..0b49598572b 100644 --- a/go/cmd/vtctlclient/main.go +++ b/go/cmd/vtctlclient/main.go @@ -25,6 +25,8 @@ import ( "strings" "time" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/trace" "vitess.io/vitess/go/vt/log" @@ -70,7 +72,7 @@ func checkDeprecations(args []string) { func main() { defer exit.Recover() - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("vtctlclient", pflag.ExitOnError)) closer := trace.StartTracing("vtctlclient") defer trace.LogErrorsWhenClosing(closer) diff --git a/go/cmd/vtgate/vtgate.go b/go/cmd/vtgate/vtgate.go index 9994f16e6d5..f6f3c0384cf 100644 --- a/go/cmd/vtgate/vtgate.go +++ b/go/cmd/vtgate/vtgate.go @@ -142,7 +142,7 @@ func main() { log.Exitf("tablet_types_to_wait should contain at least one serving tablet type") } - err := CheckCellFlags(context.Background(), resilientServer, *cell, *vtgate.CellsToWatch) + err := CheckCellFlags(context.Background(), resilientServer, *cell, vtgate.CellsToWatch) if err != nil { log.Exitf("cells_to_watch validation failed: %v", err) } diff --git a/go/cmd/vtgr/main.go b/go/cmd/vtgr/main.go index fc126654775..ff95032571c 100644 --- a/go/cmd/vtgr/main.go +++ b/go/cmd/vtgr/main.go @@ -18,6 +18,8 @@ import ( "flag" "strings" + "github.com/spf13/pflag" + "vitess.io/vitess/go/vt/vtgr" // Include deprecation warnings for soon-to-be-unsupported flag invocations. @@ -26,7 +28,7 @@ import ( func main() { clustersToWatch := flag.String("clusters_to_watch", "", "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\"") - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("vtgr", pflag.ExitOnError)) // openTabletDiscovery will open up a connection to topo server // and populate the tablets in memory diff --git a/go/cmd/vttlstest/vttlstest.go b/go/cmd/vttlstest/vttlstest.go index 2606d99e42c..08cefa8c3ff 100644 --- a/go/cmd/vttlstest/vttlstest.go +++ b/go/cmd/vttlstest/vttlstest.go @@ -21,6 +21,8 @@ import ( "fmt" "io" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/vt/log" "vitess.io/vitess/go/vt/logutil" @@ -137,7 +139,7 @@ func main() { _flag.SetUsage(flag.CommandLine, _flag.UsageOptions{ Preface: func(w io.Writer) { fmt.Fprint(w, doc) }, }) - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("vttlstest", pflag.ExitOnError)) args := _flag.Args() if len(args) == 0 { flag.Usage() diff --git a/go/cmd/zk/zkcmd.go b/go/cmd/zk/zkcmd.go index a2f513bcec3..bbe864082c8 100644 --- a/go/cmd/zk/zkcmd.go +++ b/go/cmd/zk/zkcmd.go @@ -33,6 +33,7 @@ import ( "syscall" "time" + "github.com/spf13/pflag" "github.com/z-division/go-zookeeper/zk" "golang.org/x/term" @@ -140,10 +141,11 @@ func main() { defer exit.Recover() defer logutil.Flush() - _flag.SetUsage(flag.CommandLine, _flag.UsageOptions{ + fs := pflag.NewFlagSet("zkcmd", pflag.ExitOnError) + _flag.SetUsage(flag.CommandLine, _flag.UsageOptions{ // TODO: hmmm Epilogue: func(w io.Writer) { fmt.Fprint(w, doc) }, }) - _flag.Parse() + _flag.Parse(fs) args := _flag.Args() if len(args) == 0 { flag.Usage() diff --git a/go/cmd/zkctl/zkctl.go b/go/cmd/zkctl/zkctl.go index 71aeb1228df..56912748423 100644 --- a/go/cmd/zkctl/zkctl.go +++ b/go/cmd/zkctl/zkctl.go @@ -24,6 +24,8 @@ import ( "io" "os" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/vt/log" "vitess.io/vitess/go/vt/logutil" @@ -60,7 +62,7 @@ func main() { defer exit.Recover() defer logutil.Flush() - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("zkctl", pflag.ExitOnError)) args := _flag.Args() if len(args) == 0 { diff --git a/go/cmd/zkctld/zkctld.go b/go/cmd/zkctld/zkctld.go index 1e29cf387bb..bade6fb57df 100644 --- a/go/cmd/zkctld/zkctld.go +++ b/go/cmd/zkctld/zkctld.go @@ -25,6 +25,8 @@ import ( "os/signal" "syscall" + "github.com/spf13/pflag" + "vitess.io/vitess/go/exit" "vitess.io/vitess/go/vt/log" "vitess.io/vitess/go/vt/logutil" @@ -45,7 +47,7 @@ func main() { defer exit.Recover() defer logutil.Flush() - _flag.Parse() + _flag.Parse(pflag.NewFlagSet("zkctld", pflag.ExitOnError)) zkConfig := zkctl.MakeZkConfigFromString(*zkCfg, uint32(*myID)) zkd := zkctl.NewZkd(zkConfig) diff --git a/go/flags/endtoend/vtgate.txt b/go/flags/endtoend/vtgate.txt index 4e66e126e77..f7443bd79fd 100644 --- a/go/flags/endtoend/vtgate.txt +++ b/go/flags/endtoend/vtgate.txt @@ -1,413 +1,208 @@ Usage of vtgate: - --allowed_tablet_types value - Specifies the tablet types this vtgate is allowed to route queries to - --alsologtostderr - log to standard error as well as files - --buffer_drain_concurrency int - Maximum number of requests retried simultaneously. More concurrency will increase the load on the PRIMARY vttablet when draining the buffer. (default 1) - --buffer_implementation string - Allowed values: healthcheck (legacy implementation), keyspace_events (default) (default keyspace_events) - --buffer_keyspace_shards string - If not empty, limit buffering to these entries (comma separated). Entry format: keyspace or keyspace/shard. Requires --enable_buffer=true. - --buffer_max_failover_duration duration - Stop buffering completely if a failover takes longer than this duration. (default 20s) - --buffer_min_time_between_failovers duration - Minimum time between the end of a failover and the start of the next one (tracked per shard). Faster consecutive failovers will not trigger buffering. (default 1m0s) - --buffer_size int - Maximum number of buffered requests in flight (across all ongoing failovers). (default 1000) - --buffer_window duration - Duration for how long a request should be buffered at most. (default 10s) - --catch-sigpipe - catch and ignore SIGPIPE on stdout and stderr if specified - --cell string - cell to use (default test_nj) - --cells_to_watch string - comma-separated list of cells for watching tablets - --consul_auth_static_file string - JSON File to read the topos/tokens from. - --cpu_profile string - deprecated: use '-pprof=cpu' instead - --datadog-agent-host string - host to send spans to. if empty, no tracing will be done - --datadog-agent-port string - port to send spans to. if empty, no tracing will be done - --dbddl_plugin string - controls how to handle CREATE/DROP DATABASE. use it if you are using your own database provisioning service (default fail) - --ddl_strategy string - Set default strategy for DDL statements. Override with @@ddl_strategy session variable (default direct) - --default_tablet_type value - The default tablet type to set for queries, when one is not explicitly selected (default PRIMARY) - --disable_local_gateway - deprecated: if specified, this process will not route any queries to local tablets in the local cell - --discovery_high_replication_lag_minimum_serving duration - the replication lag that is considered too high when applying the min_number_serving_vttablets threshold (default 2h0m0s) - --discovery_low_replication_lag duration - the replication lag that is considered low enough to be healthy (default 30s) - --emit_stats - If set, emit stats to push-based monitoring and stats backends - --enable_buffer - Enable buffering (stalling) of primary traffic during failovers. - --enable_buffer_dry_run - Detect and log failover events, but do not actually buffer requests. - --enable_direct_ddl - Allow users to submit direct DDL statements (default true) - --enable_online_ddl - Allow users to submit, review and control Online DDL (default true) - --enable_set_var - This will enable the use of MySQL's SET_VAR query hint for certain system variables instead of using reserved connections (default true) - --enable_system_settings - This will enable the system settings to be changed per session at the database connection level (default true) - --foreign_key_mode string - This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow, disallow (default allow) - --gate_query_cache_lfu - gate server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true) - --gate_query_cache_memory int - gate server query cache size in bytes, maximum amount of memory to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432) - --gate_query_cache_size int - gate server query cache size, maximum number of queries to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a cache. This config controls the expected amount of unique entries in the cache. (default 5000) - --gateway_initial_tablet_timeout duration - At startup, the tabletGateway will wait up to this duration to get at least one tablet per keyspace/shard/tablet type (default 30s) - --gateway_route_replica_to_rdonly - route REPLICA queries to RDONLY tablets as well as REPLICA tablets - --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_client_creds string - when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server - --grpc_auth_static_password_file string - JSON File to read the users/passwords from. - --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_compression string - Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy - --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_enable_tracing - Enable GRPC tracing - --grpc_initial_conn_window_size int - gRPC initial connection window size - --grpc_initial_window_size int - gRPC initial window size - --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) - --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) - --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_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) - --grpc_port int - Port to listen on for gRPC calls - --grpc_prometheus - Enable gRPC monitoring with Prometheus - --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_use_effective_callerid - If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. - --healthcheck_retry_delay duration - health check retry delay (default 2ms) - --healthcheck_timeout duration - the health check timeout period (default 1m0s) - --jaeger-agent-host string - host and port to send spans to. if empty, no tracing will be done - --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) - --keyspaces_to_watch value - Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema - --lameduck-period duration - keep running at least this long after SIGTERM before stopping (default 50ms) - --legacy_replication_lag_algorithm - use the legacy algorithm when selecting the vttablets for serving (default true) - --lock_heartbeat_time duration - If there is lock function used. This will keep the lock connection active by using this heartbeat (default 5s) - --log_backtrace_at value - 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_queries_to_file string - Enable query logging to the specified file - --log_rotate_max_size uint - size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) - --logtostderr - log to standard error instead of files - --max_memory_rows int - Maximum number of rows that will be held in memory for intermediate results as well as the final result. (default 300000) - --max_payload_size int - The threshold for query payloads in bytes. A payload greater than this threshold will result in a failure to handle the query. - --mem-profile-rate int - deprecated: use '-pprof=mem' instead (default 524288) - --message_stream_grace_period duration - the amount of time to give for a vttablet to resume if it ends a message stream, usually because of a reparent. (default 30s) - --min_number_serving_vttablets int - the minimum number of vttablets for each replicating tablet_type (e.g. replica, rdonly) that will be continue to be used even with replication lag above discovery_low_replication_lag, but still below discovery_high_replication_lag_minimum_serving (default 2) - --mutex-profile-fraction int - deprecated: use '-pprof=mutex' instead - --mysql-server-pool-conn-read-buffers - If set, the server will pool incoming connection read buffers - --mysql_allow_clear_text_without_tls - If set, the server will allow the use of a clear text password over non-SSL connections. - --mysql_auth_server_impl string - Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default static) - --mysql_auth_server_static_file string - JSON File to read the users/passwords from. - --mysql_auth_server_static_string string - JSON representation of the users/passwords config. - --mysql_auth_static_reload_interval duration - Ticker to reload credentials - --mysql_auth_vault_addr string - URL to Vault server - --mysql_auth_vault_path string - Vault path to vtgate credentials JSON blob, e.g.: secret/data/prod/vtgatecreds - --mysql_auth_vault_role_mountpoint string - Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default approle) - --mysql_auth_vault_role_secretidfile string - Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable - --mysql_auth_vault_roleid string - Vault AppRole id; can also be passed using VAULT_ROLEID environment variable - --mysql_auth_vault_timeout duration - Timeout for vault API operations (default 10s) - --mysql_auth_vault_tls_ca string - Path to CA PEM for validating Vault server certificate - --mysql_auth_vault_tokenfile string - Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable - --mysql_auth_vault_ttl duration - How long to cache vtgate credentials from the Vault server (default 30m0s) - --mysql_clientcert_auth_method string - client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password) - --mysql_default_workload string - Default session workload (OLTP, OLAP, DBA) (default OLTP) - --mysql_ldap_auth_config_file string - JSON File from which to read LDAP server config. - --mysql_ldap_auth_config_string string - JSON representation of LDAP server config. - --mysql_ldap_auth_method string - client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password) - --mysql_server_bind_address string - Binds on this address when listening to MySQL binary protocol. Useful to restrict listening to 'localhost' only for instance. - --mysql_server_flush_delay duration - Delay after which buffered response will be flushed to the client. (default 100ms) - --mysql_server_port int - If set, also listen for MySQL binary protocol connections on this port. (default -1) - --mysql_server_query_timeout duration - mysql query timeout - --mysql_server_read_timeout duration - connection read timeout - --mysql_server_require_secure_transport - Reject insecure connections but only if mysql_server_ssl_cert and mysql_server_ssl_key are provided - --mysql_server_socket_path string - This option specifies the Unix socket file to use when listening for local connections. By default it will be empty and it won't listen to a unix socket - --mysql_server_ssl_ca string - Path to ssl CA for mysql server plugin SSL. If specified, server will require and validate client certs. - --mysql_server_ssl_cert string - Path to the ssl cert for mysql server plugin SSL - --mysql_server_ssl_crl string - Path to ssl CRL for mysql server plugin SSL - --mysql_server_ssl_key string - Path to ssl key for mysql server plugin SSL - --mysql_server_ssl_server_ca string - path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients - --mysql_server_tls_min_version string - Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. - --mysql_server_version string - MySQL server version to advertise. - --mysql_server_write_timeout duration - connection write timeout - --mysql_slow_connect_warn_threshold duration - Warn if it takes more than the given threshold for a mysql connection to establish - --mysql_tcp_version string - Select tcp, tcp4, or tcp6 to control the socket type. (default tcp) - --no_scatter - when set to true, the planner will fail instead of producing a plan that includes scatter queries - --normalize_queries - Rewrite queries with bind vars. Turn this off if the app itself sends normalized queries with bind vars. (default true) - --onclose_timeout duration - wait no more than this for OnClose handlers before stopping (default 1ns) - --onterm_timeout duration - wait no more than this for OnTermSync handlers before stopping (default 10s) - --opentsdb_uri string - URI of opentsdb /api/put method - --pid_file string - If set, the process will write its pid to the named file, and delete it on graceful shutdown. - --planner-version string - Sets the default planner to use when the session has not changed it. Valid values are: V3, Gen4, Gen4Greedy and Gen4Fallback. Gen4Fallback tries the gen4 planner and falls back to the V3 planner if the gen4 fails. - --planner_version string - Deprecated flag. Use planner-version instead - --port int - port for the server - --pprof string - enable profiling - --proxy_protocol - Enable HAProxy PROXY protocol on MySQL listener socket - --purge_logs_interval duration - how often try to remove old logs (default 1h0m0s) - --querylog-filter-tag string - string that must be present in the query for it to be logged; if using a value as the tag, you need to disable query normalization - --querylog-format string - format for query logs ("text" or "json") (default text) - --querylog-row-threshold uint - Number of rows a query has to return or affect before being logged; not useful for streaming queries. 0 means all queries will be logged. - --redact-debug-ui-queries - redact full queries and bind variables from debug UI - --remote_operation_timeout duration - time to wait for a remote operation (default 30s) - --retry-count int - retry count (default 2) - --schema_change_signal - Enable the schema tracker; requires queryserver-config-schema-change-signal to be enabled on the underlying vttablets for this to work (default true) - --schema_change_signal_user string - User to be used to send down query to vttablet to retrieve schema changes - --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) - --service_map value - comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice - --sql-max-length-errors int - truncate queries in error logs to the given length (default unlimited) - --sql-max-length-ui int - truncate queries in debug UIs to the given length (default 512) (default 512) - --srv_topo_cache_refresh duration - how frequently to refresh the topology for cached entries (default 1s) - --srv_topo_cache_ttl duration - how long to use cached entries for topology (default 1s) - --srv_topo_timeout duration - topo server timeout (default 5s) - --stats_backend string - The name of the registered push-based monitoring/stats backend to use - --stats_combine_dimensions string - List of dimensions to be combined into a single "all" value in exported stats vars - --stats_common_tags string - Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 - --stats_drop_variables string - Variables to be dropped from the list of exported variables. - --stats_emit_period duration - Interval between emitting stats to all registered backends (default 1m0s) - --statsd_address string - Address for statsd client - --statsd_sample_rate float - (default 1) - --stderrthreshold value - logs at or above this threshold go to stderr (default 1) - --stream_buffer_size int - the number of bytes sent from vtgate for each stream call. It's recommended to keep this value in sync with vttablet's query-server-config-stream-buffer-size. (default 32768) - --structured-logging - whether to use structured logging (Zap) or the original (glog) logger - --tablet_filters value - Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch - --tablet_grpc_ca string - the server ca to use to validate servers when connecting - --tablet_grpc_cert string - the cert to use to connect - --tablet_grpc_crl string - the server crl to use to validate server certificates when connecting - --tablet_grpc_key string - the key to use to connect - --tablet_grpc_server_name string - the server name to use to validate server certificate - --tablet_manager_protocol string - the protocol to use to talk to vttablet (default grpc) - --tablet_protocol string - how to talk to the vttablets (default grpc) - --tablet_refresh_interval duration - tablet refresh interval (default 1m0s) - --tablet_refresh_known_tablets - tablet refresh reloads the tablet address/port map from topo in case it changes (default true) - --tablet_types_to_wait string - wait till connected for specified tablet types during Gateway initialization - --tablet_url_template string - format string describing debug tablet url formatting. See the Go code for getTabletDebugURL() how to customize this. (default http://{{.GetTabletHostPort}}) - --topo_consul_idle_conn_timeout duration - Maximum amount of time to pool idle connections. (default 1m30s) - --topo_consul_lock_delay duration - LockDelay for consul session. (default 15s) - --topo_consul_lock_session_checks string - List of checks for consul session. (default serfHealth) - --topo_consul_lock_session_ttl string - TTL for consul session. - --topo_consul_max_conns_per_host int - Maximum number of consul connections per host. - --topo_consul_max_idle_conns int - Maximum number of idle consul connections. (default 100) - --topo_consul_watch_poll_duration duration - time of the long poll for watch queries. (default 30s) - --topo_etcd_lease_ttl int - Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) - --topo_etcd_tls_ca string - path to the ca to use to validate the server cert when connecting to the etcd topo server - --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 - --topo_etcd_tls_key string - path to the client key to use to connect to the etcd topo server, enables TLS - --topo_global_root string - the path of the global topology data in the global topology server - --topo_global_server_address string - the address of the global topology server - --topo_implementation string - the topology implementation to use - --topo_k8s_context string - The kubeconfig context to use, overrides the 'current-context' from the config - --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 - --topo_k8s_namespace string - The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config - --topo_read_concurrency int - concurrent topo reads (default 32) - --topo_zk_auth_file string - auth to use when connecting to the zk topo server, file contents should be :, e.g., digest:user:pass - --topo_zk_base_timeout duration - zk base timeout (see zk.Connect) (default 30s) - --topo_zk_max_concurrency int - maximum number of pending requests to send to a Zookeeper server. (default 64) - --topo_zk_tls_ca string - the server ca to use to validate servers when connecting to the zk topo server - --topo_zk_tls_cert string - the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS - --topo_zk_tls_key string - the key to use to connect to the zk topo server, enables TLS - --tracer string - tracing service to use (default noop) - --tracing-enable-logging - whether to enable logging in the tracing service - --tracing-sampling-rate value - sampling rate for the probabilistic jaeger sampler (default 0.1) - --tracing-sampling-type value - sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) - --transaction_mode string - SINGLE: disallow multi-db transactions, MULTI: allow multi-db transactions with best effort commit, TWOPC: allow multi-db transactions with 2pc commit (default MULTI) - --v value - log level for V logs - --version - print binary version - --vmodule value - comma-separated list of pattern=N settings for file-filtered logging - --vschema_ddl_authorized_users string - List of users authorized to execute vschema ddl operations, or '%' to allow all users. - --vtctld_addr string - address of a vtctld instance - --vtgate-config-terse-errors - prevent bind vars from escaping in returned errors - --warn_memory_rows int - Warning threshold for in-memory results. A row count higher than this amount will cause the VtGateWarnings.ResultsExceeded counter to be incremented. (default 30000) - --warn_payload_size int - The warning threshold for query payloads in bytes. A payload greater than this threshold will cause the VtGateWarnings.WarnPayloadSizeExceeded counter to be incremented. - --warn_sharded_only - If any features that are only available in unsharded mode are used, query execution warnings will be added to the session + --allowed_tablet_types TabletTypeList Specifies the tablet types this vtgate is allowed to route queries to + --alsologtostderr log to standard error as well as files + --buffer_drain_concurrency int Maximum number of requests retried simultaneously. More concurrency will increase the load on the PRIMARY vttablet when draining the buffer. (default 1) + --buffer_implementation string Allowed values: healthcheck (legacy implementation), keyspace_events (default) (default "keyspace_events") + --buffer_keyspace_shards string If not empty, limit buffering to these entries (comma separated). Entry format: keyspace or keyspace/shard. Requires --enable_buffer=true. + --buffer_max_failover_duration duration Stop buffering completely if a failover takes longer than this duration. (default 20s) + --buffer_min_time_between_failovers duration Minimum time between the end of a failover and the start of the next one (tracked per shard). Faster consecutive failovers will not trigger buffering. (default 1m0s) + --buffer_size int Maximum number of buffered requests in flight (across all ongoing failovers). (default 1000) + --buffer_window duration Duration for how long a request should be buffered at most. (default 10s) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --cell string cell to use (default "test_nj") + --cells_to_watch string comma-separated list of cells for watching tablets + --consul_auth_static_file string JSON File to read the topos/tokens from. + --cpu_profile string deprecated: use '-pprof=cpu' instead + --datadog-agent-host string host to send spans to. if empty, no tracing will be done + --datadog-agent-port string port to send spans to. if empty, no tracing will be done + --dbddl_plugin string controls how to handle CREATE/DROP DATABASE. use it if you are using your own database provisioning service (default "fail") + --ddl_strategy string Set default strategy for DDL statements. Override with @@ddl_strategy session variable (default "direct") + --default_tablet_type TabletTypeFlag The default tablet type to set for queries, when one is not explicitly selected (default PRIMARY) + --disable_local_gateway deprecated: if specified, this process will not route any queries to local tablets in the local cell + --discovery_high_replication_lag_minimum_serving duration the replication lag that is considered too high when applying the min_number_serving_vttablets threshold (default 2h0m0s) + --discovery_low_replication_lag duration the replication lag that is considered low enough to be healthy (default 30s) + --emit_stats If set, emit stats to push-based monitoring and stats backends + --enable_buffer Enable buffering (stalling) of primary traffic during failovers. + --enable_buffer_dry_run Detect and log failover events, but do not actually buffer requests. + --enable_direct_ddl Allow users to submit direct DDL statements (default true) + --enable_online_ddl Allow users to submit, review and control Online DDL (default true) + --enable_set_var This will enable the use of MySQL's SET_VAR query hint for certain system variables instead of using reserved connections (default true) + --enable_system_settings This will enable the system settings to be changed per session at the database connection level (default true) + --foreign_key_mode string This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow, disallow (default "allow") + --gate_query_cache_lfu gate server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true) + --gate_query_cache_memory int gate server query cache size in bytes, maximum amount of memory to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432) + --gate_query_cache_size int gate server query cache size, maximum number of queries to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a cache. This config controls the expected amount of unique entries in the cache. (default 5000) + --gateway_initial_tablet_timeout duration At startup, the tabletGateway will wait up to this duration to get at least one tablet per keyspace/shard/tablet type (default 30s) + --gateway_route_replica_to_rdonly route REPLICA queries to RDONLY tablets as well as REPLICA tablets + --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_client_creds string when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server + --grpc_auth_static_password_file string JSON File to read the users/passwords from. + --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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy + --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_enable_tracing Enable GRPC tracing + --grpc_initial_conn_window_size int gRPC initial connection window size + --grpc_initial_window_size int gRPC initial window size + --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) + --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) + --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_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) + --grpc_port int Port to listen on for gRPC calls + --grpc_prometheus Enable gRPC monitoring with Prometheus + --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_use_effective_callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. + --healthcheck_retry_delay duration health check retry delay (default 2ms) + --healthcheck_timeout duration the health check timeout period (default 1m0s) + -h, --help display usage and exit + --jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done + --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) (default 0s) + --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) (default 0s) + --keyspaces_to_watch StringList Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --legacy_replication_lag_algorithm use the legacy algorithm when selecting the vttablets for serving (default true) + --lock_heartbeat_time duration If there is lock function used. This will keep the lock connection active by using this heartbeat (default 5s) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --log_err_stacks log stack traces for errors + --log_queries_to_file string Enable query logging to the specified file + --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) + --logtostderr log to standard error instead of files + --max_memory_rows int Maximum number of rows that will be held in memory for intermediate results as well as the final result. (default 300000) + --max_payload_size int The threshold for query payloads in bytes. A payload greater than this threshold will result in a failure to handle the query. + --mem-profile-rate int deprecated: use '-pprof=mem' instead (default 524288) + --message_stream_grace_period duration the amount of time to give for a vttablet to resume if it ends a message stream, usually because of a reparent. (default 30s) + --min_number_serving_vttablets int the minimum number of vttablets for each replicating tablet_type (e.g. replica, rdonly) that will be continue to be used even with replication lag above discovery_low_replication_lag, but still below discovery_high_replication_lag_minimum_serving (default 2) + --mutex-profile-fraction int deprecated: use '-pprof=mutex' instead + --mysql-server-pool-conn-read-buffers If set, the server will pool incoming connection read buffers + --mysql_allow_clear_text_without_tls If set, the server will allow the use of a clear text password over non-SSL connections. + --mysql_auth_server_impl string Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static") + --mysql_auth_server_static_file string JSON File to read the users/passwords from. + --mysql_auth_server_static_string string JSON representation of the users/passwords config. + --mysql_auth_static_reload_interval duration Ticker to reload credentials (default 0s) + --mysql_auth_vault_addr string URL to Vault server + --mysql_auth_vault_path string Vault path to vtgate credentials JSON blob, e.g.: secret/data/prod/vtgatecreds + --mysql_auth_vault_role_mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --mysql_auth_vault_role_secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --mysql_auth_vault_roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --mysql_auth_vault_timeout duration Timeout for vault API operations (default 10s) + --mysql_auth_vault_tls_ca string Path to CA PEM for validating Vault server certificate + --mysql_auth_vault_tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --mysql_auth_vault_ttl duration How long to cache vtgate credentials from the Vault server (default 30m0s) + --mysql_clientcert_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default "mysql_clear_password") + --mysql_default_workload string Default session workload (OLTP, OLAP, DBA) (default "OLTP") + --mysql_ldap_auth_config_file string JSON File from which to read LDAP server config. + --mysql_ldap_auth_config_string string JSON representation of LDAP server config. + --mysql_ldap_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default "mysql_clear_password") + --mysql_server_bind_address string Binds on this address when listening to MySQL binary protocol. Useful to restrict listening to 'localhost' only for instance. + --mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms) + --mysql_server_port int If set, also listen for MySQL binary protocol connections on this port. (default -1) + --mysql_server_query_timeout duration mysql query timeout (default 0s) + --mysql_server_read_timeout duration connection read timeout (default 0s) + --mysql_server_require_secure_transport Reject insecure connections but only if mysql_server_ssl_cert and mysql_server_ssl_key are provided + --mysql_server_socket_path string This option specifies the Unix socket file to use when listening for local connections. By default it will be empty and it won't listen to a unix socket + --mysql_server_ssl_ca string Path to ssl CA for mysql server plugin SSL. If specified, server will require and validate client certs. + --mysql_server_ssl_cert string Path to the ssl cert for mysql server plugin SSL + --mysql_server_ssl_crl string Path to ssl CRL for mysql server plugin SSL + --mysql_server_ssl_key string Path to ssl key for mysql server plugin SSL + --mysql_server_ssl_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients + --mysql_server_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --mysql_server_version string MySQL server version to advertise. + --mysql_server_write_timeout duration connection write timeout (default 0s) + --mysql_slow_connect_warn_threshold duration Warn if it takes more than the given threshold for a mysql connection to establish (default 0s) + --mysql_tcp_version string Select tcp, tcp4, or tcp6 to control the socket type. (default "tcp") + --no_scatter when set to true, the planner will fail instead of producing a plan that includes scatter queries + --normalize_queries Rewrite queries with bind vars. Turn this off if the app itself sends normalized queries with bind vars. (default true) + --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) + --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) + --opentsdb_uri string URI of opentsdb /api/put method + --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. + --planner-version string Sets the default planner to use when the session has not changed it. Valid values are: V3, Gen4, Gen4Greedy and Gen4Fallback. Gen4Fallback tries the gen4 planner and falls back to the V3 planner if the gen4 fails. + --planner_version string Deprecated flag. Use planner-version instead + --port int port for the server + --pprof string enable profiling + --proxy_protocol Enable HAProxy PROXY protocol on MySQL listener socket + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --querylog-filter-tag string string that must be present in the query for it to be logged; if using a value as the tag, you need to disable query normalization + --querylog-format string format for query logs ("text" or "json") (default "text") + --querylog-row-threshold uint Number of rows a query has to return or affect before being logged; not useful for streaming queries. 0 means all queries will be logged. + --redact-debug-ui-queries redact full queries and bind variables from debug UI + --remote_operation_timeout duration time to wait for a remote operation (default 30s) + --retry-count int retry count (default 2) + --schema_change_signal Enable the schema tracker; requires queryserver-config-schema-change-signal to be enabled on the underlying vttablets for this to work (default true) + --schema_change_signal_user string User to be used to send down query to vttablet to retrieve schema changes + --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) + --service_map StringList comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice + --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) + --sql-max-length-ui int truncate queries in debug UIs to the given length (default 512) (default 512) + --srv_topo_cache_refresh duration how frequently to refresh the topology for cached entries (default 1s) + --srv_topo_cache_ttl duration how long to use cached entries for topology (default 1s) + --srv_topo_timeout duration topo server timeout (default 5s) + --stats_backend string The name of the registered push-based monitoring/stats backend to use + --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars + --stats_common_tags string Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 + --stats_drop_variables string Variables to be dropped from the list of exported variables. + --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) + --statsd_address string Address for statsd client + --statsd_sample_rate float (default 1) + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --stream_buffer_size int the number of bytes sent from vtgate for each stream call. It's recommended to keep this value in sync with vttablet's query-server-config-stream-buffer-size. (default 32768) + --structured-logging whether to use structured logging (Zap) or the original (glog) logger + --tablet_filters StringList Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch + --tablet_grpc_ca string the server ca to use to validate servers when connecting + --tablet_grpc_cert string the cert to use to connect + --tablet_grpc_crl string the server crl to use to validate server certificates when connecting + --tablet_grpc_key string the key to use to connect + --tablet_grpc_server_name string the server name to use to validate server certificate + --tablet_manager_protocol string the protocol to use to talk to vttablet (default "grpc") + --tablet_protocol string how to talk to the vttablets (default "grpc") + --tablet_refresh_interval duration tablet refresh interval (default 1m0s) + --tablet_refresh_known_tablets tablet refresh reloads the tablet address/port map from topo in case it changes (default true) + --tablet_types_to_wait string wait till connected for specified tablet types during Gateway initialization + --tablet_url_template string format string describing debug tablet url formatting. See the Go code for getTabletDebugURL() how to customize this. (default "http://{{.GetTabletHostPort}}") + --topo_consul_idle_conn_timeout duration Maximum amount of time to pool idle connections. (default 1m30s) + --topo_consul_lock_delay duration LockDelay for consul session. (default 15s) + --topo_consul_lock_session_checks string List of checks for consul session. (default "serfHealth") + --topo_consul_lock_session_ttl string TTL for consul session. + --topo_consul_max_conns_per_host int Maximum number of consul connections per host. + --topo_consul_max_idle_conns int Maximum number of idle consul connections. (default 100) + --topo_consul_watch_poll_duration duration time of the long poll for watch queries. (default 30s) + --topo_etcd_lease_ttl int Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) + --topo_etcd_tls_ca string path to the ca to use to validate the server cert when connecting to the etcd topo server + --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 + --topo_etcd_tls_key string path to the client key to use to connect to the etcd topo server, enables TLS + --topo_global_root string the path of the global topology data in the global topology server + --topo_global_server_address string the address of the global topology server + --topo_implementation string the topology implementation to use + --topo_k8s_context string The kubeconfig context to use, overrides the 'current-context' from the config + --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 + --topo_k8s_namespace string The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config + --topo_read_concurrency int concurrent topo reads (default 32) + --topo_zk_auth_file string auth to use when connecting to the zk topo server, file contents should be :, e.g., digest:user:pass + --topo_zk_base_timeout duration zk base timeout (see zk.Connect) (default 30s) + --topo_zk_max_concurrency int maximum number of pending requests to send to a Zookeeper server. (default 64) + --topo_zk_tls_ca string the server ca to use to validate servers when connecting to the zk topo server + --topo_zk_tls_cert string the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS + --topo_zk_tls_key string the key to use to connect to the zk topo server, enables TLS + --tracer string tracing service to use (default "noop") + --tracing-enable-logging whether to enable logging in the tracing service + --tracing-sampling-rate OptionalFloat64 sampling rate for the probabilistic jaeger sampler (default 0.1) + --tracing-sampling-type OptionalString sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) + --transaction_mode string SINGLE: disallow multi-db transactions, MULTI: allow multi-db transactions with best effort commit, TWOPC: allow multi-db transactions with 2pc commit (default "MULTI") + -v, --v Level log level for V logs + --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging + --vschema_ddl_authorized_users string List of users authorized to execute vschema ddl operations, or '%' to allow all users. + --vtctld_addr string address of a vtctld instance + --vtgate-config-terse-errors prevent bind vars from escaping in returned errors + --warn_memory_rows int Warning threshold for in-memory results. A row count higher than this amount will cause the VtGateWarnings.ResultsExceeded counter to be incremented. (default 30000) + --warn_payload_size int The warning threshold for query payloads in bytes. A payload greater than this threshold will cause the VtGateWarnings.WarnPayloadSizeExceeded counter to be incremented. + --warn_sharded_only If any features that are only available in unsharded mode are used, query execution warnings will be added to the session diff --git a/go/flags/endtoend/vttablet.txt b/go/flags/endtoend/vttablet.txt index c097b52f0a9..a1b7b7d023f 100644 --- a/go/flags/endtoend/vttablet.txt +++ b/go/flags/endtoend/vttablet.txt @@ -1,1045 +1,512 @@ Usage of vttablet: - --allowed_tablet_types value - Specifies the tablet types this vtgate is allowed to route queries to - --alsologtostderr - log to standard error as well as files - --app_idle_timeout duration - Idle timeout for app connections (default 1m0s) - --app_pool_size int - Size of the connection pool for app connections (default 40) - --azblob_backup_account_key_file string - Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) - --azblob_backup_account_name string - Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used - --azblob_backup_container_name string - Azure Blob Container Name - --azblob_backup_parallelism int - Azure Blob operation parallelism (requires extra memory when increased) (default 1) - --azblob_backup_storage_root string - Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/') - --backup_engine_implementation string - Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default builtin) - --backup_storage_block_size int - if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000) - --backup_storage_compress - if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true) - --backup_storage_hook string - if set, we send the contents of the backup files through this hook. - --backup_storage_implementation string - which implementation to use for the backup storage feature - --backup_storage_number_blocks int - if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2) - --binlog_host string - PITR restore parameter: hostname/IP of binlog server. - --binlog_password string - PITR restore parameter: password of binlog server. - --binlog_player_grpc_ca string - the server ca to use to validate servers when connecting - --binlog_player_grpc_cert string - the cert to use to connect - --binlog_player_grpc_crl string - the server crl to use to validate server certificates when connecting - --binlog_player_grpc_key string - the key to use to connect - --binlog_player_grpc_server_name string - the server name to use to validate server certificate - --binlog_player_protocol string - the protocol to download binlogs from a vttablet (default grpc) - --binlog_port int - PITR restore parameter: port of binlog server. - --binlog_ssl_ca string - PITR restore parameter: Filename containing TLS CA certificate to verify binlog server TLS certificate against. - --binlog_ssl_cert string - PITR restore parameter: Filename containing mTLS client certificate to present to binlog server as authentication. - --binlog_ssl_key string - PITR restore parameter: Filename containing mTLS client private key for use in binlog server authentication. - --binlog_ssl_server_name string - PITR restore parameter: TLS server name (common name) to verify against for the binlog server we are connecting to (If not set: use the hostname or IP supplied in -binlog_host). - --binlog_user string - PITR restore parameter: username of binlog server. - --builtin-compressor string - builtin compressor engine to use (default pgzip) - --builtin-decompressor string - builtin decompressor engine to use (default auto) - --builtinbackup_mysqld_timeout duration - how long to wait for mysqld to shutdown at the start of the backup (default 10m0s) - --builtinbackup_progress duration - how often to send progress updates when backing up large files (default 5s) - --catch-sigpipe - catch and ignore SIGPIPE on stdout and stderr if specified - --ceph_backup_storage_config string - Path to JSON config file for ceph backup storage (default ceph_backup_config.json) - --client-found-rows-pool-size int - DEPRECATED: queryserver-config-transaction-cap will be used instead. - --compression-level int - what level to pass to the compressor (default 1) - --consul_auth_static_file string - JSON File to read the topos/tokens from. - --cpu_profile string - deprecated: use '-pprof=cpu' instead - --datadog-agent-host string - host to send spans to. if empty, no tracing will be done - --datadog-agent-port string - port to send spans to. if empty, no tracing will be done - --db-config-allprivs-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-allprivs-flags uint - deprecated: use db_flags - --db-config-allprivs-flavor string - deprecated: use db_flavor - --db-config-allprivs-host string - deprecated: use db_host - --db-config-allprivs-pass string - db allprivs deprecated: use db_allprivs_password - --db-config-allprivs-port int - deprecated: use db_port - --db-config-allprivs-server_name string - deprecated: use db_server_name - --db-config-allprivs-ssl-ca string - deprecated: use db_ssl_ca - --db-config-allprivs-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-allprivs-ssl-cert string - deprecated: use db_ssl_cert - --db-config-allprivs-ssl-key string - deprecated: use db_ssl_key - --db-config-allprivs-uname string - deprecated: use db_allprivs_user (default vt_allprivs) - --db-config-allprivs-unixsocket string - deprecated: use db_socket - --db-config-app-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-app-flags uint - deprecated: use db_flags - --db-config-app-flavor string - deprecated: use db_flavor - --db-config-app-host string - deprecated: use db_host - --db-config-app-pass string - db app deprecated: use db_app_password - --db-config-app-port int - deprecated: use db_port - --db-config-app-server_name string - deprecated: use db_server_name - --db-config-app-ssl-ca string - deprecated: use db_ssl_ca - --db-config-app-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-app-ssl-cert string - deprecated: use db_ssl_cert - --db-config-app-ssl-key string - deprecated: use db_ssl_key - --db-config-app-uname string - deprecated: use db_app_user (default vt_app) - --db-config-app-unixsocket string - deprecated: use db_socket - --db-config-appdebug-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-appdebug-flags uint - deprecated: use db_flags - --db-config-appdebug-flavor string - deprecated: use db_flavor - --db-config-appdebug-host string - deprecated: use db_host - --db-config-appdebug-pass string - db appdebug deprecated: use db_appdebug_password - --db-config-appdebug-port int - deprecated: use db_port - --db-config-appdebug-server_name string - deprecated: use db_server_name - --db-config-appdebug-ssl-ca string - deprecated: use db_ssl_ca - --db-config-appdebug-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-appdebug-ssl-cert string - deprecated: use db_ssl_cert - --db-config-appdebug-ssl-key string - deprecated: use db_ssl_key - --db-config-appdebug-uname string - deprecated: use db_appdebug_user (default vt_appdebug) - --db-config-appdebug-unixsocket string - deprecated: use db_socket - --db-config-dba-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-dba-flags uint - deprecated: use db_flags - --db-config-dba-flavor string - deprecated: use db_flavor - --db-config-dba-host string - deprecated: use db_host - --db-config-dba-pass string - db dba deprecated: use db_dba_password - --db-config-dba-port int - deprecated: use db_port - --db-config-dba-server_name string - deprecated: use db_server_name - --db-config-dba-ssl-ca string - deprecated: use db_ssl_ca - --db-config-dba-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-dba-ssl-cert string - deprecated: use db_ssl_cert - --db-config-dba-ssl-key string - deprecated: use db_ssl_key - --db-config-dba-uname string - deprecated: use db_dba_user (default vt_dba) - --db-config-dba-unixsocket string - deprecated: use db_socket - --db-config-erepl-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-erepl-dbname string - deprecated: dbname does not need to be explicitly configured - --db-config-erepl-flags uint - deprecated: use db_flags - --db-config-erepl-flavor string - deprecated: use db_flavor - --db-config-erepl-host string - deprecated: use db_host - --db-config-erepl-pass string - db erepl deprecated: use db_erepl_password - --db-config-erepl-port int - deprecated: use db_port - --db-config-erepl-server_name string - deprecated: use db_server_name - --db-config-erepl-ssl-ca string - deprecated: use db_ssl_ca - --db-config-erepl-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-erepl-ssl-cert string - deprecated: use db_ssl_cert - --db-config-erepl-ssl-key string - deprecated: use db_ssl_key - --db-config-erepl-uname string - deprecated: use db_erepl_user (default vt_erepl) - --db-config-erepl-unixsocket string - deprecated: use db_socket - --db-config-filtered-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-filtered-flags uint - deprecated: use db_flags - --db-config-filtered-flavor string - deprecated: use db_flavor - --db-config-filtered-host string - deprecated: use db_host - --db-config-filtered-pass string - db filtered deprecated: use db_filtered_password - --db-config-filtered-port int - deprecated: use db_port - --db-config-filtered-server_name string - deprecated: use db_server_name - --db-config-filtered-ssl-ca string - deprecated: use db_ssl_ca - --db-config-filtered-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-filtered-ssl-cert string - deprecated: use db_ssl_cert - --db-config-filtered-ssl-key string - deprecated: use db_ssl_key - --db-config-filtered-uname string - deprecated: use db_filtered_user (default vt_filtered) - --db-config-filtered-unixsocket string - deprecated: use db_socket - --db-config-repl-charset string - deprecated: use db_charset (default utf8mb4) - --db-config-repl-flags uint - deprecated: use db_flags - --db-config-repl-flavor string - deprecated: use db_flavor - --db-config-repl-host string - deprecated: use db_host - --db-config-repl-pass string - db repl deprecated: use db_repl_password - --db-config-repl-port int - deprecated: use db_port - --db-config-repl-server_name string - deprecated: use db_server_name - --db-config-repl-ssl-ca string - deprecated: use db_ssl_ca - --db-config-repl-ssl-ca-path string - deprecated: use db_ssl_ca_path - --db-config-repl-ssl-cert string - deprecated: use db_ssl_cert - --db-config-repl-ssl-key string - deprecated: use db_ssl_key - --db-config-repl-uname string - deprecated: use db_repl_user (default vt_repl) - --db-config-repl-unixsocket string - deprecated: use db_socket - --db-credentials-file string - db credentials file; send SIGHUP to reload this file - --db-credentials-server string - db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default file) - --db-credentials-vault-addr string - URL to Vault server - --db-credentials-vault-path string - Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds - --db-credentials-vault-role-mountpoint string - Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default approle) - --db-credentials-vault-role-secretidfile string - Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable - --db-credentials-vault-roleid string - Vault AppRole id; can also be passed using VAULT_ROLEID environment variable - --db-credentials-vault-timeout duration - Timeout for vault API operations (default 10s) - --db-credentials-vault-tls-ca string - Path to CA PEM for validating Vault server certificate - --db-credentials-vault-tokenfile string - Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable - --db-credentials-vault-ttl duration - How long to cache DB credentials from the Vault server (default 30m0s) - --db_allprivs_password string - db allprivs password - --db_allprivs_use_ssl - Set this flag to false to make the allprivs connection to not use ssl (default true) - --db_allprivs_user string - db allprivs user userKey (default vt_allprivs) - --db_app_password string - db app password - --db_app_use_ssl - Set this flag to false to make the app connection to not use ssl (default true) - --db_app_user string - db app user userKey (default vt_app) - --db_appdebug_password string - db appdebug password - --db_appdebug_use_ssl - Set this flag to false to make the appdebug connection to not use ssl (default true) - --db_appdebug_user string - db appdebug user userKey (default vt_appdebug) - --db_charset string - Character set used for this tablet. (default utf8mb4) - --db_conn_query_info - enable parsing and processing of QUERY_OK info fields - --db_connect_timeout_ms int - connection timeout to mysqld in milliseconds (0 for no timeout) - --db_dba_password string - db dba password - --db_dba_use_ssl - Set this flag to false to make the dba connection to not use ssl (default true) - --db_dba_user string - db dba user userKey (default vt_dba) - --db_erepl_password string - db erepl password - --db_erepl_use_ssl - Set this flag to false to make the erepl connection to not use ssl (default true) - --db_erepl_user string - db erepl user userKey (default vt_erepl) - --db_filtered_password string - db filtered password - --db_filtered_use_ssl - Set this flag to false to make the filtered connection to not use ssl (default true) - --db_filtered_user string - db filtered user userKey (default vt_filtered) - --db_flags uint - Flag values as defined by MySQL. - --db_flavor string - Flavor overrid. Valid value is FilePos. - --db_host string - The host name for the tcp connection. - --db_port int - tcp port - --db_repl_password string - db repl password - --db_repl_use_ssl - Set this flag to false to make the repl connection to not use ssl (default true) - --db_repl_user string - db repl user userKey (default vt_repl) - --db_server_name string - server name of the DB we are connecting to. - --db_socket string - The unix socket to connect on. If this is specified, host and port will not be used. - --db_ssl_ca string - connection ssl ca - --db_ssl_ca_path string - connection ssl ca path - --db_ssl_cert string - connection ssl certificate - --db_ssl_key string - connection ssl key - --db_ssl_mode value - SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. - --db_tls_min_version string - Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. - --dba_idle_timeout duration - Idle timeout for dba connections (default 1m0s) - --dba_pool_size int - Size of the connection pool for dba connections (default 20) - --degraded_threshold duration - replication lag after which a replica is considered degraded (default 30s) - --disable_active_reparents - if set, do not allow active reparents. Use this to protect a cluster using external reparents. - --discovery_high_replication_lag_minimum_serving duration - the replication lag that is considered too high when applying the min_number_serving_vttablets threshold (default 2h0m0s) - --discovery_low_replication_lag duration - the replication lag that is considered low enough to be healthy (default 30s) - --emit_stats - If set, emit stats to push-based monitoring and stats backends - --enable-autocommit - This flag is deprecated. Autocommit is always allowed. (default true) - --enable-consolidator - Synonym to -enable_consolidator (default true) - --enable-consolidator-replicas - Synonym to -enable_consolidator_replicas - --enable-lag-throttler - Synonym to -enable_lag_throttler - --enable-per-workload-table-metrics - If true, query counts and query error metrics include a label that identifies the workload - --enable-query-plan-field-caching - Synonym to -enable_query_plan_field_caching (default true) - --enable-tx-throttler - Synonym to -enable_tx_throttler - --enable_consolidator - This option enables the query consolidator. (default true) - --enable_consolidator_replicas - This option enables the query consolidator only on replicas. - --enable_hot_row_protection - If true, incoming transactions for the same row (range) will be queued and cannot consume all txpool slots. - --enable_hot_row_protection_dry_run - If true, hot row protection is not enforced but logs if transactions would have been queued. - --enable_lag_throttler - If true, vttablet will run a throttler service, and will implicitly enable heartbeats - --enable_query_plan_field_caching - This option fetches & caches fields (columns) when storing query plans (default true) - --enable_replication_reporter - Use polling to track replication lag. - --enable_semi_sync - Enable semi-sync when configuring replication, on primary and replica tablets only (rdonly tablets will not ack). - --enable_transaction_limit - If true, limit on number of transactions open at the same time will be enforced for all users. User trying to open a new transaction after exhausting their limit will receive an error immediately, regardless of whether there are available slots or not. - --enable_transaction_limit_dry_run - If true, limit on number of transactions open at the same time will be tracked for all users, but not enforced. - --enable_tx_throttler - If true replication-lag-based throttling on transactions will be enabled. - --enforce-tableacl-config - if this flag is true, vttablet will fail to start if a valid tableacl config does not exist - --enforce_strict_trans_tables - If true, vttablet requires MySQL to run with STRICT_TRANS_TABLES or STRICT_ALL_TABLES on. It is recommended to not turn this flag off. Otherwise MySQL may alter your supplied values before saving them to the database. (default true) - --external-compressor string - command with arguments to use when compressing a backup - --external-compressor-extension string - extension to use when using an external compressor - --external-decompressor string - command with arguments to use when decompressing a backup - --file_backup_storage_root string - root directory for the file backup storage - --filecustomrules string - file based custom rule path - --filecustomrules_watch - set up a watch on the target file and reload query rules when it changes - --gc_check_interval duration - Interval between garbage collection checks (default 1h0m0s) - --gc_purge_check_interval duration - Interval between purge discovery checks (default 1m0s) - --gcs_backup_storage_bucket string - Google Cloud Storage bucket to use for backups - --gcs_backup_storage_root string - root prefix for all backup-related object names - --gh-ost-path string - override default gh-ost binary full path - --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_client_creds string - when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server - --grpc_auth_static_password_file string - JSON File to read the users/passwords from. - --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_compression string - Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy - --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_enable_tracing - Enable GRPC tracing - --grpc_initial_conn_window_size int - gRPC initial connection window size - --grpc_initial_window_size int - gRPC initial window size - --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) - --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) - --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_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) - --grpc_port int - Port to listen on for gRPC calls - --grpc_prometheus - Enable gRPC monitoring with Prometheus - --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) - --health_check_interval duration - Interval between health checks (default 20s) - --heartbeat_enable - If true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the table _vt.heartbeat. The result is used to inform the serving state of the vttablet via healthchecks. - --heartbeat_interval duration - How frequently to read and write replication heartbeat. (default 1s) - --heartbeat_on_demand_duration duration - If non-zero, heartbeats are only written upon consumer request, and only run for up to given duration following the request. Frequent requests can keep the heartbeat running consistently; when requests are infrequent heartbeat may completely stop between requests - --hot_row_protection_concurrent_transactions int - Number of concurrent transactions let through to the txpool/MySQL for the same hot row. Should be > 1 to have enough 'ready' transactions in MySQL and benefit from a pipelining effect. (default 5) - --hot_row_protection_max_global_queue_size int - Global queue limit across all row (ranges). Useful to prevent that the queue can grow unbounded. (default 1000) - --hot_row_protection_max_queue_size int - Maximum number of BeginExecute RPCs which will be queued for the same row (range). (default 20) - --init_db_name_override string - (init parameter) override the name of the db used by vttablet. Without this flag, the db name defaults to vt_ - --init_keyspace string - (init parameter) keyspace to use for this tablet - --init_populate_metadata - (init parameter) populate metadata tables even if restore_from_backup is disabled. If restore_from_backup is enabled, metadata tables are always populated regardless of this flag. - --init_shard string - (init parameter) shard to use for this tablet - --init_tablet_type string - (init parameter) the tablet type to use for this tablet. - --init_tags value - (init parameter) comma separated list of key:value pairs used to tag the tablet - --init_timeout duration - (init parameter) timeout to use for the init phase. (default 1m0s) - --jaeger-agent-host string - host and port to send spans to. if empty, no tracing will be done - --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) - --keyspaces_to_watch value - Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema - --lameduck-period duration - keep running at least this long after SIGTERM before stopping (default 50ms) - --legacy_replication_lag_algorithm - use the legacy algorithm when selecting the vttablets for serving (default true) - --lock_tables_timeout duration - How long to keep the table locked before timing out (default 1m0s) - --log_backtrace_at value - 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_queries - Enable query logging to syslog. - --log_queries_to_file string - Enable query logging to the specified file - --log_rotate_max_size uint - size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) - --logtostderr - log to standard error instead of files - --master_connect_retry duration - Deprecated, use -replication_connect_retry (default 10s) - --mem-profile-rate int - deprecated: use '-pprof=mem' instead (default 524288) - --migration_check_interval duration - Interval between migration checks (default 1m0s) - --min_number_serving_vttablets int - the minimum number of vttablets for each replicating tablet_type (e.g. replica, rdonly) that will be continue to be used even with replication lag above discovery_low_replication_lag, but still below discovery_high_replication_lag_minimum_serving (default 2) - --mutex-profile-fraction int - deprecated: use '-pprof=mutex' instead - --mycnf-file string - path to my.cnf, if reading all config params from there - --mycnf_bin_log_path string - mysql binlog path - --mycnf_data_dir string - data directory for mysql - --mycnf_error_log_path string - mysql error log path - --mycnf_general_log_path string - mysql general log path - --mycnf_innodb_data_home_dir string - Innodb data home directory - --mycnf_innodb_log_group_home_dir string - Innodb log group home directory - --mycnf_master_info_file string - mysql master.info file - --mycnf_mysql_port int - port mysql is listening on - --mycnf_pid_file string - mysql pid file - --mycnf_relay_log_index_path string - mysql relay log index path - --mycnf_relay_log_info_path string - mysql relay log info path - --mycnf_relay_log_path string - mysql relay log path - --mycnf_secure_file_priv string - mysql path for loading secure files - --mycnf_server_id int - mysql server id of the server (if specified, mycnf-file will be ignored) - --mycnf_slow_log_path string - mysql slow query log path - --mycnf_socket_file string - mysql socket file - --mycnf_tmp_dir string - mysql tmp directory - --mysql_auth_server_static_file string - JSON File to read the users/passwords from. - --mysql_auth_server_static_string string - JSON representation of the users/passwords config. - --mysql_auth_static_reload_interval duration - Ticker to reload credentials - --mysql_clientcert_auth_method string - client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password) - --mysql_server_flush_delay duration - Delay after which buffered response will be flushed to the client. (default 100ms) - --mysql_server_version string - MySQL server version to advertise. - --mysqlctl_client_protocol string - the protocol to use to talk to the mysqlctl server (default grpc) - --mysqlctl_mycnf_template string - template file to use for generating the my.cnf file during server init - --mysqlctl_socket string - socket file to use for remote mysqlctl actions (empty for local actions) - --onclose_timeout duration - wait no more than this for OnClose handlers before stopping (default 1ns) - --onterm_timeout duration - wait no more than this for OnTermSync handlers before stopping (default 10s) - --opentsdb_uri string - URI of opentsdb /api/put method - --orc_api_password string - (Optional) Basic auth password to authenticate with Orchestrator's HTTP API. - --orc_api_url string - Address of Orchestrator's HTTP API (e.g. http://host:port/api/). Leave empty to disable Orchestrator integration. - --orc_api_user string - (Optional) Basic auth username to authenticate with Orchestrator's HTTP API. Leave empty to disable basic auth. - --orc_discover_interval duration - How often to ping Orchestrator's HTTP API endpoint to tell it we exist. 0 means never. - --orc_timeout duration - Timeout for calls to Orchestrator's HTTP API (default 30s) - --pid_file string - If set, the process will write its pid to the named file, and delete it on graceful shutdown. - --pitr_gtid_lookup_timeout duration - PITR restore parameter: timeout for fetching gtid from timestamp. (default 1m0s) - --pool-name-prefix string - Deprecated - --pool_hostname_resolve_interval duration - if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) - --port int - port for the server - --pprof string - enable profiling - --pt-osc-path string - override default pt-online-schema-change binary full path - --publish_retry_interval duration - how long vttablet waits to retry publishing the tablet record (default 30s) - --purge_logs_interval duration - how often try to remove old logs (default 1h0m0s) - --query-log-stream-handler string - URL handler for streaming queries log (default /debug/querylog) - --querylog-filter-tag string - string that must be present in the query for it to be logged; if using a value as the tag, you need to disable query normalization - --querylog-format string - format for query logs ("text" or "json") (default text) - --querylog-row-threshold uint - Number of rows a query has to return or affect before being logged; not useful for streaming queries. 0 means all queries will be logged. - --queryserver-config-acl-exempt-acl string - an acl that exempt from table acl checking (this acl is free to access any vitess tables). - --queryserver-config-allowunsafe-dmls - deprecated - --queryserver-config-annotate-queries - prefix queries to MySQL backend with comment indicating vtgate principal (user) and target tablet type - --queryserver-config-enable-table-acl-dry-run - If this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check results - --queryserver-config-idle-timeout float - query server idle timeout (in seconds), vttablet manages various mysql connection pools. This config means if a connection has not been used in given idle timeout, this connection will be removed from pool. This effectively manages number of connection objects and optimize the pool performance. (default 1800) - --queryserver-config-max-dml-rows int - query server max dml rows per statement, maximum number of rows allowed to return at a time for an update or delete with either 1) an equality where clauses on primary keys, or 2) a subselect statement. For update and delete statements in above two categories, vttablet will split the original query into multiple small queries based on this configuration value. - --queryserver-config-max-result-size int - query server max result size, maximum number of rows allowed to return from vttablet for non-streaming queries. (default 10000) - --queryserver-config-message-conn-pool-prefill-parallelism int - DEPRECATED: Unused. - --queryserver-config-message-conn-pool-size int - DEPRECATED - --queryserver-config-message-postpone-cap int - query server message postpone cap is the maximum number of messages that can be postponed at any given time. Set this number to substantially lower than transaction cap, so that the transaction pool isn't exhausted by the message subsystem. (default 4) - --queryserver-config-passthrough-dmls - query server pass through all dml statements without rewriting - --queryserver-config-pool-prefill-parallelism int - query server read pool prefill parallelism, a non-zero value will prefill the pool using the specified parallism. - --queryserver-config-pool-size int - query server read pool size, connection pool is used by regular queries (non streaming, not in a transaction) (default 16) - --queryserver-config-query-cache-lfu - query server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true) - --queryserver-config-query-cache-memory int - query server query cache size in bytes, maximum amount of memory to be used for caching. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432) - --queryserver-config-query-cache-size int - query server query cache size, maximum number of queries to be cached. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 5000) - --queryserver-config-query-pool-timeout float - query server query pool timeout (in seconds), it is how long vttablet waits for a connection from the query pool. If set to 0 (default) then the overall query timeout is used instead. - --queryserver-config-query-pool-waiter-cap int - query server query pool waiter limit, this is the maximum number of queries that can be queued waiting to get a connection (default 5000) - --queryserver-config-query-timeout float - query server query timeout (in seconds), this is the query timeout in vttablet side. If a query takes more than this timeout, it will be killed. (default 30) - --queryserver-config-schema-change-signal - query server schema signal, will signal connected vtgates that schema has changed whenever this is detected. VTGates will need to have -schema_change_signal enabled for this to work (default true) - --queryserver-config-schema-change-signal-interval float - query server schema change signal interval defines at which interval the query server shall send schema updates to vtgate. (default 5) - --queryserver-config-schema-reload-time float - query server schema reload time, how often vttablet reloads schemas from underlying MySQL instance in seconds. vttablet keeps table schemas in its own memory and periodically refreshes it from MySQL. This config controls the reload time. (default 1800) - --queryserver-config-stream-buffer-size int - query server stream buffer size, the maximum number of bytes sent from vttablet for each stream call. It's recommended to keep this value in sync with vtgate's stream_buffer_size. (default 32768) - --queryserver-config-stream-pool-prefill-parallelism int - query server stream pool prefill parallelism, a non-zero value will prefill the pool using the specified parallelism - --queryserver-config-stream-pool-size int - query server stream connection pool size, stream pool is used by stream queries: queries that return results to client in a streaming fashion (default 200) - --queryserver-config-stream-pool-timeout float - query server stream pool timeout (in seconds), it is how long vttablet waits for a connection from the stream pool. If set to 0 (default) then there is no timeout. - --queryserver-config-stream-pool-waiter-cap int - query server stream pool waiter limit, this is the maximum number of streaming queries that can be queued waiting to get a connection - --queryserver-config-strict-table-acl - only allow queries that pass table acl checks - --queryserver-config-terse-errors - prevent bind vars from escaping in client error messages - --queryserver-config-transaction-cap int - query server transaction cap is the maximum number of transactions allowed to happen at any given point of a time for a single vttablet. E.g. by setting transaction cap to 100, there are at most 100 transactions will be processed by a vttablet and the 101th transaction will be blocked (and fail if it cannot get connection within specified timeout) (default 20) - --queryserver-config-transaction-prefill-parallelism int - query server transaction prefill parallelism, a non-zero value will prefill the pool using the specified parallism. - --queryserver-config-transaction-timeout float - query server transaction timeout (in seconds), a transaction will be killed if it takes longer than this value (default 30) - --queryserver-config-txpool-timeout float - query server transaction pool timeout, it is how long vttablet waits if tx pool is full (default 1) - --queryserver-config-txpool-waiter-cap int - query server transaction pool waiter limit, this is the maximum number of transactions that can be queued waiting to get a connection (default 5000) - --queryserver-config-warn-result-size int - query server result size warning threshold, warn if number of rows returned from vttablet for non-streaming queries exceeds this - --queryserver_enable_online_ddl - Enable online DDL. (default true) - --redact-debug-ui-queries - redact full queries and bind variables from debug UI - --relay_log_max_items int - Maximum number of rows for VReplication target buffering. (default 5000) - --relay_log_max_size int - Maximum buffer size (in bytes) for VReplication target buffering. If single rows are larger than this, a single row is buffered at a time. (default 250000) - --remote_operation_timeout duration - time to wait for a remote operation (default 30s) - --replication_connect_retry duration - how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) - --restore_concurrency int - (init restore parameter) how many concurrent files to restore at once (default 4) - --restore_from_backup - (init restore parameter) will check BackupStorage for a recent backup at startup and start there - --restore_from_backup_ts string - (init restore parameter) if set, restore the latest backup taken at or before this timestamp. Example: '2021-04-29.133050' - --retain_online_ddl_tables duration - How long should vttablet keep an old migrated table before purging it (default 24h0m0s) - --s3_backup_aws_endpoint string - endpoint of the S3 backend (region must be provided) - --s3_backup_aws_region string - AWS region to use (default us-east-1) - --s3_backup_aws_retries int - AWS request retries (default -1) - --s3_backup_force_path_style - force the s3 path style - --s3_backup_log_level string - determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors (default LogOff) - --s3_backup_server_side_encryption string - server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file) - --s3_backup_storage_bucket string - S3 bucket to use for backups - --s3_backup_storage_root string - root prefix for all backup-related object names - --s3_backup_tls_skip_verify_cert - skip the 'certificate is valid' check for SSL connections - --sanitize_log_messages - Remove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters. - --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) - --service_map value - comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice - --serving_state_grace_period duration - how long to pause after broadcasting health to vtgate, before enforcing a new serving state - --shard_sync_retry_delay duration - delay between retries of updates to keep the tablet and its shard record in sync (default 30s) - --shutdown_grace_period float - how long to wait (in seconds) for queries and transactions to complete during graceful shutdown. - --sql-max-length-errors int - truncate queries in error logs to the given length (default unlimited) - --sql-max-length-ui int - truncate queries in debug UIs to the given length (default 512) (default 512) - --srv_topo_cache_refresh duration - how frequently to refresh the topology for cached entries (default 1s) - --srv_topo_cache_ttl duration - how long to use cached entries for topology (default 1s) - --srv_topo_timeout duration - topo server timeout (default 5s) - --stats_backend string - The name of the registered push-based monitoring/stats backend to use - --stats_combine_dimensions string - List of dimensions to be combined into a single "all" value in exported stats vars - --stats_common_tags string - Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 - --stats_drop_variables string - Variables to be dropped from the list of exported variables. - --stats_emit_period duration - Interval between emitting stats to all registered backends (default 1m0s) - --statsd_address string - Address for statsd client - --statsd_sample_rate float - (default 1) - --stderrthreshold value - logs at or above this threshold go to stderr (default 1) - --stream_health_buffer_size uint - max streaming health entries to buffer per streaming health client (default 20) - --structured-logging - whether to use structured logging (Zap) or the original (glog) logger - --table-acl-config string - path to table access checker config file; send SIGHUP to reload this file - --table-acl-config-reload-interval duration - Ticker to reload ACLs. Duration flag, format e.g.: 30s. Default: do not reload - --table_gc_lifecycle string - States for a DROP TABLE garbage collection cycle. Default is 'hold,purge,evac,drop', use any subset ('drop' implcitly always included) (default hold,purge,evac,drop) - --tablet-path string - tablet alias - --tablet_config string - YAML file config for tablet - --tablet_dir string - The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. - --tablet_filters value - Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch - --tablet_grpc_ca string - the server ca to use to validate servers when connecting - --tablet_grpc_cert string - the cert to use to connect - --tablet_grpc_crl string - the server crl to use to validate server certificates when connecting - --tablet_grpc_key string - the key to use to connect - --tablet_grpc_server_name string - the server name to use to validate server certificate - --tablet_hostname string - if not empty, this hostname will be assumed instead of trying to resolve it - --tablet_manager_grpc_ca string - the server ca to use to validate servers when connecting - --tablet_manager_grpc_cert string - the cert to use to connect - --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) - --tablet_manager_grpc_connpool_size int - number of tablets to keep tmclient connections open to (default 100) - --tablet_manager_grpc_crl string - the server crl to use to validate server certificates when connecting - --tablet_manager_grpc_key string - the key to use to connect - --tablet_manager_grpc_server_name string - the server name to use to validate server certificate - --tablet_manager_protocol string - the protocol to use to talk to vttablet (default grpc) - --tablet_protocol string - how to talk to the vttablets (default grpc) - --tablet_refresh_interval duration - tablet refresh interval (default 1m0s) - --tablet_refresh_known_tablets - tablet refresh reloads the tablet address/port map from topo in case it changes (default true) - --tablet_url_template string - format string describing debug tablet url formatting. See the Go code for getTabletDebugURL() how to customize this. (default http://{{.GetTabletHostPort}}) - --throttle_check_as_check_self - Should throttler/check return a throttler/check-self result (changes throttler behavior for writes) - --throttle_metrics_query SELECT - Override default heartbeat/lag metric. Use either SELECT (must return single row, single value) or `SHOW GLOBAL ... LIKE ...` queries. Set -throttle_metrics_threshold respectively. - --throttle_metrics_threshold float - Override default throttle threshold, respective to -throttle_metrics_query (default 1.7976931348623157e+308) - --throttle_tablet_types string - Comma separated VTTablet types to be considered by the throttler. default: 'replica'. example: 'replica,rdonly'. 'replica' aways implicitly included (default replica) - --throttle_threshold duration - Replication lag threshold for default lag throttling (default 1s) - --topo_consul_idle_conn_timeout duration - Maximum amount of time to pool idle connections. (default 1m30s) - --topo_consul_lock_delay duration - LockDelay for consul session. (default 15s) - --topo_consul_lock_session_checks string - List of checks for consul session. (default serfHealth) - --topo_consul_lock_session_ttl string - TTL for consul session. - --topo_consul_max_conns_per_host int - Maximum number of consul connections per host. - --topo_consul_max_idle_conns int - Maximum number of idle consul connections. (default 100) - --topo_consul_watch_poll_duration duration - time of the long poll for watch queries. (default 30s) - --topo_etcd_lease_ttl int - Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) - --topo_etcd_tls_ca string - path to the ca to use to validate the server cert when connecting to the etcd topo server - --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 - --topo_etcd_tls_key string - path to the client key to use to connect to the etcd topo server, enables TLS - --topo_global_root string - the path of the global topology data in the global topology server - --topo_global_server_address string - the address of the global topology server - --topo_implementation string - the topology implementation to use - --topo_k8s_context string - The kubeconfig context to use, overrides the 'current-context' from the config - --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 - --topo_k8s_namespace string - The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config - --topo_read_concurrency int - concurrent topo reads (default 32) - --topo_zk_auth_file string - auth to use when connecting to the zk topo server, file contents should be :, e.g., digest:user:pass - --topo_zk_base_timeout duration - zk base timeout (see zk.Connect) (default 30s) - --topo_zk_max_concurrency int - maximum number of pending requests to send to a Zookeeper server. (default 64) - --topo_zk_tls_ca string - the server ca to use to validate servers when connecting to the zk topo server - --topo_zk_tls_cert string - the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS - --topo_zk_tls_key string - the key to use to connect to the zk topo server, enables TLS - --topocustomrule_cell string - topo cell for customrules file. (default global) - --topocustomrule_path string - path for customrules file. Disabled if empty. - --tracer string - tracing service to use (default noop) - --tracing-enable-logging - whether to enable logging in the tracing service - --tracing-sampling-rate value - sampling rate for the probabilistic jaeger sampler (default 0.1) - --tracing-sampling-type value - sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) - --track_schema_versions - When enabled, vttablet will store versions of schemas at each position that a DDL is applied and allow retrieval of the schema corresponding to a position - --transaction-log-stream-handler string - URL handler for streaming transactions log (default /debug/txlog) - --transaction_limit_by_component - Include CallerID.component when considering who the user is for the purpose of transaction limit. - --transaction_limit_by_principal - Include CallerID.principal when considering who the user is for the purpose of transaction limit. (default true) - --transaction_limit_by_subcomponent - Include CallerID.subcomponent when considering who the user is for the purpose of transaction limit. - --transaction_limit_by_username - Include VTGateCallerID.username when considering who the user is for the purpose of transaction limit. (default true) - --transaction_limit_per_user float - Maximum number of transactions a single user is allowed to use at any time, represented as fraction of -transaction_cap. (default 0.4) - --transaction_shutdown_grace_period float - DEPRECATED: use shutdown_grace_period instead. - --twopc_abandon_age float - time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved. - --twopc_coordinator_address string - address of the (VTGate) process(es) that will be used to notify of abandoned transactions. - --twopc_enable - if the flag is on, 2pc is enabled. Other 2pc flags must be supplied. - --tx-throttler-config string - Synonym to -tx_throttler_config (default target_replication_lag_sec: 2 -max_replication_lag_sec: 10 -initial_rate: 100 -max_increase: 1 -emergency_decrease: 0.5 -min_duration_between_increases_sec: 40 -max_duration_between_increases_sec: 62 -min_duration_between_decreases_sec: 20 -spread_backlog_across_sec: 20 -age_bad_rate_after_sec: 180 -bad_rate_increase: 0.1 -max_rate_approach_threshold: 0.9 -) - --tx-throttler-default-priority int - Default priority assigned to queries that lack priority information. - --tx-throttler-dry-run - If present, the transaction throttler only records metrics about requests received and throttled, but does not actually throttle any requests. - --tx-throttler-healthcheck-cells value - Synonym to -tx_throttler_healthcheck_cells - --tx-throttler-tablet-types value - A comma-separated list of tablet types. Only tablets of this type are monitored for replication lag by the transaction throttler. Supported types are replica and/or rdonly. (default replica) - --tx_throttler_config string - The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default target_replication_lag_sec: 2 -max_replication_lag_sec: 10 -initial_rate: 100 -max_increase: 1 -emergency_decrease: 0.5 -min_duration_between_increases_sec: 40 -max_duration_between_increases_sec: 62 -min_duration_between_decreases_sec: 20 -spread_backlog_across_sec: 20 -age_bad_rate_after_sec: 180 -bad_rate_increase: 0.1 -max_rate_approach_threshold: 0.9 -) - --tx_throttler_healthcheck_cells value - A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler. - --unhealthy_threshold duration - replication lag after which a replica is considered unhealthy (default 2h0m0s) - --use_super_read_only - Set super_read_only flag when performing planned failover. - --v value - log level for V logs - --version - print binary version - --vmodule value - comma-separated list of pattern=N settings for file-filtered logging - --vreplication_copy_phase_duration duration - Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s) - --vreplication_copy_phase_max_innodb_history_list_length int - The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000) - --vreplication_copy_phase_max_mysql_replication_lag int - The maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 43200) - --vreplication_experimental_flags int - (Bitmask) of experimental features in vreplication to enable (default 1) - --vreplication_healthcheck_retry_delay duration - healthcheck retry delay (default 5s) - --vreplication_healthcheck_timeout duration - healthcheck retry delay (default 1m0s) - --vreplication_healthcheck_topology_refresh duration - refresh interval for re-reading the topology (default 30s) - --vreplication_heartbeat_update_interval int - Frequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1) - --vreplication_max_time_to_retry_on_error duration - stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence (default 15m0s) - --vreplication_replica_lag_tolerance duration - Replica lag threshold duration: once lag is below this we switch from copy phase to the replication (streaming) phase (default 1m0s) - --vreplication_retry_delay duration - delay before retrying a failed workflow event in the replication phase (default 5s) - --vreplication_store_compressed_gtid - Store compressed gtids in the pos column of _vt.vreplication - --vreplication_tablet_type string - comma separated list of tablet types used as a source (default in_order:REPLICA,PRIMARY) - --vstream_dynamic_packet_size - Enable dynamic packet sizing for VReplication. This will adjust the packet size during replication to improve performance. (default true) - --vstream_packet_size int - Suggested packet size for VReplication streamer. This is used only as a recommendation. The actual packet size may be more or less than this amount. (default 250000) - --vtctld_addr string - address of a vtctld instance - --vtgate_protocol string - how to talk to vtgate (default grpc) - --vttablet_skip_buildinfo_tags string - comma-separated list of buildinfo tags to skip from merging with -init_tags. each tag is either an exact match or a regular expression of the form '/regexp/'. (default /.*/) - --wait_for_backup_interval duration - (init restore parameter) if this is greater than 0, instead of starting up empty when no backups are found, keep checking at this interval for a backup to appear - --watch_replication_stream - When enabled, vttablet will stream the MySQL replication stream from the local server, and use it to update schema when it sees a DDL. - --xbstream_restore_flags string - flags to pass to xbstream command during restore. These should be space separated and will be added to the end of the command. These need to match the ones used for backup e.g. --compress / --decompress, --encrypt / --decrypt - --xtrabackup_backup_flags string - flags to pass to backup command. These should be space separated and will be added to the end of the command - --xtrabackup_prepare_flags string - flags to pass to prepare command. These should be space separated and will be added to the end of the command - --xtrabackup_root_path string - directory location of the xtrabackup and xbstream executables, e.g., /usr/bin - --xtrabackup_stream_mode string - which mode to use if streaming, valid values are tar and xbstream (default tar) - --xtrabackup_stripe_block_size uint - Size in bytes of each block that gets sent to a given stripe before rotating to the next stripe (default 102400) - --xtrabackup_stripes uint - If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression - --xtrabackup_user string - User that xtrabackup will use to connect to the database server. This user must have all necessary privileges. For details, please refer to xtrabackup documentation. + --allowed_tablet_types TabletTypeList Specifies the tablet types this vtgate is allowed to route queries to + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --azblob_backup_account_key_file string Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) + --azblob_backup_account_name string Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used + --azblob_backup_container_name string Azure Blob Container Name + --azblob_backup_parallelism int Azure Blob operation parallelism (requires extra memory when increased) (default 1) + --azblob_backup_storage_root string Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/') + --backup_engine_implementation string Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default "builtin") + --backup_storage_block_size int if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000) + --backup_storage_compress if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true) + --backup_storage_hook string if set, we send the contents of the backup files through this hook. + --backup_storage_implementation string which implementation to use for the backup storage feature + --backup_storage_number_blocks int if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2) + --binlog_host string PITR restore parameter: hostname/IP of binlog server. + --binlog_password string PITR restore parameter: password of binlog server. + --binlog_player_grpc_ca string the server ca to use to validate servers when connecting + --binlog_player_grpc_cert string the cert to use to connect + --binlog_player_grpc_crl string the server crl to use to validate server certificates when connecting + --binlog_player_grpc_key string the key to use to connect + --binlog_player_grpc_server_name string the server name to use to validate server certificate + --binlog_player_protocol string the protocol to download binlogs from a vttablet (default "grpc") + --binlog_port int PITR restore parameter: port of binlog server. + --binlog_ssl_ca string PITR restore parameter: Filename containing TLS CA certificate to verify binlog server TLS certificate against. + --binlog_ssl_cert string PITR restore parameter: Filename containing mTLS client certificate to present to binlog server as authentication. + --binlog_ssl_key string PITR restore parameter: Filename containing mTLS client private key for use in binlog server authentication. + --binlog_ssl_server_name string PITR restore parameter: TLS server name (common name) to verify against for the binlog server we are connecting to (If not set: use the hostname or IP supplied in -binlog_host). + --binlog_user string PITR restore parameter: username of binlog server. + --builtin-compressor string builtin compressor engine to use (default "pgzip") + --builtin-decompressor string builtin decompressor engine to use (default "auto") + --builtinbackup_mysqld_timeout duration how long to wait for mysqld to shutdown at the start of the backup (default 10m0s) + --builtinbackup_progress duration how often to send progress updates when backing up large files (default 5s) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --ceph_backup_storage_config string Path to JSON config file for ceph backup storage (default "ceph_backup_config.json") + --client-found-rows-pool-size int DEPRECATED: queryserver-config-transaction-cap will be used instead. + --compression-level int what level to pass to the compressor (default 1) + --consul_auth_static_file string JSON File to read the topos/tokens from. + --cpu_profile string deprecated: use '-pprof=cpu' instead + --datadog-agent-host string host to send spans to. if empty, no tracing will be done + --datadog-agent-port string port to send spans to. if empty, no tracing will be done + --db-config-allprivs-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-allprivs-flags uint deprecated: use db_flags + --db-config-allprivs-flavor string deprecated: use db_flavor + --db-config-allprivs-host string deprecated: use db_host + --db-config-allprivs-pass string db allprivs deprecated: use db_allprivs_password + --db-config-allprivs-port int deprecated: use db_port + --db-config-allprivs-server_name string deprecated: use db_server_name + --db-config-allprivs-ssl-ca string deprecated: use db_ssl_ca + --db-config-allprivs-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-allprivs-ssl-cert string deprecated: use db_ssl_cert + --db-config-allprivs-ssl-key string deprecated: use db_ssl_key + --db-config-allprivs-uname string deprecated: use db_allprivs_user (default "vt_allprivs") + --db-config-allprivs-unixsocket string deprecated: use db_socket + --db-config-app-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-app-flags uint deprecated: use db_flags + --db-config-app-flavor string deprecated: use db_flavor + --db-config-app-host string deprecated: use db_host + --db-config-app-pass string db app deprecated: use db_app_password + --db-config-app-port int deprecated: use db_port + --db-config-app-server_name string deprecated: use db_server_name + --db-config-app-ssl-ca string deprecated: use db_ssl_ca + --db-config-app-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-app-ssl-cert string deprecated: use db_ssl_cert + --db-config-app-ssl-key string deprecated: use db_ssl_key + --db-config-app-uname string deprecated: use db_app_user (default "vt_app") + --db-config-app-unixsocket string deprecated: use db_socket + --db-config-appdebug-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-appdebug-flags uint deprecated: use db_flags + --db-config-appdebug-flavor string deprecated: use db_flavor + --db-config-appdebug-host string deprecated: use db_host + --db-config-appdebug-pass string db appdebug deprecated: use db_appdebug_password + --db-config-appdebug-port int deprecated: use db_port + --db-config-appdebug-server_name string deprecated: use db_server_name + --db-config-appdebug-ssl-ca string deprecated: use db_ssl_ca + --db-config-appdebug-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-appdebug-ssl-cert string deprecated: use db_ssl_cert + --db-config-appdebug-ssl-key string deprecated: use db_ssl_key + --db-config-appdebug-uname string deprecated: use db_appdebug_user (default "vt_appdebug") + --db-config-appdebug-unixsocket string deprecated: use db_socket + --db-config-dba-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-dba-flags uint deprecated: use db_flags + --db-config-dba-flavor string deprecated: use db_flavor + --db-config-dba-host string deprecated: use db_host + --db-config-dba-pass string db dba deprecated: use db_dba_password + --db-config-dba-port int deprecated: use db_port + --db-config-dba-server_name string deprecated: use db_server_name + --db-config-dba-ssl-ca string deprecated: use db_ssl_ca + --db-config-dba-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-dba-ssl-cert string deprecated: use db_ssl_cert + --db-config-dba-ssl-key string deprecated: use db_ssl_key + --db-config-dba-uname string deprecated: use db_dba_user (default "vt_dba") + --db-config-dba-unixsocket string deprecated: use db_socket + --db-config-erepl-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-erepl-dbname string deprecated: dbname does not need to be explicitly configured + --db-config-erepl-flags uint deprecated: use db_flags + --db-config-erepl-flavor string deprecated: use db_flavor + --db-config-erepl-host string deprecated: use db_host + --db-config-erepl-pass string db erepl deprecated: use db_erepl_password + --db-config-erepl-port int deprecated: use db_port + --db-config-erepl-server_name string deprecated: use db_server_name + --db-config-erepl-ssl-ca string deprecated: use db_ssl_ca + --db-config-erepl-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-erepl-ssl-cert string deprecated: use db_ssl_cert + --db-config-erepl-ssl-key string deprecated: use db_ssl_key + --db-config-erepl-uname string deprecated: use db_erepl_user (default "vt_erepl") + --db-config-erepl-unixsocket string deprecated: use db_socket + --db-config-filtered-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-filtered-flags uint deprecated: use db_flags + --db-config-filtered-flavor string deprecated: use db_flavor + --db-config-filtered-host string deprecated: use db_host + --db-config-filtered-pass string db filtered deprecated: use db_filtered_password + --db-config-filtered-port int deprecated: use db_port + --db-config-filtered-server_name string deprecated: use db_server_name + --db-config-filtered-ssl-ca string deprecated: use db_ssl_ca + --db-config-filtered-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-filtered-ssl-cert string deprecated: use db_ssl_cert + --db-config-filtered-ssl-key string deprecated: use db_ssl_key + --db-config-filtered-uname string deprecated: use db_filtered_user (default "vt_filtered") + --db-config-filtered-unixsocket string deprecated: use db_socket + --db-config-repl-charset string deprecated: use db_charset (default "utf8mb4") + --db-config-repl-flags uint deprecated: use db_flags + --db-config-repl-flavor string deprecated: use db_flavor + --db-config-repl-host string deprecated: use db_host + --db-config-repl-pass string db repl deprecated: use db_repl_password + --db-config-repl-port int deprecated: use db_port + --db-config-repl-server_name string deprecated: use db_server_name + --db-config-repl-ssl-ca string deprecated: use db_ssl_ca + --db-config-repl-ssl-ca-path string deprecated: use db_ssl_ca_path + --db-config-repl-ssl-cert string deprecated: use db_ssl_cert + --db-config-repl-ssl-key string deprecated: use db_ssl_key + --db-config-repl-uname string deprecated: use db_repl_user (default "vt_repl") + --db-config-repl-unixsocket string deprecated: use db_socket + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_allprivs_password string db allprivs password + --db_allprivs_use_ssl Set this flag to false to make the allprivs connection to not use ssl (default true) + --db_allprivs_user string db allprivs user userKey (default "vt_allprivs") + --db_app_password string db app password + --db_app_use_ssl Set this flag to false to make the app connection to not use ssl (default true) + --db_app_user string db app user userKey (default "vt_app") + --db_appdebug_password string db appdebug password + --db_appdebug_use_ssl Set this flag to false to make the appdebug connection to not use ssl (default true) + --db_appdebug_user string db appdebug user userKey (default "vt_appdebug") + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_erepl_password string db erepl password + --db_erepl_use_ssl Set this flag to false to make the erepl connection to not use ssl (default true) + --db_erepl_user string db erepl user userKey (default "vt_erepl") + --db_filtered_password string db filtered password + --db_filtered_use_ssl Set this flag to false to make the filtered connection to not use ssl (default true) + --db_filtered_user string db filtered user userKey (default "vt_filtered") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_repl_password string db repl password + --db_repl_use_ssl Set this flag to false to make the repl connection to not use ssl (default true) + --db_repl_user string db repl user userKey (default "vt_repl") + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --degraded_threshold duration replication lag after which a replica is considered degraded (default 30s) + --disable_active_reparents if set, do not allow active reparents. Use this to protect a cluster using external reparents. + --discovery_high_replication_lag_minimum_serving duration the replication lag that is considered too high when applying the min_number_serving_vttablets threshold (default 2h0m0s) + --discovery_low_replication_lag duration the replication lag that is considered low enough to be healthy (default 30s) + --emit_stats If set, emit stats to push-based monitoring and stats backends + --enable-autocommit This flag is deprecated. Autocommit is always allowed. (default true) + --enable-consolidator Synonym to -enable_consolidator (default true) + --enable-consolidator-replicas Synonym to -enable_consolidator_replicas + --enable-lag-throttler Synonym to -enable_lag_throttler + --enable-per-workload-table-metrics If true, query counts and query error metrics include a label that identifies the workload + --enable-query-plan-field-caching Synonym to -enable_query_plan_field_caching (default true) + --enable-tx-throttler Synonym to -enable_tx_throttler + --enable_consolidator This option enables the query consolidator. (default true) + --enable_consolidator_replicas This option enables the query consolidator only on replicas. + --enable_hot_row_protection If true, incoming transactions for the same row (range) will be queued and cannot consume all txpool slots. + --enable_hot_row_protection_dry_run If true, hot row protection is not enforced but logs if transactions would have been queued. + --enable_lag_throttler If true, vttablet will run a throttler service, and will implicitly enable heartbeats + --enable_query_plan_field_caching This option fetches & caches fields (columns) when storing query plans (default true) + --enable_replication_reporter Use polling to track replication lag. + --enable_semi_sync Enable semi-sync when configuring replication, on primary and replica tablets only (rdonly tablets will not ack). + --enable_transaction_limit If true, limit on number of transactions open at the same time will be enforced for all users. User trying to open a new transaction after exhausting their limit will receive an error immediately, regardless of whether there are available slots or not. + --enable_transaction_limit_dry_run If true, limit on number of transactions open at the same time will be tracked for all users, but not enforced. + --enable_tx_throttler If true replication-lag-based throttling on transactions will be enabled. + --enforce-tableacl-config if this flag is true, vttablet will fail to start if a valid tableacl config does not exist + --enforce_strict_trans_tables If true, vttablet requires MySQL to run with STRICT_TRANS_TABLES or STRICT_ALL_TABLES on. It is recommended to not turn this flag off. Otherwise MySQL may alter your supplied values before saving them to the database. (default true) + --external-compressor string command with arguments to use when compressing a backup + --external-compressor-extension string extension to use when using an external compressor + --external-decompressor string command with arguments to use when decompressing a backup + --file_backup_storage_root string root directory for the file backup storage + --filecustomrules string file based custom rule path + --filecustomrules_watch set up a watch on the target file and reload query rules when it changes + --gc_check_interval duration Interval between garbage collection checks (default 1h0m0s) + --gc_purge_check_interval duration Interval between purge discovery checks (default 1m0s) + --gcs_backup_storage_bucket string Google Cloud Storage bucket to use for backups + --gcs_backup_storage_root string root prefix for all backup-related object names + --gh-ost-path string override default gh-ost binary full path + --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_client_creds string when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server + --grpc_auth_static_password_file string JSON File to read the users/passwords from. + --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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy + --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_enable_tracing Enable GRPC tracing + --grpc_initial_conn_window_size int gRPC initial connection window size + --grpc_initial_window_size int gRPC initial window size + --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) + --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) + --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_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) + --grpc_port int Port to listen on for gRPC calls + --grpc_prometheus Enable gRPC monitoring with Prometheus + --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) + --health_check_interval duration Interval between health checks (default 20s) + --heartbeat_enable If true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the table _vt.heartbeat. The result is used to inform the serving state of the vttablet via healthchecks. + --heartbeat_interval duration How frequently to read and write replication heartbeat. (default 1s) + --heartbeat_on_demand_duration duration If non-zero, heartbeats are only written upon consumer request, and only run for up to given duration following the request. Frequent requests can keep the heartbeat running consistently; when requests are infrequent heartbeat may completely stop between requests (default 0s) + -h, --help display usage and exit + --hot_row_protection_concurrent_transactions int Number of concurrent transactions let through to the txpool/MySQL for the same hot row. Should be > 1 to have enough 'ready' transactions in MySQL and benefit from a pipelining effect. (default 5) + --hot_row_protection_max_global_queue_size int Global queue limit across all row (ranges). Useful to prevent that the queue can grow unbounded. (default 1000) + --hot_row_protection_max_queue_size int Maximum number of BeginExecute RPCs which will be queued for the same row (range). (default 20) + --init_db_name_override string (init parameter) override the name of the db used by vttablet. Without this flag, the db name defaults to vt_ + --init_keyspace string (init parameter) keyspace to use for this tablet + --init_populate_metadata (init parameter) populate metadata tables even if restore_from_backup is disabled. If restore_from_backup is enabled, metadata tables are always populated regardless of this flag. + --init_shard string (init parameter) shard to use for this tablet + --init_tablet_type string (init parameter) the tablet type to use for this tablet. + --init_tags StringMap (init parameter) comma separated list of key:value pairs used to tag the tablet + --init_timeout duration (init parameter) timeout to use for the init phase. (default 1m0s) + --jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done + --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) (default 0s) + --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) (default 0s) + --keyspaces_to_watch StringList Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --legacy_replication_lag_algorithm use the legacy algorithm when selecting the vttablets for serving (default true) + --lock_tables_timeout duration How long to keep the table locked before timing out (default 1m0s) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --log_err_stacks log stack traces for errors + --log_queries Enable query logging to syslog. + --log_queries_to_file string Enable query logging to the specified file + --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) + --logtostderr log to standard error instead of files + --master_connect_retry duration Deprecated, use -replication_connect_retry (default 10s) + --mem-profile-rate int deprecated: use '-pprof=mem' instead (default 524288) + --migration_check_interval duration Interval between migration checks (default 1m0s) + --min_number_serving_vttablets int the minimum number of vttablets for each replicating tablet_type (e.g. replica, rdonly) that will be continue to be used even with replication lag above discovery_low_replication_lag, but still below discovery_high_replication_lag_minimum_serving (default 2) + --mutex-profile-fraction int deprecated: use '-pprof=mutex' instead + --mycnf-file string path to my.cnf, if reading all config params from there + --mycnf_bin_log_path string mysql binlog path + --mycnf_data_dir string data directory for mysql + --mycnf_error_log_path string mysql error log path + --mycnf_general_log_path string mysql general log path + --mycnf_innodb_data_home_dir string Innodb data home directory + --mycnf_innodb_log_group_home_dir string Innodb log group home directory + --mycnf_master_info_file string mysql master.info file + --mycnf_mysql_port int port mysql is listening on + --mycnf_pid_file string mysql pid file + --mycnf_relay_log_index_path string mysql relay log index path + --mycnf_relay_log_info_path string mysql relay log info path + --mycnf_relay_log_path string mysql relay log path + --mycnf_secure_file_priv string mysql path for loading secure files + --mycnf_server_id int mysql server id of the server (if specified, mycnf-file will be ignored) + --mycnf_slow_log_path string mysql slow query log path + --mycnf_socket_file string mysql socket file + --mycnf_tmp_dir string mysql tmp directory + --mysql_auth_server_static_file string JSON File to read the users/passwords from. + --mysql_auth_server_static_string string JSON representation of the users/passwords config. + --mysql_auth_static_reload_interval duration Ticker to reload credentials (default 0s) + --mysql_clientcert_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default "mysql_clear_password") + --mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms) + --mysql_server_version string MySQL server version to advertise. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --mysqlctl_socket string socket file to use for remote mysqlctl actions (empty for local actions) + --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) + --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) + --opentsdb_uri string URI of opentsdb /api/put method + --orc_api_password string (Optional) Basic auth password to authenticate with Orchestrator's HTTP API. + --orc_api_url string Address of Orchestrator's HTTP API (e.g. http://host:port/api/). Leave empty to disable Orchestrator integration. + --orc_api_user string (Optional) Basic auth username to authenticate with Orchestrator's HTTP API. Leave empty to disable basic auth. + --orc_discover_interval duration How often to ping Orchestrator's HTTP API endpoint to tell it we exist. 0 means never. (default 0s) + --orc_timeout duration Timeout for calls to Orchestrator's HTTP API (default 30s) + --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. + --pitr_gtid_lookup_timeout duration PITR restore parameter: timeout for fetching gtid from timestamp. (default 1m0s) + --pool-name-prefix string Deprecated + --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) (default 0s) + --port int port for the server + --pprof string enable profiling + --pt-osc-path string override default pt-online-schema-change binary full path + --publish_retry_interval duration how long vttablet waits to retry publishing the tablet record (default 30s) + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --query-log-stream-handler string URL handler for streaming queries log (default "/debug/querylog") + --querylog-filter-tag string string that must be present in the query for it to be logged; if using a value as the tag, you need to disable query normalization + --querylog-format string format for query logs ("text" or "json") (default "text") + --querylog-row-threshold uint Number of rows a query has to return or affect before being logged; not useful for streaming queries. 0 means all queries will be logged. + --queryserver-config-acl-exempt-acl string an acl that exempt from table acl checking (this acl is free to access any vitess tables). + --queryserver-config-allowunsafe-dmls deprecated + --queryserver-config-annotate-queries prefix queries to MySQL backend with comment indicating vtgate principal (user) and target tablet type + --queryserver-config-enable-table-acl-dry-run If this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check results + --queryserver-config-idle-timeout float query server idle timeout (in seconds), vttablet manages various mysql connection pools. This config means if a connection has not been used in given idle timeout, this connection will be removed from pool. This effectively manages number of connection objects and optimize the pool performance. (default 1800) + --queryserver-config-max-dml-rows int query server max dml rows per statement, maximum number of rows allowed to return at a time for an update or delete with either 1) an equality where clauses on primary keys, or 2) a subselect statement. For update and delete statements in above two categories, vttablet will split the original query into multiple small queries based on this configuration value. + --queryserver-config-max-result-size int query server max result size, maximum number of rows allowed to return from vttablet for non-streaming queries. (default 10000) + --queryserver-config-message-conn-pool-prefill-parallelism int DEPRECATED: Unused. + --queryserver-config-message-conn-pool-size int DEPRECATED + --queryserver-config-message-postpone-cap int query server message postpone cap is the maximum number of messages that can be postponed at any given time. Set this number to substantially lower than transaction cap, so that the transaction pool isn't exhausted by the message subsystem. (default 4) + --queryserver-config-passthrough-dmls query server pass through all dml statements without rewriting + --queryserver-config-pool-prefill-parallelism int query server read pool prefill parallelism, a non-zero value will prefill the pool using the specified parallism. + --queryserver-config-pool-size int query server read pool size, connection pool is used by regular queries (non streaming, not in a transaction) (default 16) + --queryserver-config-query-cache-lfu query server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true) + --queryserver-config-query-cache-memory int query server query cache size in bytes, maximum amount of memory to be used for caching. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432) + --queryserver-config-query-cache-size int query server query cache size, maximum number of queries to be cached. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 5000) + --queryserver-config-query-pool-timeout float query server query pool timeout (in seconds), it is how long vttablet waits for a connection from the query pool. If set to 0 (default) then the overall query timeout is used instead. + --queryserver-config-query-pool-waiter-cap int query server query pool waiter limit, this is the maximum number of queries that can be queued waiting to get a connection (default 5000) + --queryserver-config-query-timeout float query server query timeout (in seconds), this is the query timeout in vttablet side. If a query takes more than this timeout, it will be killed. (default 30) + --queryserver-config-schema-change-signal query server schema signal, will signal connected vtgates that schema has changed whenever this is detected. VTGates will need to have -schema_change_signal enabled for this to work (default true) + --queryserver-config-schema-change-signal-interval float query server schema change signal interval defines at which interval the query server shall send schema updates to vtgate. (default 5) + --queryserver-config-schema-reload-time float query server schema reload time, how often vttablet reloads schemas from underlying MySQL instance in seconds. vttablet keeps table schemas in its own memory and periodically refreshes it from MySQL. This config controls the reload time. (default 1800) + --queryserver-config-stream-buffer-size int query server stream buffer size, the maximum number of bytes sent from vttablet for each stream call. It's recommended to keep this value in sync with vtgate's stream_buffer_size. (default 32768) + --queryserver-config-stream-pool-prefill-parallelism int query server stream pool prefill parallelism, a non-zero value will prefill the pool using the specified parallelism + --queryserver-config-stream-pool-size int query server stream connection pool size, stream pool is used by stream queries: queries that return results to client in a streaming fashion (default 200) + --queryserver-config-stream-pool-timeout float query server stream pool timeout (in seconds), it is how long vttablet waits for a connection from the stream pool. If set to 0 (default) then there is no timeout. + --queryserver-config-stream-pool-waiter-cap int query server stream pool waiter limit, this is the maximum number of streaming queries that can be queued waiting to get a connection + --queryserver-config-strict-table-acl only allow queries that pass table acl checks + --queryserver-config-terse-errors prevent bind vars from escaping in client error messages + --queryserver-config-transaction-cap int query server transaction cap is the maximum number of transactions allowed to happen at any given point of a time for a single vttablet. E.g. by setting transaction cap to 100, there are at most 100 transactions will be processed by a vttablet and the 101th transaction will be blocked (and fail if it cannot get connection within specified timeout) (default 20) + --queryserver-config-transaction-prefill-parallelism int query server transaction prefill parallelism, a non-zero value will prefill the pool using the specified parallism. + --queryserver-config-transaction-timeout float query server transaction timeout (in seconds), a transaction will be killed if it takes longer than this value (default 30) + --queryserver-config-txpool-timeout float query server transaction pool timeout, it is how long vttablet waits if tx pool is full (default 1) + --queryserver-config-txpool-waiter-cap int query server transaction pool waiter limit, this is the maximum number of transactions that can be queued waiting to get a connection (default 5000) + --queryserver-config-warn-result-size int query server result size warning threshold, warn if number of rows returned from vttablet for non-streaming queries exceeds this + --queryserver_enable_online_ddl Enable online DDL. (default true) + --redact-debug-ui-queries redact full queries and bind variables from debug UI + --relay_log_max_items int Maximum number of rows for VReplication target buffering. (default 5000) + --relay_log_max_size int Maximum buffer size (in bytes) for VReplication target buffering. If single rows are larger than this, a single row is buffered at a time. (default 250000) + --remote_operation_timeout duration time to wait for a remote operation (default 30s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --restore_concurrency int (init restore parameter) how many concurrent files to restore at once (default 4) + --restore_from_backup (init restore parameter) will check BackupStorage for a recent backup at startup and start there + --restore_from_backup_ts string (init restore parameter) if set, restore the latest backup taken at or before this timestamp. Example: '2021-04-29.133050' + --retain_online_ddl_tables duration How long should vttablet keep an old migrated table before purging it (default 24h0m0s) + --s3_backup_aws_endpoint string endpoint of the S3 backend (region must be provided) + --s3_backup_aws_region string AWS region to use (default "us-east-1") + --s3_backup_aws_retries int AWS request retries (default -1) + --s3_backup_force_path_style force the s3 path style + --s3_backup_log_level string determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors (default "LogOff") + --s3_backup_server_side_encryption string server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file) + --s3_backup_storage_bucket string S3 bucket to use for backups + --s3_backup_storage_root string root prefix for all backup-related object names + --s3_backup_tls_skip_verify_cert skip the 'certificate is valid' check for SSL connections + --sanitize_log_messages Remove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters. + --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) + --service_map StringList comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice + --serving_state_grace_period duration how long to pause after broadcasting health to vtgate, before enforcing a new serving state (default 0s) + --shard_sync_retry_delay duration delay between retries of updates to keep the tablet and its shard record in sync (default 30s) + --shutdown_grace_period float how long to wait (in seconds) for queries and transactions to complete during graceful shutdown. + --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) + --sql-max-length-ui int truncate queries in debug UIs to the given length (default 512) (default 512) + --srv_topo_cache_refresh duration how frequently to refresh the topology for cached entries (default 1s) + --srv_topo_cache_ttl duration how long to use cached entries for topology (default 1s) + --srv_topo_timeout duration topo server timeout (default 5s) + --stats_backend string The name of the registered push-based monitoring/stats backend to use + --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars + --stats_common_tags string Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 + --stats_drop_variables string Variables to be dropped from the list of exported variables. + --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) + --statsd_address string Address for statsd client + --statsd_sample_rate float (default 1) + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --stream_health_buffer_size uint max streaming health entries to buffer per streaming health client (default 20) + --structured-logging whether to use structured logging (Zap) or the original (glog) logger + --table-acl-config string path to table access checker config file; send SIGHUP to reload this file + --table-acl-config-reload-interval duration Ticker to reload ACLs. Duration flag, format e.g.: 30s. Default: do not reload (default 0s) + --table_gc_lifecycle string States for a DROP TABLE garbage collection cycle. Default is 'hold,purge,evac,drop', use any subset ('drop' implcitly always included) (default "hold,purge,evac,drop") + --tablet-path string tablet alias + --tablet_config string YAML file config for tablet + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_filters StringList Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch + --tablet_grpc_ca string the server ca to use to validate servers when connecting + --tablet_grpc_cert string the cert to use to connect + --tablet_grpc_crl string the server crl to use to validate server certificates when connecting + --tablet_grpc_key string the key to use to connect + --tablet_grpc_server_name string the server name to use to validate server certificate + --tablet_hostname string if not empty, this hostname will be assumed instead of trying to resolve it + --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting + --tablet_manager_grpc_cert string the cert to use to connect + --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) + --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) + --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting + --tablet_manager_grpc_key string the key to use to connect + --tablet_manager_grpc_server_name string the server name to use to validate server certificate + --tablet_manager_protocol string the protocol to use to talk to vttablet (default "grpc") + --tablet_protocol string how to talk to the vttablets (default "grpc") + --tablet_refresh_interval duration tablet refresh interval (default 1m0s) + --tablet_refresh_known_tablets tablet refresh reloads the tablet address/port map from topo in case it changes (default true) + --tablet_url_template string format string describing debug tablet url formatting. See the Go code for getTabletDebugURL() how to customize this. (default "http://{{.GetTabletHostPort}}") + --throttle_check_as_check_self Should throttler/check return a throttler/check-self result (changes throttler behavior for writes) + --throttle_metrics_query SELECT Override default heartbeat/lag metric. Use either SELECT (must return single row, single value) or `SHOW GLOBAL ... LIKE ...` queries. Set -throttle_metrics_threshold respectively. + --throttle_metrics_threshold float Override default throttle threshold, respective to -throttle_metrics_query (default 1.7976931348623157e+308) + --throttle_tablet_types string Comma separated VTTablet types to be considered by the throttler. default: 'replica'. example: 'replica,rdonly'. 'replica' aways implicitly included (default "replica") + --throttle_threshold duration Replication lag threshold for default lag throttling (default 1s) + --topo_consul_idle_conn_timeout duration Maximum amount of time to pool idle connections. (default 1m30s) + --topo_consul_lock_delay duration LockDelay for consul session. (default 15s) + --topo_consul_lock_session_checks string List of checks for consul session. (default "serfHealth") + --topo_consul_lock_session_ttl string TTL for consul session. + --topo_consul_max_conns_per_host int Maximum number of consul connections per host. + --topo_consul_max_idle_conns int Maximum number of idle consul connections. (default 100) + --topo_consul_watch_poll_duration duration time of the long poll for watch queries. (default 30s) + --topo_etcd_lease_ttl int Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) + --topo_etcd_tls_ca string path to the ca to use to validate the server cert when connecting to the etcd topo server + --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 + --topo_etcd_tls_key string path to the client key to use to connect to the etcd topo server, enables TLS + --topo_global_root string the path of the global topology data in the global topology server + --topo_global_server_address string the address of the global topology server + --topo_implementation string the topology implementation to use + --topo_k8s_context string The kubeconfig context to use, overrides the 'current-context' from the config + --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 + --topo_k8s_namespace string The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config + --topo_read_concurrency int concurrent topo reads (default 32) + --topo_zk_auth_file string auth to use when connecting to the zk topo server, file contents should be :, e.g., digest:user:pass + --topo_zk_base_timeout duration zk base timeout (see zk.Connect) (default 30s) + --topo_zk_max_concurrency int maximum number of pending requests to send to a Zookeeper server. (default 64) + --topo_zk_tls_ca string the server ca to use to validate servers when connecting to the zk topo server + --topo_zk_tls_cert string the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS + --topo_zk_tls_key string the key to use to connect to the zk topo server, enables TLS + --topocustomrule_cell string topo cell for customrules file. (default "global") + --topocustomrule_path string path for customrules file. Disabled if empty. + --tracer string tracing service to use (default "noop") + --tracing-enable-logging whether to enable logging in the tracing service + --tracing-sampling-rate OptionalFloat64 sampling rate for the probabilistic jaeger sampler (default 0.1) + --tracing-sampling-type OptionalString sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) + --track_schema_versions When enabled, vttablet will store versions of schemas at each position that a DDL is applied and allow retrieval of the schema corresponding to a position + --transaction-log-stream-handler string URL handler for streaming transactions log (default "/debug/txlog") + --transaction_limit_by_component Include CallerID.component when considering who the user is for the purpose of transaction limit. + --transaction_limit_by_principal Include CallerID.principal when considering who the user is for the purpose of transaction limit. (default true) + --transaction_limit_by_subcomponent Include CallerID.subcomponent when considering who the user is for the purpose of transaction limit. + --transaction_limit_by_username Include VTGateCallerID.username when considering who the user is for the purpose of transaction limit. (default true) + --transaction_limit_per_user float Maximum number of transactions a single user is allowed to use at any time, represented as fraction of -transaction_cap. (default 0.4) + --transaction_shutdown_grace_period float DEPRECATED: use shutdown_grace_period instead. + --twopc_abandon_age float time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved. + --twopc_coordinator_address string address of the (VTGate) process(es) that will be used to notify of abandoned transactions. + --twopc_enable if the flag is on, 2pc is enabled. Other 2pc flags must be supplied. + --tx-throttler-config string Synonym to -tx_throttler_config (default "target_replication_lag_sec: 2\nmax_replication_lag_sec: 10\ninitial_rate: 100\nmax_increase: 1\nemergency_decrease: 0.5\nmin_duration_between_increases_sec: 40\nmax_duration_between_increases_sec: 62\nmin_duration_between_decreases_sec: 20\nspread_backlog_across_sec: 20\nage_bad_rate_after_sec: 180\nbad_rate_increase: 0.1\nmax_rate_approach_threshold: 0.9\n") + --tx-throttler-default-priority int Default priority assigned to queries that lack priority information. + --tx-throttler-dry-run If present, the transaction throttler only records metrics about requests received and throttled, but does not actually throttle any requests. + --tx-throttler-healthcheck-cells StringList Synonym to -tx_throttler_healthcheck_cells + --tx-throttler-tablet-types TabletTypeList A comma-separated list of tablet types. Only tablets of this type are monitored for replication lag by the transaction throttler. Supported types are replica and/or rdonly. (default replica) + --tx_throttler_config string The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2\nmax_replication_lag_sec: 10\ninitial_rate: 100\nmax_increase: 1\nemergency_decrease: 0.5\nmin_duration_between_increases_sec: 40\nmax_duration_between_increases_sec: 62\nmin_duration_between_decreases_sec: 20\nspread_backlog_across_sec: 20\nage_bad_rate_after_sec: 180\nbad_rate_increase: 0.1\nmax_rate_approach_threshold: 0.9\n") + --tx_throttler_healthcheck_cells StringList A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler. + --unhealthy_threshold duration replication lag after which a replica is considered unhealthy (default 2h0m0s) + --use_super_read_only Set super_read_only flag when performing planned failover. + -v, --v Level log level for V logs + --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging + --vreplication_copy_phase_duration duration Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s) + --vreplication_copy_phase_max_innodb_history_list_length int The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000) + --vreplication_copy_phase_max_mysql_replication_lag int The maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 43200) + --vreplication_experimental_flags int (Bitmask) of experimental features in vreplication to enable (default 1) + --vreplication_healthcheck_retry_delay duration healthcheck retry delay (default 5s) + --vreplication_healthcheck_timeout duration healthcheck retry delay (default 1m0s) + --vreplication_healthcheck_topology_refresh duration refresh interval for re-reading the topology (default 30s) + --vreplication_heartbeat_update_interval int Frequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1) + --vreplication_max_time_to_retry_on_error duration stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence (default 15m0s) + --vreplication_replica_lag_tolerance duration Replica lag threshold duration: once lag is below this we switch from copy phase to the replication (streaming) phase (default 1m0s) + --vreplication_retry_delay duration delay before retrying a failed workflow event in the replication phase (default 5s) + --vreplication_store_compressed_gtid Store compressed gtids in the pos column of _vt.vreplication + --vreplication_tablet_type string comma separated list of tablet types used as a source (default "in_order:REPLICA,PRIMARY") + --vstream_dynamic_packet_size Enable dynamic packet sizing for VReplication. This will adjust the packet size during replication to improve performance. (default true) + --vstream_packet_size int Suggested packet size for VReplication streamer. This is used only as a recommendation. The actual packet size may be more or less than this amount. (default 250000) + --vtctld_addr string address of a vtctld instance + --vtgate_protocol string how to talk to vtgate (default "grpc") + --vttablet_skip_buildinfo_tags string comma-separated list of buildinfo tags to skip from merging with -init_tags. each tag is either an exact match or a regular expression of the form '/regexp/'. (default "/.*/") + --wait_for_backup_interval duration (init restore parameter) if this is greater than 0, instead of starting up empty when no backups are found, keep checking at this interval for a backup to appear (default 0s) + --watch_replication_stream When enabled, vttablet will stream the MySQL replication stream from the local server, and use it to update schema when it sees a DDL. + --xbstream_restore_flags string flags to pass to xbstream command during restore. These should be space separated and will be added to the end of the command. These need to match the ones used for backup e.g. --compress / --decompress, --encrypt / --decrypt + --xtrabackup_backup_flags string flags to pass to backup command. These should be space separated and will be added to the end of the command + --xtrabackup_prepare_flags string flags to pass to prepare command. These should be space separated and will be added to the end of the command + --xtrabackup_root_path string directory location of the xtrabackup and xbstream executables, e.g., /usr/bin + --xtrabackup_stream_mode string which mode to use if streaming, valid values are tar and xbstream (default "tar") + --xtrabackup_stripe_block_size uint Size in bytes of each block that gets sent to a given stripe before rotating to the next stripe (default 102400) + --xtrabackup_stripes uint If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression + --xtrabackup_user string User that xtrabackup will use to connect to the database server. This user must have all necessary privileges. For details, please refer to xtrabackup documentation. diff --git a/go/internal/flag/flag.go b/go/internal/flag/flag.go index 28c8f266ee2..e556a564f7a 100644 --- a/go/internal/flag/flag.go +++ b/go/internal/flag/flag.go @@ -29,6 +29,8 @@ import ( "reflect" "strings" + flag "github.com/spf13/pflag" + "vitess.io/vitess/go/vt/log" ) @@ -40,17 +42,28 @@ import ( // the default Usage formatting unchanged. // // See VEP-4, phase 1 for details: https://github.com/vitessio/enhancements/blob/c766ea905e55409cddeb666d6073cd2ac4c9783e/veps/vep-4.md#phase-1-preparation -func Parse() { - // First, override the Usage func to make flags show in their double-dash - // forms to the user. - SetUsage(goflag.CommandLine, UsageOptions{}) +func Parse(fs *flag.FlagSet) { + fs.AddGoFlagSet(goflag.CommandLine) + + if fs.Lookup("help") == nil { + var help bool + + if fs.ShorthandLookup("h") == nil { + fs.BoolVarP(&help, "help", "h", false, "display usage and exit") + } else { + fs.BoolVar(&help, "help", false, "display usage and exit") + } - // Then, parse as normal. - goflag.Parse() + defer func() { + if help { + flag.Usage() + os.Exit(0) + } + }() + } - // Finally, warn on deprecated flag usage. - warnOnSingleDashLongFlags(goflag.CommandLine, os.Args, log.Warningf) - warnOnMixedPositionalAndFlagArguments(goflag.Args(), log.Warningf) + flag.CommandLine = fs + flag.Parse() } // Args returns the positional arguments with the first double-dash ("--") @@ -58,7 +71,7 @@ func Parse() { // equivalent to flag.Args() from the standard library flag package. func Args() (args []string) { doubleDashIdx := -1 - for i, arg := range goflag.Args() { + for i, arg := range flag.Args() { if arg == "--" { doubleDashIdx = i break @@ -68,7 +81,7 @@ func Args() (args []string) { } if doubleDashIdx != -1 { - args = append(args, goflag.Args()[doubleDashIdx+1:]...) + args = append(args, flag.Args()[doubleDashIdx+1:]...) } return args @@ -95,6 +108,7 @@ const ( ) // Check and warn on any single-dash flags. +// nolint:deadcode func warnOnSingleDashLongFlags(fs *goflag.FlagSet, argv []string, warningf func(msg string, args ...any)) { fs.Visit(func(f *goflag.Flag) { // Boolean flags with single-character names are okay to use the @@ -113,6 +127,7 @@ func warnOnSingleDashLongFlags(fs *goflag.FlagSet, argv []string, warningf func( } // Check and warn for any mixed posarg / dashed-arg on the CLI. +// nolint:deadcode func warnOnMixedPositionalAndFlagArguments(posargs []string, warningf func(msg string, args ...any)) { for _, arg := range posargs { if arg == "--" { diff --git a/go/test/endtoend/topoconncache/topo_conn_cache_test.go b/go/test/endtoend/topoconncache/topo_conn_cache_test.go index b0416ef7b55..48692b8ed40 100644 --- a/go/test/endtoend/topoconncache/topo_conn_cache_test.go +++ b/go/test/endtoend/topoconncache/topo_conn_cache_test.go @@ -74,7 +74,7 @@ func deleteCell(t *testing.T) { deleteTablet(t, shard2Rdonly) // Delete cell2 info from topo - res, err := clusterInstance.VtctlclientProcess.ExecuteCommandWithOutput("DeleteCellInfo", "--force", cell2) + res, err := clusterInstance.VtctlclientProcess.ExecuteCommandWithOutput("DeleteCellInfo", "--", "--force", cell2) t.Log(res) require.Nil(t, err) diff --git a/go/test/endtoend/vtorc/general/vtorc_test.go b/go/test/endtoend/vtorc/general/vtorc_test.go index 560e351fb31..173d166674a 100644 --- a/go/test/endtoend/vtorc/general/vtorc_test.go +++ b/go/test/endtoend/vtorc/general/vtorc_test.go @@ -393,10 +393,10 @@ func TestVtorcWithPrs(t *testing.T) { utils.CheckReplication(t, clusterInfo, curPrimary, shard0.Vttablets, 10*time.Second) output, err := clusterInfo.ClusterInstance.VtctlclientProcess.ExecuteCommandWithOutput( - "PlannedReparentShard", - "-keyspace_shard", fmt.Sprintf("%s/%s", keyspace.Name, shard0.Name), - "-wait_replicas_timeout", "31s", - "-new_primary", replica.Alias) + "PlannedReparentShard", "--", + "--keyspace_shard", fmt.Sprintf("%s/%s", keyspace.Name, shard0.Name), + "--wait_replicas_timeout", "31s", + "--new_primary", replica.Alias) require.NoError(t, err, "error in PlannedReparentShard output - %s", output) time.Sleep(40 * time.Second) diff --git a/go/vt/servenv/servenv.go b/go/vt/servenv/servenv.go index 8f27f0b78f8..80c953695c7 100644 --- a/go/vt/servenv/servenv.go +++ b/go/vt/servenv/servenv.go @@ -43,6 +43,8 @@ import ( // register the HTTP handlers for profiling _ "net/http/pprof" + "github.com/spf13/pflag" + "vitess.io/vitess/go/event" "vitess.io/vitess/go/netutil" "vitess.io/vitess/go/stats" @@ -237,10 +239,59 @@ func RunDefault() { Run(*Port) } +var ( + flagHooksM sync.Mutex + globalFlagHooks []func(*pflag.FlagSet) + commandFlagHooks = map[string][]func(*pflag.FlagSet){} +) + +// OnParse registers a callback function to register flags on the flagset that +// used by any caller of servenv.Parse or servenv.ParseWithArgs. +func OnParse(f func(fs *pflag.FlagSet)) { + flagHooksM.Lock() + defer flagHooksM.Unlock() + + globalFlagHooks = append(globalFlagHooks, f) +} + +// OnParseFor registers a callback function to register flags on the flagset +// used by servenv.Parse or servenv.ParseWithArgs. The provided callback will +// only be called if the `cmd` argument passed to either Parse or ParseWithArgs +// exactly matches the `cmd` argument passed to OnParseFor. +// +// To register for flags for multiple commands, for example if a package's flags +// should be used for only vtgate and vttablet but no other binaries, call this +// multiple times with the same callback function. To register flags for all +// commands globally, use OnParse instead. +func OnParseFor(cmd string, f func(fs *pflag.FlagSet)) { + flagHooksM.Lock() + defer flagHooksM.Unlock() + + commandFlagHooks[cmd] = append(commandFlagHooks[cmd], f) +} + +func getFlagHooksFor(cmd string) (hooks []func(fs *pflag.FlagSet)) { + flagHooksM.Lock() + defer flagHooksM.Unlock() + + hooks = append(hooks, globalFlagHooks...) // done deliberately to copy the slice + + if commandHooks, ok := commandFlagHooks[cmd]; ok { + hooks = append(hooks, commandHooks...) + } + + return hooks +} + // ParseFlags initializes flags and handles the common case when no positional // arguments are expected. func ParseFlags(cmd string) { - _flag.Parse() + fs := pflag.NewFlagSet(cmd, pflag.ExitOnError) + for _, hook := range getFlagHooksFor(cmd) { + hook(fs) + } + + _flag.Parse(fs) if *Version { AppVersion.Print() @@ -255,7 +306,7 @@ func ParseFlags(cmd string) { } } - args := _flag.Args() + args := fs.Args() if len(args) > 0 { flag.Usage() log.Exitf("%s doesn't take any positional arguments, got '%s'", cmd, strings.Join(args, " ")) @@ -264,14 +315,19 @@ func ParseFlags(cmd string) { // ParseFlagsWithArgs initializes flags and returns the positional arguments func ParseFlagsWithArgs(cmd string) []string { - _flag.Parse() + fs := pflag.NewFlagSet(cmd, pflag.ExitOnError) + for _, hook := range getFlagHooksFor(cmd) { + hook(fs) + } + + _flag.Parse(fs) if *Version { AppVersion.Print() os.Exit(0) } - args := _flag.Args() + args := fs.Args() if len(args) == 0 { log.Exitf("%s expected at least one positional argument", cmd) } diff --git a/go/vt/vtctld/api_test.go b/go/vt/vtctld/api_test.go index 54a79d8cf25..9607e16d8bf 100644 --- a/go/vt/vtctld/api_test.go +++ b/go/vt/vtctld/api_test.go @@ -229,10 +229,10 @@ func TestAPI(t *testing.T) { statusCode int }{ // Create snapshot keyspace with durability policy specified - {"POST", "vtctl/", `["CreateKeyspace", "-keyspace_type=SNAPSHOT", "-base_keyspace=ks1", "-snapshot_time=2006-01-02T15:04:05+00:00", "-durability-policy=semi_sync", "ks3"]`, `{ + {"POST", "vtctl/", `["CreateKeyspace", "--keyspace_type=SNAPSHOT", "--base_keyspace=ks1", "--snapshot_time=2006-01-02T15:04:05+00:00", "--durability-policy=semi_sync", "ks3"]`, `{ "Error": "durability-policy cannot be specified while creating a snapshot keyspace"`, http.StatusOK}, // Create snapshot keyspace using API - {"POST", "vtctl/", `["CreateKeyspace", "-keyspace_type=SNAPSHOT", "-base_keyspace=ks1", "-snapshot_time=2006-01-02T15:04:05+00:00", "ks3"]`, `{ + {"POST", "vtctl/", `["CreateKeyspace", "--keyspace_type=SNAPSHOT", "--base_keyspace=ks1", "--snapshot_time=2006-01-02T15:04:05+00:00", "ks3"]`, `{ "Error": "", "Output": "" }`, http.StatusOK}, diff --git a/go/vt/vtgate/tabletgateway.go b/go/vt/vtgate/tabletgateway.go index 17d7018eb12..aa8925a7556 100644 --- a/go/vt/vtgate/tabletgateway.go +++ b/go/vt/vtgate/tabletgateway.go @@ -18,7 +18,6 @@ package vtgate import ( "context" - "flag" "fmt" "math/rand" "sort" @@ -26,9 +25,12 @@ import ( "sync/atomic" "time" + "github.com/spf13/pflag" + "vitess.io/vitess/go/mysql/collations" "vitess.io/vitess/go/vt/discovery" "vitess.io/vitess/go/vt/log" + "vitess.io/vitess/go/vt/servenv" "vitess.io/vitess/go/vt/srvtopo" "vitess.io/vitess/go/vt/topo" "vitess.io/vitess/go/vt/topo/topoproto" @@ -44,15 +46,25 @@ import ( var ( _ discovery.HealthCheck = (*discovery.HealthCheckImpl)(nil) // CellsToWatch is the list of cells the healthcheck operates over. If it is empty, only the local cell is watched - CellsToWatch = flag.String("cells_to_watch", "", "comma-separated list of cells for watching tablets") + CellsToWatch string - bufferImplementation = flag.String("buffer_implementation", "keyspace_events", "Allowed values: healthcheck (legacy implementation), keyspace_events (default)") - initialTabletTimeout = flag.Duration("gateway_initial_tablet_timeout", 30*time.Second, "At startup, the tabletGateway will wait up to this duration to get at least one tablet per keyspace/shard/tablet type") + bufferImplementation = "keyspace_events" + initialTabletTimeout = 30 * time.Second // retryCount is the number of times a query will be retried on error - retryCount = flag.Int("retry-count", 2, "retry count") - routeReplicaToRdonly = flag.Bool("gateway_route_replica_to_rdonly", false, "route REPLICA queries to RDONLY tablets as well as REPLICA tablets") + retryCount = 2 + routeReplicaToRdonly bool ) +func init() { + servenv.OnParseFor("vtgate", func(fs *pflag.FlagSet) { + fs.StringVar(&CellsToWatch, "cells_to_watch", "", "comma-separated list of cells for watching tablets") + fs.StringVar(&bufferImplementation, "buffer_implementation", "keyspace_events", "Allowed values: healthcheck (legacy implementation), keyspace_events (default)") + fs.DurationVar(&initialTabletTimeout, "gateway_initial_tablet_timeout", 30*time.Second, "At startup, the tabletGateway will wait up to this duration to get at least one tablet per keyspace/shard/tablet type") + fs.IntVar(&retryCount, "retry-count", 2, "retry count") + fs.BoolVar(&routeReplicaToRdonly, "gateway_route_replica_to_rdonly", false, "route REPLICA queries to RDONLY tablets as well as REPLICA tablets") + }) +} + // TabletGateway implements the Gateway interface. // This implementation uses the new healthcheck module. type TabletGateway struct { @@ -90,13 +102,13 @@ func NewTabletGateway(ctx context.Context, hc discovery.HealthCheck, serv srvtop log.Exitf("Unable to create new TabletGateway: %v", err) } } - hc = createHealthCheck(ctx, *HealthCheckRetryDelay, *HealthCheckTimeout, topoServer, localCell, *CellsToWatch) + hc = createHealthCheck(ctx, *HealthCheckRetryDelay, *HealthCheckTimeout, topoServer, localCell, CellsToWatch) } gw := &TabletGateway{ hc: hc, srvTopoServer: serv, localCell: localCell, - retryCount: *retryCount, + retryCount: retryCount, statusAggregators: make(map[string]*TabletStatusAggregator), } gw.setupBuffering(ctx) @@ -108,7 +120,7 @@ func (gw *TabletGateway) setupBuffering(ctx context.Context) { cfg := buffer.NewConfigFromFlags() gw.buffer = buffer.New(cfg) - switch *bufferImplementation { + switch bufferImplementation { case "healthcheck": // subscribe to healthcheck updates so that buffer can be notified if needed // we run this in a separate goroutine so that normal processing doesn't need to block @@ -155,7 +167,7 @@ func (gw *TabletGateway) setupBuffering(ctx context.Context) { }(bufferCtx, ksChan, gw.buffer) default: - log.Exitf("unknown buffering implementation for TabletGateway: %q", *bufferImplementation) + log.Exitf("unknown buffering implementation for TabletGateway: %q", bufferImplementation) } } @@ -173,7 +185,7 @@ func (gw *TabletGateway) RegisterStats() { // WaitForTablets is part of the Gateway interface. func (gw *TabletGateway) WaitForTablets(tabletTypesToWait []topodatapb.TabletType) (err error) { log.Infof("Gateway waiting for serving tablets of types %v ...", tabletTypesToWait) - ctx, cancel := context.WithTimeout(context.Background(), *initialTabletTimeout) + ctx, cancel := context.WithTimeout(context.Background(), initialTabletTimeout) defer cancel() defer func() { @@ -283,7 +295,7 @@ func (gw *TabletGateway) withRetry(ctx context.Context, target *querypb.Target, // temporary hack to enable REPLICA type queries to address both REPLICA tablets and RDONLY tablets // original commit - https://github.com/tinyspeck/vitess/pull/166/commits/2552b4ce25a9fdb41ff07fa69f2ccf485fea83ac // discoverygateway patch - https://github.com/slackhq/vitess/commit/47adb7c8fc720cb4cb7a090530b3e88d310ff6d3 - if *routeReplicaToRdonly && target.TabletType == topodatapb.TabletType_REPLICA { + if routeReplicaToRdonly && target.TabletType == topodatapb.TabletType_REPLICA { // Create a new target for the same original keyspace/shard, but RDONLY tablet type. rdonlyTarget := &querypb.Target{ Keyspace: target.Keyspace, @@ -341,7 +353,7 @@ func (gw *TabletGateway) withRetry(ctx context.Context, target *querypb.Target, startTime := time.Now() var canRetry bool - if *routeReplicaToRdonly && target.TabletType == topodatapb.TabletType_REPLICA { + if routeReplicaToRdonly && target.TabletType == topodatapb.TabletType_REPLICA { canRetry, err = inner(ctx, th.Target, th.Conn) } else { canRetry, err = inner(ctx, target, th.Conn) diff --git a/go/vt/vtgate/tabletgateway_flaky_test.go b/go/vt/vtgate/tabletgateway_flaky_test.go index d9df293980d..34bb65363be 100644 --- a/go/vt/vtgate/tabletgateway_flaky_test.go +++ b/go/vt/vtgate/tabletgateway_flaky_test.go @@ -33,11 +33,11 @@ import ( // TestGatewayBufferingWhenPrimarySwitchesServingState is used to test that the buffering mechanism buffers the queries when a primary goes to a non serving state and // stops buffering when the primary is healthy again func TestGatewayBufferingWhenPrimarySwitchesServingState(t *testing.T) { - *bufferImplementation = "keyspace_events" + bufferImplementation = "keyspace_events" buffer.SetBufferingModeInTestingEnv(true) defer func() { buffer.SetBufferingModeInTestingEnv(false) - *bufferImplementation = "healthcheck" + bufferImplementation = "healthcheck" }() keyspace := "ks1" @@ -116,11 +116,11 @@ func TestGatewayBufferingWhenPrimarySwitchesServingState(t *testing.T) { // TestGatewayBufferingWhileReparenting is used to test that the buffering mechanism buffers the queries when a PRS happens // the healthchecks that happen during a PRS are simulated in this test func TestGatewayBufferingWhileReparenting(t *testing.T) { - *bufferImplementation = "keyspace_events" + bufferImplementation = "keyspace_events" buffer.SetBufferingModeInTestingEnv(true) defer func() { buffer.SetBufferingModeInTestingEnv(false) - *bufferImplementation = "healthcheck" + bufferImplementation = "healthcheck" }() keyspace := "ks1" diff --git a/go/vt/wrangler/testlib/planned_reparent_shard_test.go b/go/vt/wrangler/testlib/planned_reparent_shard_test.go index e4746f2178a..7849b17f63b 100644 --- a/go/vt/wrangler/testlib/planned_reparent_shard_test.go +++ b/go/vt/wrangler/testlib/planned_reparent_shard_test.go @@ -123,7 +123,7 @@ func TestPlannedReparentShardNoPrimaryProvided(t *testing.T) { // run PlannedReparentShard // using deprecated flag until it is removed completely. at that time this should be replaced with -wait_replicas_timeout - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard}) + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard}) require.NoError(t, err) // check what was run @@ -244,7 +244,7 @@ func TestPlannedReparentShardNoError(t *testing.T) { defer goodReplica2.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "-new_primary", + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) require.NoError(t, err) @@ -340,7 +340,7 @@ func TestPlannedReparentInitialization(t *testing.T) { defer goodReplica2.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "-new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) require.NoError(t, err) // check what was run @@ -454,7 +454,7 @@ func TestPlannedReparentShardWaitForPositionFail(t *testing.T) { defer goodReplica2.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "-new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) assert.Error(t, err) assert.Contains(t, err.Error(), "replication on primary-elect cell1-0000000001 did not catch up in time") @@ -555,7 +555,7 @@ func TestPlannedReparentShardWaitForPositionTimeout(t *testing.T) { defer goodReplica2.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "-new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) assert.Error(t, err) assert.Contains(t, err.Error(), "replication on primary-elect cell1-0000000001 did not catch up in time") @@ -618,7 +618,7 @@ func TestPlannedReparentShardRelayLogError(t *testing.T) { defer goodReplica1.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", primary.Tablet.Keyspace + "/" + primary.Tablet.Shard, "-new_primary", + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", primary.Tablet.Keyspace + "/" + primary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(primary.Tablet.Alias)}) require.NoError(t, err) // check what was run @@ -702,7 +702,7 @@ func TestPlannedReparentShardRelayLogErrorStartReplication(t *testing.T) { defer goodReplica1.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", primary.Tablet.Keyspace + "/" + primary.Tablet.Shard, "-new_primary", + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", primary.Tablet.Keyspace + "/" + primary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(primary.Tablet.Alias)}) require.NoError(t, err) // check what was run @@ -814,7 +814,7 @@ func TestPlannedReparentShardPromoteReplicaFail(t *testing.T) { defer goodReplica2.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "-new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) assert.Error(t, err) assert.Contains(t, err.Error(), "some error") @@ -847,7 +847,7 @@ func TestPlannedReparentShardPromoteReplicaFail(t *testing.T) { } // run PlannedReparentShard - err = vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "-new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) + err = vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", newPrimary.Tablet.Keyspace + "/" + newPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(newPrimary.Tablet.Alias)}) require.NoError(t, err) // check that primary changed correctly @@ -921,7 +921,7 @@ func TestPlannedReparentShardSamePrimary(t *testing.T) { defer goodReplica2.StopActionLoop(t) // run PlannedReparentShard - err := vp.Run([]string{"PlannedReparentShard", "-wait_replicas_timeout", "10s", "-keyspace_shard", oldPrimary.Tablet.Keyspace + "/" + oldPrimary.Tablet.Shard, "-new_primary", topoproto.TabletAliasString(oldPrimary.Tablet.Alias)}) + err := vp.Run([]string{"PlannedReparentShard", "--wait_replicas_timeout", "10s", "--keyspace_shard", oldPrimary.Tablet.Keyspace + "/" + oldPrimary.Tablet.Shard, "--new_primary", topoproto.TabletAliasString(oldPrimary.Tablet.Alias)}) require.NoError(t, err) assert.False(t, oldPrimary.FakeMysqlDaemon.ReadOnly, "oldPrimary.FakeMysqlDaemon.ReadOnly") } diff --git a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientStaticAuthTest.java b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientStaticAuthTest.java index 41720557dfa..d0dfd81fad2 100644 --- a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientStaticAuthTest.java +++ b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientStaticAuthTest.java @@ -62,11 +62,11 @@ public static void setUpBeforeClass() throws Exception { vtgateclienttest = new ProcessBuilder(Arrays.asList( vtRoot + "/bin/vtgateclienttest", - "-logtostderr", - "-grpc_port", Integer.toString(port), - "-service_map", "grpc-vtgateservice", - "-grpc_auth_mode", "static", - "-grpc_auth_static_password_file", staticAuthFile.getPath() + "--logtostderr", + "--grpc_port", Integer.toString(port), + "--service_map", "grpc-vtgateservice", + "--grpc_auth_mode", "static", + "--grpc_auth_static_password_file", staticAuthFile.getPath() )).inheritIO().start(); Context ctx = Context.getDefault().withDeadlineAfter(Duration.millis(5000L)); diff --git a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTest.java b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTest.java index 7bf485af3a2..e3e255c0ea1 100644 --- a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTest.java +++ b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTest.java @@ -54,10 +54,10 @@ public static void setUpBeforeClass() throws Exception { new ProcessBuilder( Arrays.asList( vtRoot + "/bin/vtgateclienttest", - "-logtostderr", - "-grpc_port", + "--logtostderr", + "--grpc_port", Integer.toString(port), - "-service_map", + "--service_map", "grpc-vtgateservice")) .inheritIO() .start(); diff --git a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsClientAuthTest.java b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsClientAuthTest.java index 92c80e7d15b..81fc6016f87 100644 --- a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsClientAuthTest.java +++ b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsClientAuthTest.java @@ -173,7 +173,7 @@ private static void startVtgate() throws Exception { final String key = certDirectory.getCanonicalPath() + File.separatorChar + "server-key.pem"; final String vtgateCommand = String.format( - "%s -grpc_cert %s -grpc_key %s -grpc_ca %s -logtostderr -grpc_port %s -service_map grpc-vtgateservice", + "%s --grpc_cert %s --grpc_key %s --grpc_ca %s --logtostderr --grpc_port %s --service_map grpc-vtgateservice", vtRoot + "/bin/vtgateclienttest", cert, key, caCert, Integer.toString(port)); System.out.println(vtgateCommand); vtgateclienttest = new ProcessBuilder(vtgateCommand.split(" ")).inheritIO().start(); diff --git a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsTest.java b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsTest.java index d3a6eac9ac1..e005bbd528f 100644 --- a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsTest.java +++ b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientTlsTest.java @@ -153,7 +153,7 @@ private static void startVtgate() throws Exception { final String key = certDirectory.getCanonicalPath() + File.separatorChar + "server-key.pem"; final String vtgate = String.format( - "%s -grpc_cert %s -grpc_key %s -logtostderr -grpc_port %s -service_map grpc-vtgateservice", + "%s --grpc_cert %s --grpc_key %s --logtostderr --grpc_port %s --service_map grpc-vtgateservice", vtRoot + "/bin/vtgateclienttest", cert, key, diff --git a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientWithRetriesTest.java b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientWithRetriesTest.java index 29496934aca..6b802cf9be7 100644 --- a/java/grpc-client/src/test/java/io/client/grpc/GrpcClientWithRetriesTest.java +++ b/java/grpc-client/src/test/java/io/client/grpc/GrpcClientWithRetriesTest.java @@ -49,10 +49,10 @@ public static void setUpBeforeClass() throws Exception { new ProcessBuilder( Arrays.asList( vtRoot + "/bin/vtgateclienttest", - "-logtostderr", - "-grpc_port", + "--logtostderr", + "--grpc_port", Integer.toString(port), - "-service_map", + "--service_map", "grpc-vtgateservice")) .inheritIO() .start();