nym-statistics-common 1.20.4

This crate contains basic statistics utilities and abstractions to be re-used and applied throughout both the client and gateway implementations
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
66
67

// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use super::ClientStatsEvents;

use nym_credentials_interface::TicketType;
use serde::{Deserialize, Serialize};

#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub(crate) struct ConnectionStats {
    //tickets
    mixnet_entry_spent: u32,
    vpn_entry_spent: u32,
    mixnet_exit_spent: u32,
    vpn_exit_spent: u32,

    //country_connection
    wg_exit_country_code: String,
    mix_exit_country_code: String,
}

/// Event space for Nym API statistics tracking
#[derive(Debug)]
pub enum ConnectionStatsEvent {
    /// ecash ticket was spend
    TicketSpent {
        typ: TicketType,
        amount: u32,
    },
    WgCountry(String),
    MixCountry(String),
}
impl From<ConnectionStatsEvent> for ClientStatsEvents {
    fn from(event: ConnectionStatsEvent) -> ClientStatsEvents {
        ClientStatsEvents::Connection(event)
    }
}

/// Nym API statistics tracking object
#[derive(Default)]
pub struct ConnectionStatsControl {
    // Keep track of packet statistics over time
    stats: ConnectionStats,
}

impl ConnectionStatsControl {
    pub(crate) fn handle_event(&mut self, event: ConnectionStatsEvent) {
        match event {
            ConnectionStatsEvent::TicketSpent { typ, amount } => match typ {
                TicketType::V1MixnetEntry => self.stats.mixnet_entry_spent += amount,
                TicketType::V1MixnetExit => self.stats.mixnet_exit_spent += amount,
                TicketType::V1WireguardEntry => self.stats.vpn_entry_spent += amount,
                TicketType::V1WireguardExit => self.stats.vpn_exit_spent += amount,
            },
            ConnectionStatsEvent::WgCountry(cc) => {
                self.stats.wg_exit_country_code = cc;
            }
            ConnectionStatsEvent::MixCountry(cc) => {
                self.stats.mix_exit_country_code = cc;
            }
        }
    }

    pub(crate) fn report(&self) -> ConnectionStats {
        self.stats.clone()
    }
}