Struct NetworkMetrics 

#[non_exhaustive]
pub struct NetworkMetrics {
    pub relay_connections: u64,
    pub relay_connections_failed: u64,
    pub relay_connections_ratelimited: u64,
}

What the transport underneath a pipe has been doing, as plain numbers.

A snapshot taken at the moment it was asked for, and owned outright: every field is a u64 this crate copied out of iroh’s counters, rather than a borrow of them. That is the difference between a status page and a leak — Endpoint::metrics hands back a reference to iroh’s own metrics types, and returning one would put both iroh and its metrics crate in the signature of a method whose entire output is three integers.

Monotonic totals for the life of one endpoint, not rates and not gauges. They only ever climb, and they start at zero when the pipe is created; what a caller wants is nearly always the difference between two readings, or the ratio between two fields of one. A pipe that is torn down and re-established starts a fresh endpoint and therefore fresh counts.

#[non_exhaustive], so fields can be added without breaking a caller, and Copy so holding one in a UI’s state costs nothing.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

relay_connections: u64

Relay connections this endpoint established, counted once each time one is made — so a relay that drops and is reconnected to counts twice.

The denominator for the two fields below. On its own it says only whether this endpoint has ever reached a relay at all, which is worth knowing on a machine that reports no relay in its ticket.

relay_connections_failed: u64

Failed attempts to reach a relay, counted per attempt.

An unreachable relay increments this on every retry, so the number grows without bound while nothing works and stops the moment something does. It is a rate in disguise: two readings a few seconds apart say whether this endpoint is currently failing to reach a relay, which no single reading can.

relay_connections_ratelimited: u64

Relay connections on which the relay reported that it was rate limiting this endpoint.

The one a status page has no other way to learn. A throttled pipe is not down: requests still cross it, slowly, and every other signal available says the pipe is fine — the status reads relayed, the peer is present, and nothing fails. This is what separates “the relay is far away” from “the relay is holding this endpoint back”, and the answer changes what an operator should do about it.

Counted at most once per connection, so it is a count of affected connections rather than of complaints; relate it to relay_connections for the proportion.

Trait Implementations

impl Clone for NetworkMetrics

fn clone(&self) -> NetworkMetrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for NetworkMetrics

impl Debug for NetworkMetrics

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

Formats the value using the given formatter.

impl Default for NetworkMetrics

fn default() -> NetworkMetrics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NetworkMetrics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NetworkMetrics

impl PartialEq for NetworkMetrics

fn eq(&self, other: &NetworkMetrics) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for NetworkMetrics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NetworkMetrics