vitess.io/vitess@v0.16.2/doc/flags/14.0-to-15.0-transition/vtgr.diff (about)

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