sc-network 0.56.0

Substrate network protocol
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

// This file is part of Substrate.

// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Metrics for [`RequestResponseProtocol`](super::RequestResponseProtocol).

use crate::{service::metrics::Metrics, types::ProtocolName};

use std::time::Duration;

/// Request-response metrics.
pub struct RequestResponseMetrics {
	/// Metrics.
	metrics: Option<Metrics>,

	/// Protocol name.
	protocol: ProtocolName,
}

impl RequestResponseMetrics {
	pub fn new(metrics: Option<Metrics>, protocol: ProtocolName) -> Self {
		Self { metrics, protocol }
	}

	/// Register inbound request failure to Prometheus
	pub fn register_inbound_request_failure(&self, reason: &str) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_in_failure_total
				.with_label_values(&[&self.protocol, reason])
				.inc();
		}
	}

	/// Register inbound request success to Prometheus
	pub fn register_inbound_request_success(&self, serve_time: Duration) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_in_success_total
				.with_label_values(&[&self.protocol])
				.observe(serve_time.as_secs_f64());
		}
	}

	/// Register inbound request failure to Prometheus
	pub fn register_outbound_request_failure(&self, reason: &str) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_out_failure_total
				.with_label_values(&[&self.protocol, reason])
				.inc();
		}
	}

	/// Register inbound request success to Prometheus
	pub fn register_outbound_request_success(&self, duration: Duration) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_out_success_total
				.with_label_values(&[&self.protocol])
				.observe(duration.as_secs_f64());
		}
	}

	/// Register inbound bytes (request payload received from peer) to Prometheus
	pub fn register_inbound_request_bytes(&self, bytes: usize) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_response_bytes_total
				.with_label_values(&["in", &self.protocol])
				.inc_by(bytes as u64);
		}
	}

	/// Register outbound bytes (response payload sent to peer) to Prometheus
	pub fn register_outbound_response_bytes(&self, bytes: usize) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_response_bytes_total
				.with_label_values(&["out", &self.protocol])
				.inc_by(bytes as u64);
		}
	}

	/// Register outbound bytes (request payload sent to peer) to Prometheus
	pub fn register_outbound_request_bytes(&self, bytes: usize) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_response_bytes_total
				.with_label_values(&["out", &self.protocol])
				.inc_by(bytes as u64);
		}
	}

	/// Register inbound bytes (response payload received from peer) to Prometheus
	pub fn register_inbound_response_bytes(&self, bytes: usize) {
		if let Some(metrics) = &self.metrics {
			metrics
				.requests_response_bytes_total
				.with_label_values(&["in", &self.protocol])
				.inc_by(bytes as u64);
		}
	}
}