commonware-p2p 2026.5.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

use crate::authenticated::discovery::metrics;
use commonware_cryptography::PublicKey;
use commonware_runtime::{
    telemetry::metrics::{CounterFamily, Gauge, GaugeFamily, MetricsExt as _},
    Metrics as RuntimeMetrics,
};

/// Metrics for the [super::Actor]
pub struct Metrics<P: PublicKey> {
    /// 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: GaugeFamily<metrics::Peer<P>>,

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

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

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

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

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