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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

// Copyright 2025 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: GPL-3.0-only

use serde::{Deserialize, Serialize};
use time::Date;

const BASIC_REPORT_KIND: &str = "vpn_client_stats_report";
const SESSION_REPORT_KIND: &str = "vpn_client_session_report";
const ACTIVE_DEVICE_REPORT_KIND: &str = "vpn_client_active_device";
const VERSION_1: &str = "v1";
const VERSION_2: &str = "v2";

#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VpnClientStatsReport {
    pub kind: String,
    pub api_version: String,
    pub stats_id: String,
    pub static_information: StaticInformationReport,
    pub basic_usage: Option<UsageReport>,
}

impl VpnClientStatsReport {
    pub fn new(stats_id: String, static_information: StaticInformationReport) -> Self {
        VpnClientStatsReport {
            kind: BASIC_REPORT_KIND.into(),
            api_version: VERSION_1.into(),
            stats_id,
            static_information,
            basic_usage: None,
        }
    }

    #[must_use]
    pub fn with_usage_report(mut self, usage_report: UsageReport) -> Self {
        self.basic_usage = Some(usage_report);
        self
    }
}

#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VpnClientStatsReportV2 {
    pub kind: String,
    pub api_version: String,
    pub stats_id: String,

    pub static_information: StaticInformationReport,
    pub session_report: SessionReport,
}

impl VpnClientStatsReportV2 {
    pub fn new(
        stats_id: String,
        static_information: StaticInformationReport,
        session_report: SessionReport,
    ) -> Self {
        VpnClientStatsReportV2 {
            kind: SESSION_REPORT_KIND.into(),
            api_version: VERSION_2.into(),
            stats_id,
            static_information,
            session_report,
        }
    }
}

#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActiveDeviceReport {
    pub kind: String,
    pub api_version: String,
    pub stats_id: String,

    pub static_information: StaticInformationReport,
}

impl ActiveDeviceReport {
    pub fn new(stats_id: String, static_information: StaticInformationReport) -> Self {
        ActiveDeviceReport {
            kind: ACTIVE_DEVICE_REPORT_KIND.into(),
            api_version: VERSION_2.into(),
            stats_id,
            static_information,
        }
    }
}

#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StaticInformationReport {
    pub os_type: String,
    pub os_version: Option<String>,
    pub os_arch: String,
    pub app_version: String,
}

#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UsageReport {
    pub connection_time_ms: Option<i32>,
    pub two_hop: bool,
}

#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SessionReport {
    pub start_day_utc: Date,
    pub connection_time_ms: i32,
    pub tunnel_type: String,
    pub retry_attempt: i32,
    pub session_duration_min: i32,
    pub disconnection_time_ms: i32,
    pub exit_id: String,
    pub exit_cc: Option<String>,
    pub follow_up_id: Option<String>,
    pub error: Option<String>,
}