improve description for grpc-proxy keepalive arguments

Signed-off-by: shihuixing <shihuixing@jd.com>
This commit is contained in:
shihuixing
2024-02-08 14:45:51 +08:00
parent 79716fa112
commit cf296a0b38

View File

@@ -141,9 +141,9 @@ func newGRPCProxyStartCommand() *cobra.Command {
cmd.Flags().BoolVar(&grpcProxyInsecureDiscovery, "insecure-discovery", false, "accept insecure SRV records")
cmd.Flags().StringSliceVar(&grpcProxyEndpoints, "endpoints", []string{"127.0.0.1:2379"}, "comma separated etcd cluster endpoints")
cmd.Flags().DurationVar(&grpcProxyEndpointsAutoSyncInterval, "endpoints-auto-sync-interval", 0, "etcd endpoints auto sync interval (disabled by default)")
cmd.Flags().DurationVar(&grpcProxyDialKeepAliveTime, "dial-keepalive-time", 0, "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 (0 to disable).")
cmd.Flags().DurationVar(&grpcProxyDialKeepAliveTimeout, "dial-keepalive-timeout", embed.DefaultGRPCKeepAliveTimeout, "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 20s).")
cmd.Flags().BoolVar(&grpcProxyPermitWithoutStream, "permit-without-stream", false, "if true, client sends keepalive pings even with no active RPCs. if false, when there are no active RPCs, Time and Timeout will be ignored and no keepalive pings will be sent (default false).")
cmd.Flags().DurationVar(&grpcProxyDialKeepAliveTime, "dial-keepalive-time", 0, "keepalive time for client(grpc-proxy) connections (default 0, disable).")
cmd.Flags().DurationVar(&grpcProxyDialKeepAliveTimeout, "dial-keepalive-timeout", embed.DefaultGRPCKeepAliveTimeout, "keepalive timeout for client(grpc-proxy) connections (default 20s).")
cmd.Flags().BoolVar(&grpcProxyPermitWithoutStream, "permit-without-stream", false, "if true, client(grpc-proxy) sends keepalive pings even with no active RPCs (default false).")
cmd.Flags().StringVar(&grpcProxyAdvertiseClientURL, "advertise-client-url", "127.0.0.1:23790", "advertise address to register (must be reachable by client)")
cmd.Flags().StringVar(&grpcProxyResolverPrefix, "resolver-prefix", "", "prefix to use for registering proxy (must be shared with other grpc-proxy members)")
cmd.Flags().IntVar(&grpcProxyResolverTTL, "resolver-ttl", 0, "specify TTL, in seconds, when registering proxy endpoints")