commonware-p2p 2026.4.0

Communicate with authenticated peers over encrypted connections.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

use crate::authenticated::discovery::metrics;
use commonware_runtime::Metrics as RuntimeMetrics;
use prometheus_client::metrics::{counter::Counter, family::Family, gauge::Gauge};

/// Metrics for the [super::Actor]
#[derive(Default)]
pub struct Metrics {
    /// The total number of unique peers in all peer sets being tracked.
    /// Includes bootstrappers, even if they are not in any peer set.
    /// Does not include self, despite having a record for it.
    pub tracked: Gauge,

    /// Blocked peers (value = expiry time as epoch millis).
    pub blocked: Family<metrics::Peer, Gauge>,

    /// The total number of outstanding reservations.
    pub reserved: Gauge,

    /// Unix timestamp in milliseconds when each connected peer became active.
    pub connected: Family<metrics::Peer, Gauge>,

    /// A count of the number of rate-limited reservation events for each peer.
    pub limits: Family<metrics::Peer, Counter>,

    /// A count of the number of updates for each peer.
    pub updates: Family<metrics::Peer, Counter>,
}

impl Metrics {
    /// Create and return a new set of metrics, registered with the given context.
    pub fn init<E: RuntimeMetrics>(context: E) -> Self {
        let metrics = Self::default();
        context.register(
            "tracked",
            "Total number of unique peers in all peer sets being tracked",
            metrics.tracked.clone(),
        );
        context.register(
            "blocked",
            "Blocked peers (value = expiry time as epoch millis)",
            metrics.blocked.clone(),
        );
        context.register(
            "reserved",
            "Total number of outstanding reservations",
            metrics.reserved.clone(),
        );
        context.register(
            "connected",
            "Unix timestamp in milliseconds when each connected peer became active",
            metrics.connected.clone(),
        );
        context.register(
            "limits",
            "Count of the number of rate-limited reservation events for each peer",
            metrics.limits.clone(),
        );
        context.register(
            "updates",
            "Count of the number of updates for each peer",
            metrics.updates.clone(),
        );
        metrics
    }
}