diff --git a/CHANGELOG/CHANGELOG-3.6.md b/CHANGELOG/CHANGELOG-3.6.md index 8c6a06a87..2d0294cf2 100644 --- a/CHANGELOG/CHANGELOG-3.6.md +++ b/CHANGELOG/CHANGELOG-3.6.md @@ -58,6 +58,7 @@ See [code changes](https://github.com/etcd-io/etcd/compare/v3.5.0...v3.6.0). - Add [v3 discovery](https://github.com/etcd-io/etcd/pull/13635) to bootstrap a new etcd cluster. - Add [field `storage`](https://github.com/etcd-io/etcd/pull/13772) into the response body of endpoint `/version`. - Add [`etcd --max-concurrent-streams`](https://github.com/etcd-io/etcd/pull/14169) flag to configure the max concurrent streams each client can open at a time, and defaults to math.MaxUint32. +- Add [`etcd grpc-proxy --experimental-enable-grpc-logging`](https://github.com/etcd-io/etcd/pull/14266) flag to logging all grpc requests and responses. - Fix [non mutating requests pass through quotaKVServer when NOSPACE](https://github.com/etcd-io/etcd/pull/13435) - Fix [exclude the same alarm type activated by multiple peers](https://github.com/etcd-io/etcd/pull/13467). - Fix [Provide a better liveness probe for when etcd runs as a Kubernetes pod](https://github.com/etcd-io/etcd/pull/13399) diff --git a/server/etcdmain/grpc_proxy.go b/server/etcdmain/grpc_proxy.go index b13520695..aab2d6f83 100644 --- a/server/etcdmain/grpc_proxy.go +++ b/server/etcdmain/grpc_proxy.go @@ -43,6 +43,9 @@ import ( "go.etcd.io/etcd/server/v3/proxy/grpcproxy" "go.uber.org/zap/zapgrpc" + grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware" + grpc_zap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap" + grpc_ctxtags "github.com/grpc-ecosystem/go-grpc-middleware/tags" grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus" "github.com/soheilhy/cmux" "github.com/spf13/cobra" @@ -89,6 +92,7 @@ var ( grpcProxyEnablePprof bool grpcProxyEnableOrdering bool + grpcProxyEnableLogging bool grpcProxyDebug bool @@ -159,6 +163,7 @@ func newGRPCProxyStartCommand() *cobra.Command { // experimental flags cmd.Flags().BoolVar(&grpcProxyEnableOrdering, "experimental-serializable-ordering", false, "Ensure serializable reads have monotonically increasing store revisions across endpoints.") cmd.Flags().StringVar(&grpcProxyLeasing, "experimental-leasing-prefix", "", "leasing metadata prefix for disconnected linearized reads.") + cmd.Flags().BoolVar(&grpcProxyEnableLogging, "experimental-enable-grpc-logging", false, "logging all grpc requests and responses") cmd.Flags().BoolVar(&grpcProxyDebug, "debug", false, "Enable debug-level logging for grpc-proxy.") @@ -430,9 +435,32 @@ func newGRPCProxyServer(lg *zap.Logger, client *clientv3.Client) *grpc.Server { electionp := grpcproxy.NewElectionProxy(client) lockp := grpcproxy.NewLockProxy(client) + alwaysLoggingDeciderServer := func(ctx context.Context, fullMethodName string, servingObject interface{}) bool { return true } + + grpcChainStreamList := []grpc.StreamServerInterceptor{ + grpc_prometheus.StreamServerInterceptor, + } + grpcChainUnaryList := []grpc.UnaryServerInterceptor{ + grpc_prometheus.UnaryServerInterceptor, + } + if grpcProxyEnableLogging { + grpcChainStreamList = append(grpcChainStreamList, + grpc_ctxtags.StreamServerInterceptor(), + grpc_zap.PayloadStreamServerInterceptor(lg, alwaysLoggingDeciderServer), + ) + grpcChainUnaryList = append(grpcChainUnaryList, + grpc_ctxtags.UnaryServerInterceptor(), + grpc_zap.PayloadUnaryServerInterceptor(lg, alwaysLoggingDeciderServer), + ) + } + gopts := []grpc.ServerOption{ - grpc.StreamInterceptor(grpc_prometheus.StreamServerInterceptor), - grpc.UnaryInterceptor(grpc_prometheus.UnaryServerInterceptor), + grpc.StreamInterceptor(grpc_middleware.ChainStreamServer( + grpcChainStreamList..., + )), + grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer( + grpcChainUnaryList..., + )), grpc.MaxConcurrentStreams(math.MaxUint32), } if grpcKeepAliveMinTime > time.Duration(0) {