casper-node 0.6.3

The Casper blockchain node
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

use prometheus::{IntCounter, IntGauge, Registry};

/// Metrics for the gossiper component.
#[derive(Debug)]
pub struct GossiperMetrics {
    /// Total number of items received by the gossiper.
    pub(super) items_received: IntCounter,
    /// Total number of items gossiped onwards after receiving.
    pub(super) items_gossiped_onwards: IntCounter,
    /// Number of times the process had to pause due to running out of peers.
    pub(super) times_ran_out_of_peers: IntCounter,
    /// Number of items in the gossip table that are paused.
    pub(super) table_items_paused: IntGauge,
    /// Number of items in the gossip table that are currently being gossiped.
    pub(super) table_items_current: IntGauge,
    /// Number of items in the gossip table that are finished.
    pub(super) table_items_finished: IntGauge,
    /// Reference to the registry for unregistering.
    registry: Registry,
}

impl GossiperMetrics {
    /// Creates a new instance of gossiper metrics, using the given prefix.
    pub fn new(name: &str, registry: &Registry) -> Result<Self, prometheus::Error> {
        let items_received = IntCounter::new(
            format!("{}_items_received", name),
            format!(
                "number of items received by the {} gossiper component",
                name
            ),
        )?;
        let items_gossiped_onwards = IntCounter::new(
            format!("{}_items_gossiped_onwards", name),
            format!(
                "number of items received by the {} that were received and gossiped onwards",
                name
            ),
        )?;
        let times_ran_out_of_peers = IntCounter::new(
            format!("{}_times_ran_out_of_peers", name),
            format!(
                "number of times the {} gossiper ran out of peers and had to pause",
                name
            ),
        )?;
        let table_items_paused = IntGauge::new(
            format!("{}_table_items_paused", name),
            format!(
                "number of items in the gossip table of {} in state paused",
                name
            ),
        )?;
        let table_items_current = IntGauge::new(
            format!("{}_table_items_current", name),
            format!(
                "number of items in the gossip table of {} in state current",
                name
            ),
        )?;
        let table_items_finished = IntGauge::new(
            format!("{}_table_items_finished", name),
            format!(
                "number of items in the gossip table of {} in state finished",
                name
            ),
        )?;

        registry.register(Box::new(items_received.clone()))?;
        registry.register(Box::new(items_gossiped_onwards.clone()))?;
        registry.register(Box::new(times_ran_out_of_peers.clone()))?;
        registry.register(Box::new(table_items_paused.clone()))?;
        registry.register(Box::new(table_items_current.clone()))?;
        registry.register(Box::new(table_items_finished.clone()))?;

        Ok(GossiperMetrics {
            items_received,
            items_gossiped_onwards,
            times_ran_out_of_peers,
            table_items_paused,
            table_items_current,
            table_items_finished,
            registry: registry.clone(),
        })
    }
}

impl Drop for GossiperMetrics {
    fn drop(&mut self) {
        self.registry
            .unregister(Box::new(self.items_received.clone()))
            .expect("did not expect deregistering items_received to fail");
        self.registry
            .unregister(Box::new(self.items_gossiped_onwards.clone()))
            .expect("did not expect deregistering items_gossiped_onwards to fail");
        self.registry
            .unregister(Box::new(self.times_ran_out_of_peers.clone()))
            .expect("did not expect deregistering times_ran_out_of_peers to fail");
        self.registry
            .unregister(Box::new(self.table_items_paused.clone()))
            .expect("did not expect deregistering table_items_paused to fail");
        self.registry
            .unregister(Box::new(self.table_items_current.clone()))
            .expect("did not expect deregistering table_items_current to fail");
        self.registry
            .unregister(Box::new(self.table_items_finished.clone()))
            .expect("did not expect deregistering table_items_finished to fail");
    }
}