referrerpolicy=no-referrer-when-downgrade
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

// Copyright (C) Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

use polkadot_node_subsystem::prometheus::Opts;
use polkadot_node_subsystem_util::metrics::{
	self,
	prometheus::{self, Gauge, GaugeVec, U64},
};

#[derive(Clone)]
pub(crate) struct MetricsInner {
	time_active_leaves_update: prometheus::Histogram,
	time_introduce_seconded_candidate: prometheus::Histogram,
	time_candidate_backed: prometheus::Histogram,
	time_hypothetical_membership: prometheus::Histogram,
	candidate_count: prometheus::GaugeVec<U64>,
	active_leaves_count: prometheus::GaugeVec<U64>,
	implicit_view_candidate_count: prometheus::Gauge<U64>,
}

/// Candidate backing metrics.
#[derive(Default, Clone)]
pub struct Metrics(pub(crate) Option<MetricsInner>);

impl Metrics {
	/// Provide a timer for handling `ActiveLeavesUpdate` which observes on drop.
	pub fn time_handle_active_leaves_update(
		&self,
	) -> Option<metrics::prometheus::prometheus::HistogramTimer> {
		self.0.as_ref().map(|metrics| metrics.time_active_leaves_update.start_timer())
	}

	/// Provide a timer for handling `IntroduceSecondedCandidate` which observes on drop.
	pub fn time_introduce_seconded_candidate(
		&self,
	) -> Option<metrics::prometheus::prometheus::HistogramTimer> {
		self.0
			.as_ref()
			.map(|metrics| metrics.time_introduce_seconded_candidate.start_timer())
	}

	/// Provide a timer for handling `CandidateBacked` which observes on drop.
	pub fn time_candidate_backed(&self) -> Option<metrics::prometheus::prometheus::HistogramTimer> {
		self.0.as_ref().map(|metrics| metrics.time_candidate_backed.start_timer())
	}

	/// Provide a timer for handling `GetHypotheticalMembership` which observes on drop.
	pub fn time_hypothetical_membership_request(
		&self,
	) -> Option<metrics::prometheus::prometheus::HistogramTimer> {
		self.0
			.as_ref()
			.map(|metrics| metrics.time_hypothetical_membership.start_timer())
	}

	/// Record number of candidates across all fragment chains. First param is the connected
	/// candidates count, second param is the unconnected candidates count.
	pub fn record_candidate_count(&self, connected_count: u64, unconnected_count: u64) {
		self.0.as_ref().map(|metrics| {
			metrics.candidate_count.with_label_values(&["connected"]).set(connected_count);
			metrics
				.candidate_count
				.with_label_values(&["unconnected"])
				.set(unconnected_count);
		});
	}

	/// Record the number of candidates present in the implicit view of the subsystem.
	pub fn record_candidate_count_in_implicit_view(&self, count: u64) {
		self.0.as_ref().map(|metrics| {
			metrics.implicit_view_candidate_count.set(count);
		});
	}

	/// Record the number of active/inactive leaves kept by the subsystem.
	pub fn record_leaves_count(&self, active_count: u64, inactive_count: u64) {
		self.0.as_ref().map(|metrics| {
			metrics.active_leaves_count.with_label_values(&["active"]).set(active_count);
			metrics.active_leaves_count.with_label_values(&["inactive"]).set(inactive_count);
		});
	}
}

impl metrics::Metrics for Metrics {
	fn try_register(registry: &prometheus::Registry) -> Result<Self, prometheus::PrometheusError> {
		let metrics = MetricsInner {
			time_active_leaves_update: prometheus::register(
				prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
					"polkadot_parachain_prospective_parachains_time_active_leaves_update",
					"Time spent within `prospective_parachains::handle_active_leaves_update`",
				))?,
				registry,
			)?,
			time_introduce_seconded_candidate: prometheus::register(
				prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
					"polkadot_parachain_prospective_parachains_time_introduce_seconded_candidate",
					"Time spent within `prospective_parachains::handle_introduce_seconded_candidate`",
				))?,
				registry,
			)?,
			time_candidate_backed: prometheus::register(
				prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
					"polkadot_parachain_prospective_parachains_time_candidate_backed",
					"Time spent within `prospective_parachains::handle_candidate_backed`",
				))?,
				registry,
			)?,
			time_hypothetical_membership: prometheus::register(
				prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
					"polkadot_parachain_prospective_parachains_time_hypothetical_membership",
					"Time spent responding to `GetHypotheticalMembership`",
				))?,
				registry,
			)?,
			candidate_count: prometheus::register(
				GaugeVec::new(
					Opts::new(
						"polkadot_parachain_prospective_parachains_candidate_count",
						"Number of candidates present across all fragment chains, split by connected and unconnected"
					),
					&["type"],
				)?,
				registry,
			)?,
			active_leaves_count: prometheus::register(
				GaugeVec::new(
					Opts::new(
						"polkadot_parachain_prospective_parachains_active_leaves_count",
						"Number of leaves kept by the subsystem, split by active/inactive"
					),
					&["type"],
				)?,
				registry,
			)?,
			implicit_view_candidate_count: prometheus::register(
				Gauge::new(
					"polkadot_parachain_prospective_parachains_implicit_view_candidate_count", 
					"Number of candidates present in the implicit view"
				)?,
				registry
			)?,
		};
		Ok(Metrics(Some(metrics)))
	}
}