refactor: only log errors different from ErrNoPeersAvailable when selecting random peers.
#864
Conversation
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
…electing random peers. Includes a minor refactor to not need to use pointers for the peerID
Jenkins Builds
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| if err == nil { | ||
| return peerID, nil | ||
| } else if !errors.Is(err, ErrNoPeersAvailable) { | ||
| pm.logger.Debug("could not retrieve random peer from slot", zap.String("protocol", string(criteria.Proto)), zap.String("pubsubTopic", criteria.PubsubTopic), zap.Error(err)) |
Check failure
Code scanning / CodeQL
Log entries created from user input High
vitvly
approved these changes
Nov 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
@vitvly reported that he sees often in status-go logs the line
"could not retrieve random peer from slot" error="no suitable peers found". When reviewing the code, I see that since status-go does not use service slots for retrieving peers supporting filter protocol, but instead depends on the peers that are discovered, this error was generated and logged very frequently.Since this is not an error per se but a possible outcome of just not having peers registered in the service slots, I did a small refactor to only log errors if different from
ErrNoPeersAvailable, as well as adding more information to the logs like the protocol and pubsub topic being retrieved.I also include a minor refactor to not need to use pointers for the peerID