Struct holochain::prelude::metrics::Metrics

pub struct Metrics { /* private fields */ }

Metrics tracking for remote nodes to help choose which remote node to initiate the next round with.

Implementations

impl Metrics

pub fn dump_historical(&self) -> Vec<MetricRecord, Global>

Dump historical metrics for recording to db.

pub fn dump(&self) -> Value

Dump json encoded metrics

pub fn record_extrap_cov_event(&mut self, extrap_cov: f32)

Record an individual extrapolated coverage event (either from us or a remote) and add it to our running aggregate extrapolated coverage metric.

pub fn record_reachability_event<'a, T, I>(
    &mut self,
    success: bool,
    remote_agent_list: I
)where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Sucessful and unsuccessful messages from the remote can be combined to estimate a “reachability quotient” between 1 (or 0 if empty) and 100. Errors are weighted heavier because we retry less frequently. Call this to register a reachability event. Note, record_success and record_error below invoke this function internally, you don’t need to call it again.

pub fn record_latency_micros<'a, T, I, V>(
    &mut self,
    micros: V,
    remote_agent_list: I
)where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,
    V: AsPrimitive<f32>,

Running average for latency microseconds for any direct request/response calls to remote agent.

pub fn record_initiate<'a, T, I>(
    &mut self,
    remote_agent_list: I,
    gossip_type: GossipModuleType
)where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Record a gossip round has been initiated by us.

pub fn record_accept<'a, T, I>(
    &mut self,
    remote_agent_list: I,
    gossip_type: GossipModuleType
)where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Record a gossip round has been initiated by a peer.

pub fn record_success<'a, T, I>(
    &mut self,
    remote_agent_list: I,
    gossip_type: GossipModuleType
)where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Record a gossip round has completed successfully.

pub fn record_error<'a, T, I>(
    &mut self,
    remote_agent_list: I,
    gossip_type: GossipModuleType
)where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Record a gossip round has finished with an error.

pub fn update_current_round(
    &mut self,
    peer: &Tx2Cert,
    gossip_type: GossipModuleType,
    round_state: &RoundState
)

Update node-level info about a current round, or create one if it doesn’t exist

pub fn complete_current_round(&mut self, node: &Tx2Cert, error: bool)

Remove the current round info once it’s complete, and put it into the history list

pub fn record_force_initiate(&mut self)

Record that we should force initiate the next few rounds.

pub fn last_success<'a, T, I>(
    &self,
    remote_agent_list: I
) -> Option<&RoundMetric>where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Get the last successful round time.

pub fn is_current_round<'a, T, I>(&self, remote_agent_list: I) -> boolwhere
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Is this node currently in an active round?

pub fn last_outcome<'a, T, I>(
    &self,
    remote_agent_list: I
) -> Option<RoundOutcome>where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

What was the last outcome for this node’s gossip round?

pub fn forced_initiate(&self) -> bool

Should we force initiate the next round?

pub fn reachability_quotient<'a, T, I>(&self, remote_agent_list: I) -> f32where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Return the average (mean) reachability quotient for the supplied remote agents.

pub fn latency_micros<'a, T, I>(&self, remote_agent_list: I) -> f32where
    T: Into<AgentLike<'a>>,
    I: IntoIterator<Item = T>,

Return the average (mean) latency microseconds for the supplied remote agents.

pub fn peer_agent_histories(
    &self
) -> &HashMap<Arc<KitsuneAgent>, PeerAgentHistory, RandomState>

Getter

pub fn peer_node_histories(
    &self
) -> &HashMap<Tx2Cert, PeerNodeHistory, RandomState>

Getter

Trait Implementations

impl Debug for Metrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Metrics

fn default() -> Metrics

Returns the “default value” for a type.

impl Display for Metrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.