From e1420656320ad8c9bae238453d111fe0afa1ac10 Mon Sep 17 00:00:00 2001 From: Yahya Hassanzadeh Date: Fri, 27 Oct 2023 16:56:06 -0700 Subject: [PATCH] improves logging --- network/p2p/connection/connector.go | 2 +- network/p2p/p2pbuilder/libp2pNodeBuilder.go | 14 ++++++++------ network/validator/target_validator.go | 3 ++- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/network/p2p/connection/connector.go b/network/p2p/connection/connector.go index 69fbb5d4359..2e59c595bf7 100644 --- a/network/p2p/connection/connector.go +++ b/network/p2p/connection/connector.go @@ -59,7 +59,7 @@ var _ p2p.PeerUpdater = (*PeerUpdater)(nil) // - error: an error if there is any error while creating the connector. The errors are irrecoverable and unexpected. func NewPeerUpdater(cfg *PeerUpdaterConfig) (*PeerUpdater, error) { libP2PConnector := &PeerUpdater{ - log: cfg.Logger, + log: cfg.Logger.With().Str("component", "peer-updater").Logger(), connector: cfg.Connector, host: cfg.Host, pruneConnections: cfg.PruneConnections, diff --git a/network/p2p/p2pbuilder/libp2pNodeBuilder.go b/network/p2p/p2pbuilder/libp2pNodeBuilder.go index 0340069a5de..45e5cdcb872 100644 --- a/network/p2p/p2pbuilder/libp2pNodeBuilder.go +++ b/network/p2p/p2pbuilder/libp2pNodeBuilder.go @@ -36,6 +36,7 @@ import ( p2pconfig "github.com/onflow/flow-go/network/p2p/p2pbuilder/config" gossipsubbuilder "github.com/onflow/flow-go/network/p2p/p2pbuilder/gossipsub" "github.com/onflow/flow-go/network/p2p/p2pconf" + "github.com/onflow/flow-go/network/p2p/p2plogging" "github.com/onflow/flow-go/network/p2p/p2pnode" "github.com/onflow/flow-go/network/p2p/subscription" "github.com/onflow/flow-go/network/p2p/tracer" @@ -254,6 +255,7 @@ func (builder *LibP2PNodeBuilder) Build() (p2p.LibP2PNode, error) { return nil, err } builder.gossipSubBuilder.SetHost(h) + lg := builder.logger.With().Str("local_peer_id", p2plogging.PeerId(h.ID())).Logger() pCache, err := p2pnode.NewProtocolPeerCache(builder.logger, h) if err != nil { @@ -269,7 +271,7 @@ func (builder *LibP2PNodeBuilder) Build() (p2p.LibP2PNode, error) { peerUpdater, err := connection.NewPeerUpdater( &connection.PeerUpdaterConfig{ PruneConnections: builder.peerManagerConfig.ConnectionPruning, - Logger: builder.logger, + Logger: lg, Host: connection.NewConnectorHost(h), Connector: connector, }) @@ -277,21 +279,21 @@ func (builder *LibP2PNodeBuilder) Build() (p2p.LibP2PNode, error) { return nil, fmt.Errorf("failed to create libp2p connector: %w", err) } - peerManager = connection.NewPeerManager(builder.logger, builder.peerManagerConfig.UpdateInterval, peerUpdater) + peerManager = connection.NewPeerManager(lg, builder.peerManagerConfig.UpdateInterval, peerUpdater) if builder.unicastConfig.RateLimiterDistributor != nil { builder.unicastConfig.RateLimiterDistributor.AddConsumer(peerManager) } } - node := builder.createNode(builder.logger, h, pCache, peerManager, builder.disallowListCacheCfg) + node := builder.createNode(lg, h, pCache, peerManager, builder.disallowListCacheCfg) if builder.connGater != nil { builder.connGater.SetDisallowListOracle(node) } unicastManager, err := unicast.NewUnicastManager(&unicast.ManagerConfig{ - Logger: builder.logger, + Logger: lg, StreamFactory: stream.NewLibP2PStreamFactory(h), SporkId: builder.sporkId, ConnStatus: node, @@ -305,7 +307,7 @@ func (builder *LibP2PNodeBuilder) Build() (p2p.LibP2PNode, error) { MaxDialRetryAttemptTimes: builder.unicastConfig.MaxDialRetryAttemptTimes, DialConfigCacheFactory: func(configFactory func() unicast.DialConfig) unicast.DialConfigCache { return unicastcache.NewDialConfigCache(builder.unicastConfig.DialConfigCacheSize, - builder.logger, + lg, metrics.DialConfigCacheMetricFactory(builder.metricsConfig.HeroCacheFactory, builder.networkingType), configFactory) }, @@ -327,7 +329,7 @@ func (builder *LibP2PNodeBuilder) Build() (p2p.LibP2PNode, error) { ctx.Throw(fmt.Errorf("could not set routing system: %w", err)) } builder.gossipSubBuilder.SetRoutingSystem(routingSystem) - builder.logger.Debug().Msg("routing system created") + lg.Debug().Msg("routing system created") } // gossipsub is created here, because it needs to be created during the node startup. gossipSub, err := builder.gossipSubBuilder.Build(ctx) diff --git a/network/validator/target_validator.go b/network/validator/target_validator.go index 5a9b1ab73f9..d02901b166e 100644 --- a/network/validator/target_validator.go +++ b/network/validator/target_validator.go @@ -35,7 +35,8 @@ func (tv *TargetValidator) Validate(msg network.IncomingMessageScope) bool { } } tv.log.Debug(). - Hex("target", logging.ID(tv.target)). + Hex("message_target_id", logging.ID(tv.target)). + Hex("local_node_id", logging.ID(tv.target)). Hex("event_id", msg.EventID()). Msg("message not intended for target") return false