emissary-core 0.4.0

Rust implementation of the I2P protocol stack
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

// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

use crate::runtime::MetricType;

use alloc::vec::Vec;

// connection metrics
pub const NUM_ACTIVE_CONNECTIONS: &str = "transport_active_connections_count";
pub const NUM_CONNECTIONS: &str = "transport_connections_count";
pub const NUM_REJECTED: &str = "transport_rejected_connections_count";
pub const NUM_ACCEPTED: &str = "transport_accepted_connections_count";
pub const NUM_INITIATED: &str = "transport_initiated_count";
pub const NUM_DIAL_FAILURES: &str = "transport_dial_failure_count";
pub const NUM_INTRODUCER_DIAL_FAILURES: &str = "transport_introducer_dial_failure_count";
pub const NUM_IPV4: &str = "transport_ipv4_router_count";
pub const NUM_IPV6: &str = "transport_ipv6_router_count";
pub const CONNECTIONS_OPENED: &str = "transport_connections_opened_count";
pub const CONNECTIONS_CLOSED: &str = "transport_connections_closed_count";

// netdb-related metrics
pub const NUM_NETDB_QUERIES: &str = "transport_ri_query_count";
pub const NUM_NETDB_QUERY_SUCCESSES: &str = "transport_ri_query_successes";
pub const NUM_NETDB_QUERY_FAILURES: &str = "transport_ri_query_failures";

/// Register transport metrics.
pub fn register_metrics(mut metrics: Vec<MetricType>) -> Vec<MetricType> {
    // counters
    metrics.push(MetricType::Counter {
        name: NUM_INITIATED,
        description: "number of initiated connections",
    });
    metrics.push(MetricType::Counter {
        name: NUM_DIAL_FAILURES,
        description: "number of dial failures",
    });
    metrics.push(MetricType::Counter {
        name: NUM_INTRODUCER_DIAL_FAILURES,
        description: "number of dial failures caused by introducer errors",
    });
    metrics.push(MetricType::Counter {
        name: NUM_REJECTED,
        description: "number of rejected connections",
    });
    metrics.push(MetricType::Counter {
        name: NUM_NETDB_QUERIES,
        description: "number of netdb queries",
    });
    metrics.push(MetricType::Counter {
        name: NUM_NETDB_QUERY_SUCCESSES,
        description: "number of successful netdb queries",
    });
    metrics.push(MetricType::Counter {
        name: NUM_NETDB_QUERY_FAILURES,
        description: "number of failed netdb queries",
    });
    metrics.push(MetricType::Counter {
        name: CONNECTIONS_OPENED,
        description: "how many connections have been opened",
    });
    metrics.push(MetricType::Counter {
        name: CONNECTIONS_CLOSED,
        description: "how many connections have been closed",
    });
    metrics.push(MetricType::Counter {
        name: NUM_CONNECTIONS,
        description: "total number of connections",
    });

    // gauges
    metrics.push(MetricType::Gauge {
        name: NUM_ACTIVE_CONNECTIONS,
        description: "number of active connections",
    });
    metrics.push(MetricType::Gauge {
        name: NUM_IPV4,
        description: "number of active ipv4 connections",
    });
    metrics.push(MetricType::Gauge {
        name: NUM_IPV6,
        description: "number of active ipv6 connections",
    });

    metrics
}