routing 0.22.0

A secured storage DHT
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

// Copyright 2016 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement, version 1.0.  This, along with the
// Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

use core::GROUP_SIZE;
use messages::{DirectMessage, MessageContent, RoutingMessage, Request, Response};

/// The number of messages after which the message statistics should be printed.
const MSG_LOG_COUNT: usize = 500;

/// A collection of counters to gather Routing statistics.
#[derive(Default)]
pub struct Stats {
    // TODO: Make these private and move the logic here.
    pub cur_routing_table_size: usize,
    pub cur_client_num: usize,
    pub cumulative_client_num: usize,
    pub tunnel_client_pairs: usize,
    pub tunnel_connections: usize,

    /// Messages sent by us on different routes.
    routes: [usize; GROUP_SIZE],
    /// Messages we sent unsuccessfully: unacknowledged on all routes.
    unacked_msgs: usize,

    msg_direct_node_identify: usize,
    msg_direct_new_node: usize,
    msg_direct_connection_unneeded: usize,

    msg_get: usize,
    msg_put: usize,
    msg_post: usize,
    msg_delete: usize,
    msg_get_account_info: usize,
    msg_get_close_group: usize,
    msg_get_node_name: usize,
    msg_expect_close_node: usize,
    msg_refresh: usize,
    msg_connection_info: usize,
    msg_get_success: usize,
    msg_get_failure: usize,
    msg_put_success: usize,
    msg_put_failure: usize,
    msg_post_success: usize,
    msg_post_failure: usize,
    msg_delete_success: usize,
    msg_delete_failure: usize,
    msg_get_account_info_success: usize,
    msg_get_account_info_failure: usize,
    msg_get_close_group_rsp: usize,
    msg_get_node_name_rsp: usize,
    msg_ack: usize,
    msg_hash: usize,

    msg_other: usize,

    msg_total: usize,
    msg_total_bytes: u64,
}

impl Stats {
    pub fn count_unacked(&mut self) {
        self.unacked_msgs += 1;
    }

    pub fn count_route(&mut self, route: u8) {
        match self.routes.get_mut(route as usize) {
            Some(count) => *count += 1,
            None => error!("Unexpected route number {}", route),
        }
    }

    /// Increments the counter for the given request.
    pub fn count_request(&mut self, request: &Request) {
        match *request {
            Request::Refresh(..) => self.msg_refresh += 1,
            Request::Get(..) => self.msg_get += 1,
            Request::Put(..) => self.msg_put += 1,
            Request::Post(..) => self.msg_post += 1,
            Request::Delete(..) => self.msg_delete += 1,
            Request::GetAccountInfo(..) => self.msg_get_account_info += 1,
        }
        self.increment_msg_total();
    }

    /// Increments the counter for the given response.
    pub fn count_response(&mut self, response: &Response) {
        match *response {
            Response::GetSuccess(..) => self.msg_get_success += 1,
            Response::GetFailure { .. } => self.msg_get_failure += 1,
            Response::PutSuccess(..) => self.msg_put_success += 1,
            Response::PutFailure { .. } => self.msg_put_failure += 1,
            Response::PostSuccess(..) => self.msg_post_success += 1,
            Response::PostFailure { .. } => self.msg_post_failure += 1,
            Response::DeleteSuccess(..) => self.msg_delete_success += 1,
            Response::DeleteFailure { .. } => self.msg_delete_failure += 1,
            Response::GetAccountInfoSuccess { .. } => self.msg_get_account_info_success += 1,
            Response::GetAccountInfoFailure { .. } => self.msg_get_account_info_failure += 1,
        }
        self.increment_msg_total();
    }

    /// Increments the counter for the given routing message type.
    pub fn count_routing_message(&mut self, msg: &RoutingMessage) {
        match msg.content {
            MessageContent::GetNodeName { .. } => self.msg_get_node_name += 1,
            MessageContent::ExpectCloseNode { .. } => self.msg_expect_close_node += 1,
            MessageContent::GetCloseGroup(..) => self.msg_get_close_group += 1,
            MessageContent::ConnectionInfo { .. } => self.msg_connection_info += 1,
            MessageContent::GetCloseGroupResponse { .. } => self.msg_get_close_group_rsp += 1,
            MessageContent::GetNodeNameResponse { .. } => self.msg_get_node_name_rsp += 1,
            MessageContent::Ack(..) => self.msg_ack += 1,
            MessageContent::GroupMessageHash(..) => self.msg_hash += 1,
            MessageContent::UserMessagePart { .. } => return, // Counted as request/response.
        }
        self.increment_msg_total();
    }

    /// Increments the counter for the given direct message type.
    pub fn count_direct_message(&mut self, msg: &DirectMessage) {
        match *msg {
            DirectMessage::NodeIdentify { .. } => self.msg_direct_node_identify += 1,
            DirectMessage::NewNode(_) => self.msg_direct_new_node += 1,
            DirectMessage::ConnectionUnneeded(..) => self.msg_direct_connection_unneeded += 1,
            _ => self.msg_other += 1,
        }
        self.increment_msg_total();
    }

    pub fn count_bytes(&mut self, len: usize) {
        self.msg_total_bytes += len as u64;
    }

    /// Increment the total message count, and if divisible by 100, log a message with the counts.
    fn increment_msg_total(&mut self) {
        self.msg_total += 1;
        if self.msg_total % MSG_LOG_COUNT == 0 {
            info!("Stats - Sent {} messages in total, comprising {} bytes, {} uncategorised, \
                  routes/failed: {:?}/{}",
                  self.msg_total,
                  self.msg_total_bytes,
                  self.msg_other,
                  self.routes,
                  self.unacked_msgs);
            info!("Stats - Direct - NodeIdentify: {}, NewNode: {}, ConnectionUnneeded: {}",
                  self.msg_direct_node_identify,
                  self.msg_direct_new_node,
                  self.msg_direct_connection_unneeded);
            info!("Stats - Hops (Request/Response) - GetNodeName: {}/{}, ExpectCloseNode: {}, \
                   GetCloseGroup: {}/{}, ConnectionInfo: {}, Ack: {}, GroupMessageHash: {}",
                  self.msg_get_node_name,
                  self.msg_get_node_name_rsp,
                  self.msg_expect_close_node,
                  self.msg_get_close_group,
                  self.msg_get_close_group_rsp,
                  self.msg_connection_info,
                  self.msg_ack,
                  self.msg_hash);
            info!("Stats - User (Request/Success/Failure) - Get: {}/{}/{}, Put: {}/{}/{}, \
                   Post: {}/{}/{}, Delete: {}/{}/{}, GetAccountInfo: {}/{}/{}, Refresh: {}",
                  self.msg_get,
                  self.msg_get_success,
                  self.msg_get_failure,
                  self.msg_put,
                  self.msg_put_success,
                  self.msg_put_failure,
                  self.msg_post,
                  self.msg_post_success,
                  self.msg_post_failure,
                  self.msg_delete,
                  self.msg_delete_success,
                  self.msg_delete_failure,
                  self.msg_get_account_info,
                  self.msg_get_account_info_success,
                  self.msg_get_account_info_failure,
                  self.msg_refresh);
        }
    }
}