From bc125a95ae02d1e76b6d20448871c42043d193c7 Mon Sep 17 00:00:00 2001 From: Nishant Das Date: Thu, 19 Oct 2023 11:49:34 +0800 Subject: [PATCH] Set Verbosity of Goodbye Logs to Trace (#13077) --- .../rpc/apimiddleware/endpoint_factory_test.go | 10 +++++----- .../rpc/eth/beacon/blinded_blocks_test.go | 1 - beacon-chain/rpc/eth/beacon/blocks_test.go | 1 - beacon-chain/sync/rpc_goodbye.go | 6 +++--- cmd/prysmctl/p2p/handler.go | 18 +++++++++++------- proto/prysm/v1alpha1/slasher.pb.gw.go | 3 ++- 6 files changed, 21 insertions(+), 18 deletions(-) diff --git a/beacon-chain/rpc/apimiddleware/endpoint_factory_test.go b/beacon-chain/rpc/apimiddleware/endpoint_factory_test.go index 08d1420bee..2f351521a3 100644 --- a/beacon-chain/rpc/apimiddleware/endpoint_factory_test.go +++ b/beacon-chain/rpc/apimiddleware/endpoint_factory_test.go @@ -8,10 +8,10 @@ import ( ) func TestBeaconEndpointFactory_AllPathsRegistered(t *testing.T) { - f := &apimiddleware.BeaconEndpointFactory{} + f := &apimiddleware.BeaconEndpointFactory{} - for _, p := range f.Paths() { - _, err := f.Create(p) - require.NoError(t, err, "failed to register %s", p) - } + for _, p := range f.Paths() { + _, err := f.Create(p) + require.NoError(t, err, "failed to register %s", p) + } } diff --git a/beacon-chain/rpc/eth/beacon/blinded_blocks_test.go b/beacon-chain/rpc/eth/beacon/blinded_blocks_test.go index c50319e095..519aebf052 100644 --- a/beacon-chain/rpc/eth/beacon/blinded_blocks_test.go +++ b/beacon-chain/rpc/eth/beacon/blinded_blocks_test.go @@ -1,2 +1 @@ package beacon - diff --git a/beacon-chain/rpc/eth/beacon/blocks_test.go b/beacon-chain/rpc/eth/beacon/blocks_test.go index c50319e095..519aebf052 100644 --- a/beacon-chain/rpc/eth/beacon/blocks_test.go +++ b/beacon-chain/rpc/eth/beacon/blocks_test.go @@ -1,2 +1 @@ package beacon - diff --git a/beacon-chain/sync/rpc_goodbye.go b/beacon-chain/sync/rpc_goodbye.go index 3737505ed2..94eb1ee2a1 100644 --- a/beacon-chain/sync/rpc_goodbye.go +++ b/beacon-chain/sync/rpc_goodbye.go @@ -46,7 +46,7 @@ func (s *Service) goodbyeRPCHandler(_ context.Context, msg interface{}, stream l } s.rateLimiter.add(stream, 1) log := log.WithField("Reason", goodbyeMessage(*m)) - log.WithField("peer", stream.Conn().RemotePeer()).Debug("Peer has sent a goodbye message") + log.WithField("peer", stream.Conn().RemotePeer()).Trace("Peer has sent a goodbye message") s.cfg.p2p.Peers().SetNextValidTime(stream.Conn().RemotePeer(), goodByeBackoff(*m)) // closes all streams with the peer return s.cfg.p2p.Disconnect(stream.Conn().RemotePeer()) @@ -87,7 +87,7 @@ func (s *Service) sendGoodByeAndDisconnect(ctx context.Context, code p2ptypes.RP log.WithFields(logrus.Fields{ "error": err, "peer": id, - }).Debug("Could not send goodbye message to peer") + }).Trace("Could not send goodbye message to peer") } return s.cfg.p2p.Disconnect(id) } @@ -107,7 +107,7 @@ func (s *Service) sendGoodByeMessage(ctx context.Context, code p2ptypes.RPCGoodb defer closeStream(stream, log) log := log.WithField("Reason", goodbyeMessage(code)) - log.WithField("peer", stream.Conn().RemotePeer()).Debug("Sending Goodbye message to peer") + log.WithField("peer", stream.Conn().RemotePeer()).Trace("Sending Goodbye message to peer") // Wait up to the response timeout for the peer to receive the goodbye // and close the stream (or disconnect). We usually don't bother waiting diff --git a/cmd/prysmctl/p2p/handler.go b/cmd/prysmctl/p2p/handler.go index 926bb611c1..d9bd350903 100644 --- a/cmd/prysmctl/p2p/handler.go +++ b/cmd/prysmctl/p2p/handler.go @@ -68,12 +68,8 @@ func (c *client) registerRPCHandler(baseTopic string, handle rpcHandler) { return } if err := c.Encoding().DecodeWithMaxLength(stream, msg); err != nil { - // Debug logs for goodbye/status errors - if strings.Contains(topic, p2p.RPCGoodByeTopicV1) || strings.Contains(topic, p2p.RPCStatusTopicV1) { - log.WithError(err).Debug("Could not decode goodbye stream message") - return - } - log.WithError(err).Debug("Could not decode stream message") + // Trace logs for goodbye errors + logStreamErrors(err, topic) return } if err := handle(context.Background(), msg, stream); err != nil { @@ -89,7 +85,7 @@ func (c *client) registerRPCHandler(baseTopic string, handle rpcHandler) { return } if err := c.Encoding().DecodeWithMaxLength(stream, msg); err != nil { - log.WithError(err).Debug("Could not decode stream message") + logStreamErrors(err, topic) return } if err := handle(context.Background(), nTyp.Elem().Interface(), stream); err != nil { @@ -100,3 +96,11 @@ func (c *client) registerRPCHandler(baseTopic string, handle rpcHandler) { } }) } + +func logStreamErrors(err error, topic string) { + if strings.Contains(topic, p2p.RPCGoodByeTopicV1) { + log.WithError(err).Trace("Could not decode goodbye stream message") + return + } + log.WithError(err).Debug("Could not decode stream message") +} diff --git a/proto/prysm/v1alpha1/slasher.pb.gw.go b/proto/prysm/v1alpha1/slasher.pb.gw.go index b76fb6098a..cdd03643f0 100755 --- a/proto/prysm/v1alpha1/slasher.pb.gw.go +++ b/proto/prysm/v1alpha1/slasher.pb.gw.go @@ -1,3 +1,4 @@ +//go:build ignore // +build ignore -package ignore \ No newline at end of file +package ignore