tari_comms 5.3.0-pre.10

A peer-to-peer messaging system
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

//  Copyright 2021, The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use once_cell::sync::Lazy;
#[cfg(feature = "metrics")]
use tari_metrics::{Histogram, HistogramVec, IntCounter, IntCounterVec, IntGauge, IntGaugeVec};

use crate::protocol::{
    ProtocolId,
    rpc::{RpcServerError, RpcStatusCode},
};

pub fn num_sessions(protocol: &ProtocolId) -> IntGauge {
    static METER: Lazy<IntGaugeVec> = Lazy::new(|| {
        tari_metrics::register_int_gauge_vec(
            "comms::rpc::server::num_sessions",
            "The number of active server sessions per protocol",
            &["protocol"],
        )
        .unwrap()
    });

    METER.with_label_values(&[String::from_utf8_lossy(protocol).as_ref()])
}

pub fn handshake_error_counter(protocol: &ProtocolId) -> IntCounter {
    static METER: Lazy<IntCounterVec> = Lazy::new(|| {
        tari_metrics::register_int_counter_vec(
            "comms::rpc::server::handshake_error_count",
            "The number of handshake errors per protocol",
            &["protocol"],
        )
        .unwrap()
    });

    METER.with_label_values(&[String::from_utf8_lossy(protocol).as_ref()])
}

pub fn error_counter(protocol: &ProtocolId, err: &RpcServerError) -> IntCounter {
    static METER: Lazy<IntCounterVec> = Lazy::new(|| {
        tari_metrics::register_int_counter_vec(
            "comms::rpc::server::error_count",
            "The number of RPC errors per protocol",
            &["protocol", "error"],
        )
        .unwrap()
    });

    METER.with_label_values(&[
        String::from_utf8_lossy(protocol).as_ref(),
        err.to_debug_string().as_str(),
    ])
}

pub fn status_error_counter(protocol: &ProtocolId, status_code: RpcStatusCode) -> IntCounter {
    static METER: Lazy<IntCounterVec> = Lazy::new(|| {
        tari_metrics::register_int_counter_vec(
            "comms::rpc::server::status_error_count",
            "The number of RPC errors by status code per protocol",
            &["protocol", "status"],
        )
        .unwrap()
    });

    METER.with_label_values(&[
        String::from_utf8_lossy(protocol).as_ref(),
        status_code.to_debug_string().as_str(),
    ])
}

pub fn inbound_requests_bytes(protocol: &ProtocolId) -> Histogram {
    static METER: Lazy<HistogramVec> = Lazy::new(|| {
        tari_metrics::register_histogram_vec(
            "comms::rpc::server::inbound_request_bytes",
            "Avg. request bytes per protocol",
            &["protocol"],
        )
        .unwrap()
    });

    METER.with_label_values(&[String::from_utf8_lossy(protocol).as_ref()])
}

pub fn outbound_response_bytes(protocol: &ProtocolId) -> Histogram {
    static METER: Lazy<HistogramVec> = Lazy::new(|| {
        tari_metrics::register_histogram_vec(
            "comms::rpc::server::outbound_response_bytes",
            "Avg. response bytes per protocol",
            &["protocol"],
        )
        .unwrap()
    });

    METER.with_label_values(&[String::from_utf8_lossy(protocol).as_ref()])
}