forked from onflow/flow-go
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request onflow#4543 from onflow/khalil/1897-ihave-rpc-tracker
Gossipsub Tracer RPCSent tracker
- Loading branch information
Showing
18 changed files
with
495 additions
and
38 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
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
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
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
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
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
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
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,86 @@ | ||
| package internal | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/rs/zerolog" | ||
|
|
||
| "github.com/onflow/flow-go/model/flow" | ||
| "github.com/onflow/flow-go/module" | ||
| herocache "github.com/onflow/flow-go/module/mempool/herocache/backdata" | ||
| "github.com/onflow/flow-go/module/mempool/herocache/backdata/heropool" | ||
| "github.com/onflow/flow-go/module/mempool/stdmap" | ||
| p2pmsg "github.com/onflow/flow-go/network/p2p/message" | ||
| ) | ||
|
|
||
| // rpcCtrlMsgSentCacheConfig configuration for the rpc sent cache. | ||
| type rpcCtrlMsgSentCacheConfig struct { | ||
| logger zerolog.Logger | ||
| sizeLimit uint32 | ||
| collector module.HeroCacheMetrics | ||
| } | ||
|
|
||
| // rpcSentCache cache that stores rpcSentEntity. These entity's represent RPC control messages sent from the local node. | ||
| type rpcSentCache struct { | ||
| // c is the underlying cache. | ||
| c *stdmap.Backend | ||
| } | ||
|
|
||
| // newRPCSentCache creates a new *rpcSentCache. | ||
| // Args: | ||
| // - config: record cache config. | ||
| // Returns: | ||
| // - *rpcSentCache: the created cache. | ||
| // Note that this cache is intended to track control messages sent by the local node, | ||
| // it stores a RPCSendEntity using an Id which should uniquely identifies the message being tracked. | ||
| func newRPCSentCache(config *rpcCtrlMsgSentCacheConfig) *rpcSentCache { | ||
| backData := herocache.NewCache(config.sizeLimit, | ||
| herocache.DefaultOversizeFactor, | ||
| heropool.LRUEjection, | ||
| config.logger.With().Str("mempool", "gossipsub-rpc-control-messages-sent").Logger(), | ||
| config.collector) | ||
| return &rpcSentCache{ | ||
| c: stdmap.NewBackend(stdmap.WithBackData(backData)), | ||
| } | ||
| } | ||
|
|
||
| // add initializes the record cached for the given messageEntityID if it does not exist. | ||
| // Returns true if the record is initialized, false otherwise (i.e.: the record already exists). | ||
| // Args: | ||
| // - topic: the topic ID. | ||
| // - messageId: the message ID. | ||
| // - controlMsgType: the rpc control message type. | ||
| // Returns: | ||
| // - bool: true if the record is initialized, false otherwise (i.e.: the record already exists). | ||
| // Note that if add is called multiple times for the same messageEntityID, the record is initialized only once, and the | ||
| // subsequent calls return false and do not change the record (i.e.: the record is not re-initialized). | ||
| func (r *rpcSentCache) add(topic string, messageId string, controlMsgType p2pmsg.ControlMessageType) bool { | ||
| return r.c.Add(newRPCSentEntity(r.rpcSentEntityID(topic, messageId, controlMsgType), controlMsgType)) | ||
| } | ||
|
|
||
| // has checks if the RPC message has been cached indicating it has been sent. | ||
| // Args: | ||
| // - topic: the topic ID. | ||
| // - messageId: the message ID. | ||
| // - controlMsgType: the rpc control message type. | ||
| // Returns: | ||
| // - bool: true if the RPC has been cache indicating it was sent from the local node. | ||
| func (r *rpcSentCache) has(topic string, messageId string, controlMsgType p2pmsg.ControlMessageType) bool { | ||
| return r.c.Has(r.rpcSentEntityID(topic, messageId, controlMsgType)) | ||
| } | ||
|
|
||
| // size returns the number of records in the cache. | ||
| func (r *rpcSentCache) size() uint { | ||
| return r.c.Size() | ||
| } | ||
|
|
||
| // rpcSentEntityID creates an entity ID from the topic, messageID and control message type. | ||
| // Args: | ||
| // - topic: the topic ID. | ||
| // - messageId: the message ID. | ||
| // - controlMsgType: the rpc control message type. | ||
| // Returns: | ||
| // - flow.Identifier: the entity ID. | ||
| func (r *rpcSentCache) rpcSentEntityID(topic string, messageId string, controlMsgType p2pmsg.ControlMessageType) flow.Identifier { | ||
| return flow.MakeIDFromFingerPrint([]byte(fmt.Sprintf("%s%s%s", topic, messageId, controlMsgType))) | ||
| } |
Oops, something went wrong.