Add canonical log for misbehaving peers #258
Conversation
canonicallog/canonicallog.go
Outdated
| // Protocols should use this to identify a misbehaving peer to allow the end | ||
| // user to easily identify these nodes across protocols and libp2p. | ||
| func LogMisbehavingPeerNetAddr(p peer.ID, peerAddr net.Addr, originalErr error, msg string) { | ||
| ipStrandPort := strings.Split(peerAddr.String(), ":") |
There was a problem hiding this comment.
Any reason not to use manet.FromNetAddr?
Yeah I think this makes sense, but I want to highlight that this doesn't need to be super specific unless we notice that it's useful to differentiate if the TLS handshake or Noise handshake failed. Otherwise we can start at component=handshake. |
| // Protocols should use this to identify a misbehaving peer to allow the end | ||
| // user to easily identify these nodes across protocols and libp2p. | ||
| func LogMisbehavingPeer(p peer.ID, peerAddr multiaddr.Multiaddr, component string, err error, msg string) { | ||
| log.Errorf("CANONICAL_MISBEHAVING_PEER: peer=%s addr=%s component=%s err=%v msg=%s", p, peerAddr.String(), component, err, msg) |
There was a problem hiding this comment.
No strong opinion, but should we use Errorfw instead? Might make it easier for tools to parse.
There was a problem hiding this comment.
You mean Errorw? In my experience parsing key=value pairs are much easier than parsing json. But not a strong opinion here.
Add canonical logging for misbehaving peers. See libp2p/go-libp2p#1598 for more details.
Why go-libp2p-core? I wish I could put this in the go-libp2p mono repo, but I don't want to require go-libp2p just so that the resource manager can use this. But I don't have strong opinions on where this lives. It is unfortunate that this causes a lot of extra stuff to be added to go.mod/sum
I do have strong opinions on consolidating this repo into
go-libp2p, we should. Managing multiple changes across go-libp2p-core, go-libp2p, and resource manager has been like walking through a tar pit. More discussion here libp2p/go-libp2p#1556.