inspector

Documentation

Index

• Constants
• type AggregateRPCInspector
  • func NewAggregateRPCInspector(inspectors ...p2p.GossipSubRPCInspector) *AggregateRPCInspector
  • func (a *AggregateRPCInspector) Inspect(peerID peer.ID, rpc *pubsub.RPC) error
• type ControlMsgMetricsInspector
  • func NewControlMsgMetricsInspector(logger zerolog.Logger, metricsObserver p2p.GossipSubControlMetricsObserver, ...) *ControlMsgMetricsInspector
  • func (c *ControlMsgMetricsInspector) Inspect(from peer.ID, rpc *pubsub.RPC) error
  • func (c *ControlMsgMetricsInspector) Name() string
  • func (c *ControlMsgMetricsInspector) ObserveRPC(req *ObserveRPCMetricsRequest) error
• type ObserveRPCMetricsRequest

Constants

const (
	// DefaultControlMsgMetricsInspectorNumberOfWorkers default number of workers for the inspector component.
	DefaultControlMsgMetricsInspectorNumberOfWorkers = 1
	// DefaultControlMsgMetricsInspectorQueueCacheSize is the default size of the message queue.
	DefaultControlMsgMetricsInspectorQueueCacheSize = 100
)

Types

type AggregateRPCInspector

type AggregateRPCInspector struct {
	// contains filtered or unexported fields
}

AggregateRPCInspector gossip sub RPC inspector that combines multiple RPC inspectors into a single inspector. Each individual inspector will be invoked synchronously.

func NewAggregateRPCInspector

func NewAggregateRPCInspector(inspectors ...p2p.GossipSubRPCInspector) *AggregateRPCInspector

NewAggregateRPCInspector returns new aggregate RPC inspector.

func (*AggregateRPCInspector) Inspect

func (a *AggregateRPCInspector) Inspect(peerID peer.ID, rpc *pubsub.RPC) error

Inspect func with the p2p.GossipSubAppSpecificRpcInspector func signature that will invoke all the configured inspectors.

type ControlMsgMetricsInspector

type ControlMsgMetricsInspector struct {
	component.Component

	// NumberOfWorkers number of component workers.
	NumberOfWorkers int
	// contains filtered or unexported fields
}

ControlMsgMetricsInspector a GossipSub RPC inspector that will observe incoming RPC's and collect metrics related to control messages.

func NewControlMsgMetricsInspector

func NewControlMsgMetricsInspector(logger zerolog.Logger, metricsObserver p2p.GossipSubControlMetricsObserver, numberOfWorkers int, heroStoreOpts ...queue.HeroStoreConfigOption) *ControlMsgMetricsInspector

NewControlMsgMetricsInspector returns a new *ControlMsgMetricsInspector

func (*ControlMsgMetricsInspector) Inspect

func (c *ControlMsgMetricsInspector) Inspect(from peer.ID, rpc *pubsub.RPC) error

Inspect submits a request to the worker pool to observe metrics for the rpc. All errors returned from this function can be considered benign.

func (*ControlMsgMetricsInspector) Name

func (c *ControlMsgMetricsInspector) Name() string

Name returns the name of the rpc inspector.

func (*ControlMsgMetricsInspector) ObserveRPC

func (c *ControlMsgMetricsInspector) ObserveRPC(req *ObserveRPCMetricsRequest) error

ObserveRPC collects metrics for the rpc. No error is ever returned from this func.

type ObserveRPCMetricsRequest

type ObserveRPCMetricsRequest struct {
	// Nonce adds random value so that when msg req is stored on hero store a unique ID can be created from the struct fields.
	Nonce []byte
	// From the sender of the RPC.
	From peer.ID
	// contains filtered or unexported fields
}

ObserveRPCMetricsRequest represents a request to capture metrics for the provided RPC