Struct libp2p_gossipsub::metrics::Metrics

pub struct Metrics { /* fields omitted */ }

A collection of metrics used throughout the Gossipsub behaviour.

Implementations

impl Metrics

pub fn new(registry: &mut Registry, config: Config) -> Self

pub fn set_topic_peers(&mut self, topic: &TopicHash, count: usize)

Register how many peers do we known are subscribed to this topic.

pub fn joined(&mut self, topic: &TopicHash)

Registers the subscription to a topic if the configured limits allow it. Sets the registered number of peers in the mesh to 0.

pub fn left(&mut self, topic: &TopicHash)

Registers the unsubscription to a topic if the topic was previously allowed. Sets the registered number of peers in the mesh to 0.

pub fn peers_included(
    &mut self,
    topic: &TopicHash,
    reason: Inclusion,
    count: usize
)

Register the inclusion of peers in our mesh due to some reason.

pub fn peers_removed(&mut self, topic: &TopicHash, reason: Churn, count: usize)

Register the removal of peers in our mesh due to some reason.

pub fn set_mesh_peers(&mut self, topic: &TopicHash, count: usize)

Register the current number of peers in our mesh for this topic.

pub fn msg_sent(&mut self, topic: &TopicHash, bytes: usize)

Register sending a message over a topic.