This repository has been archived by the owner on Sep 6, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add canonical log for misbehaving peers (#258)
* Add canonical logging for misbehaving peers * Add component and use manet.FromNetAddr * Fix log test
- Loading branch information
Showing
4 changed files
with
106 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| package canonicallog | ||
|
|
||
| import ( | ||
| "net" | ||
|
|
||
| logging "github.com/ipfs/go-log/v2" | ||
| "github.com/libp2p/go-libp2p-core/peer" | ||
| "github.com/multiformats/go-multiaddr" | ||
| manet "github.com/multiformats/go-multiaddr/net" | ||
| ) | ||
|
|
||
| var log = logging.WithSkip(logging.Logger("canonical-log"), 1) | ||
|
|
||
| // LogMisbehavingPeer is the canonical way to log a misbehaving peer. | ||
| // 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) | ||
| } | ||
|
|
||
| // LogMisbehavingPeer is the canonical way to log a misbehaving peer. | ||
| // 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, component string, originalErr error, msg string) { | ||
| ma, err := manet.FromNetAddr(peerAddr) | ||
| if err != nil { | ||
| log.Errorf("CANONICAL_MISBEHAVING_PEER: peer=%s netAddr=%s component=%s err=%v msg=%s", p, peerAddr.String(), component, originalErr, msg) | ||
| } | ||
|
|
||
| log.Errorf("CANONICAL_MISBEHAVING_PEER: peer=%s addr=%s component=%s err=%v msg=%s", p, ma, component, originalErr, msg) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| package canonicallog | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/libp2p/go-libp2p-core/test" | ||
| "github.com/multiformats/go-multiaddr" | ||
| ) | ||
|
|
||
| func TestLogs(t *testing.T) { | ||
| LogMisbehavingPeer(test.RandPeerIDFatal(t), multiaddr.StringCast("/ip4/1.2.3.4"), "somecomponent", fmt.Errorf("something"), "hi") | ||
| LogMisbehavingPeerNetAddr(test.RandPeerIDFatal(t), dummyNetAddr{}, "somecomponent", fmt.Errorf("something"), "hi") | ||
| } | ||
|
|
||
| type dummyNetAddr struct{} | ||
|
|
||
| func (d dummyNetAddr) Network() string { return "tcp" } | ||
| func (d dummyNetAddr) String() string { return "127.0.0.1:80" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters