Struct iroh_relay::server::Metrics

pub struct Metrics {

    pub bytes_sent: Counter,
    pub bytes_recv: Counter,
    pub send_packets_sent: Counter,
    pub send_packets_recv: Counter,
    pub send_packets_dropped: Counter,
    pub disco_packets_sent: Counter,
    pub disco_packets_recv: Counter,
    pub disco_packets_dropped: Counter,
    pub other_packets_sent: Counter,
    pub other_packets_recv: Counter,
    pub other_packets_dropped: Counter,
    pub got_ping: Counter,
    pub sent_pong: Counter,
    pub unknown_frames: Counter,
    pub frames_rx_ratelimited_total: Counter,
    pub conns_rx_ratelimited_total: Counter,
    pub accepts: Counter,
    pub disconnects: Counter,
    pub unique_client_keys: Counter,
    pub websocket_accepts: Counter,
    pub derp_accepts: Counter,
}

Available on crate feature server only.

Metrics tracked for the relay server

Fields

bytes_sent: Counter

Bytes sent from a FrameType::SendPacket

bytes_recv: Counter

Bytes received from a FrameType::SendPacket

send_packets_sent: Counter

FrameType::SendPacket sent, that are not disco messages

send_packets_recv: Counter

FrameType::SendPacket received, that are not disco messages

send_packets_dropped: Counter

FrameType::SendPacket dropped, that are not disco messages

disco_packets_sent: Counter

FrameType::SendPacket sent that are disco messages

disco_packets_recv: Counter

FrameType::SendPacket received that are disco messages

disco_packets_dropped: Counter

FrameType::SendPacket dropped that are disco messages

other_packets_sent: Counter

Packets of other FrameTypes sent

other_packets_recv: Counter

Packets of other FrameTypes received

other_packets_dropped: Counter

Packets of other FrameTypes dropped

got_ping: Counter

Number of FrameType::Pings received

sent_pong: Counter

Number of FrameType::Pongs sent

unknown_frames: Counter

Number of FrameType::Unknown received

frames_rx_ratelimited_total: Counter

Number of frames received from client connection which have been rate-limited.

conns_rx_ratelimited_total: Counter

Number of client connections which have had any frames rate-limited.

accepts: Counter

Number of connections we have accepted

disconnects: Counter

Number of connections we have removed because of an error

unique_client_keys: Counter

Number of unique client keys per day

websocket_accepts: Counter

Number of accepted websocket connections

derp_accepts: Counter

Number of accepted ‘iroh derp http’ connection upgrades

Trait Implementations

impl Clone for Metrics

fn clone(&self) -> Metrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metrics

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

Formats the value using the given formatter.

impl Default for Metrics

fn default() -> Self

Returns the “default value” for a type.

impl Iterable for Metrics

fn iter<'a>(&'a self) -> IntoIter<(&'static str, &'a dyn Any)>

Returns an iterator over the struct’s fields as tuples.

impl Metric for Metrics

fn name() -> &'static str

The name of this metric group.

fn new(registry: &mut Registry) -> Self

Initializes this metric group.

fn with_metric<T, F>(f: F)

where F: FnOnce(&Self) -> T,

Access to this metrics group to record a metric. Only records if this metric is registered in the global registry.

fn try_get() -> Option<&'static Self>

Attempts to get the current metric from the global registry.