polkadot_overseer/

metrics.rs

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

//! Prometheus metrics related to the overseer and its channels.

use super::*;
pub use polkadot_node_metrics::metrics::{self, prometheus, Metrics as MetricsTrait};

/// Overseer Prometheus metrics.
#[derive(Clone)]
struct MetricsInner {
	activated_heads_total: prometheus::Counter<prometheus::U64>,
	deactivated_heads_total: prometheus::Counter<prometheus::U64>,
	messages_relayed_total: prometheus::Counter<prometheus::U64>,

	to_subsystem_bounded_tof: prometheus::HistogramVec,
	to_subsystem_bounded_sent: prometheus::GaugeVec<prometheus::U64>,
	to_subsystem_bounded_received: prometheus::GaugeVec<prometheus::U64>,
	to_subsystem_bounded_blocked: prometheus::GaugeVec<prometheus::U64>,

	to_subsystem_unbounded_tof: prometheus::HistogramVec,
	to_subsystem_unbounded_sent: prometheus::GaugeVec<prometheus::U64>,
	to_subsystem_unbounded_received: prometheus::GaugeVec<prometheus::U64>,

	signals_sent: prometheus::GaugeVec<prometheus::U64>,
	signals_received: prometheus::GaugeVec<prometheus::U64>,

	#[cfg(any(target_os = "linux", feature = "jemalloc-allocator"))]
	memory_stats_resident: prometheus::Gauge<prometheus::U64>,
	#[cfg(any(target_os = "linux", feature = "jemalloc-allocator"))]
	memory_stats_allocated: prometheus::Gauge<prometheus::U64>,
}

/// A shareable metrics type for usage with the overseer.
#[derive(Default, Clone)]
pub struct Metrics(Option<MetricsInner>);

impl Metrics {
	pub(crate) fn on_head_activated(&self) {
		if let Some(metrics) = &self.0 {
			metrics.activated_heads_total.inc();
		}
	}

	pub(crate) fn on_head_deactivated(&self) {
		if let Some(metrics) = &self.0 {
			metrics.deactivated_heads_total.inc();
		}
	}

	pub(crate) fn on_message_relayed(&self) {
		if let Some(metrics) = &self.0 {
			metrics.messages_relayed_total.inc();
		}
	}

	#[cfg(any(target_os = "linux", feature = "jemalloc-allocator"))]
	pub(crate) fn memory_stats_snapshot(
		&self,
		memory_stats: memory_stats::MemoryAllocationSnapshot,
	) {
		if let Some(metrics) = &self.0 {
			metrics.memory_stats_allocated.set(memory_stats.allocated as u64);
			metrics.memory_stats_resident.set(memory_stats.resident as u64);
		}
	}

	pub(crate) fn channel_metrics_snapshot(
		&self,
		collection: impl IntoIterator<Item = (&'static str, SubsystemMeterReadouts)>,
	) {
		if let Some(metrics) = &self.0 {
			collection
				.into_iter()
				.for_each(|(name, readouts): (_, SubsystemMeterReadouts)| {
					metrics
						.to_subsystem_bounded_sent
						.with_label_values(&[name])
						.set(readouts.bounded.sent as u64);

					metrics
						.to_subsystem_bounded_received
						.with_label_values(&[name])
						.set(readouts.bounded.received as u64);

					metrics
						.to_subsystem_bounded_blocked
						.with_label_values(&[name])
						.set(readouts.bounded.blocked as u64);

					metrics
						.to_subsystem_unbounded_sent
						.with_label_values(&[name])
						.set(readouts.unbounded.sent as u64);

					metrics
						.to_subsystem_unbounded_received
						.with_label_values(&[name])
						.set(readouts.unbounded.received as u64);

					metrics
						.signals_sent
						.with_label_values(&[name])
						.set(readouts.signals.sent as u64);

					metrics
						.signals_received
						.with_label_values(&[name])
						.set(readouts.signals.received as u64);

					let hist_bounded = metrics.to_subsystem_bounded_tof.with_label_values(&[name]);
					for tof in readouts.bounded.tof {
						hist_bounded.observe(tof.as_f64());
					}

					let hist_unbounded =
						metrics.to_subsystem_unbounded_tof.with_label_values(&[name]);
					for tof in readouts.unbounded.tof {
						hist_unbounded.observe(tof.as_f64());
					}
				});
		}
	}
}

impl MetricsTrait for Metrics {
	fn try_register(registry: &prometheus::Registry) -> Result<Self, prometheus::PrometheusError> {
		let metrics = MetricsInner {
			activated_heads_total: prometheus::register(
				prometheus::Counter::new(
					"polkadot_parachain_activated_heads_total",
					"Number of activated heads.",
				)?,
				registry,
			)?,
			deactivated_heads_total: prometheus::register(
				prometheus::Counter::new(
					"polkadot_parachain_deactivated_heads_total",
					"Number of deactivated heads.",
				)?,
				registry,
			)?,
			messages_relayed_total: prometheus::register(
				prometheus::Counter::new(
					"polkadot_parachain_messages_relayed_total",
					"Number of messages relayed by Overseer.",
				)?,
				registry,
			)?,
			to_subsystem_bounded_tof: prometheus::register(
				prometheus::HistogramVec::new(
					prometheus::HistogramOpts::new(
						"polkadot_parachain_subsystem_bounded_tof",
						"Duration spent in a particular channel from entrance to removal",
					)
					.buckets(vec![
						0.0001, 0.0004, 0.0016, 0.0064, 0.0256, 0.1024, 0.4096, 1.6384, 3.2768,
						4.9152, 6.5536,
					]),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			to_subsystem_bounded_sent: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_subsystem_bounded_sent",
						"Number of elements sent to subsystems' bounded queues",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			to_subsystem_bounded_received: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_subsystem_bounded_received",
						"Number of elements received by subsystems' bounded queues",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			to_subsystem_bounded_blocked: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_subsystem_bounded_blocked",
						"Number of times senders blocked while sending messages to a subsystem",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			to_subsystem_unbounded_tof: prometheus::register(
				prometheus::HistogramVec::new(
					prometheus::HistogramOpts::new(
						"polkadot_parachain_subsystem_unbounded_tof",
						"Duration spent in a particular channel from entrance to removal",
					)
					.buckets(vec![
						0.0001, 0.0004, 0.0016, 0.0064, 0.0256, 0.1024, 0.4096, 1.6384, 3.2768,
						4.9152, 6.5536,
					]),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			to_subsystem_unbounded_sent: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_subsystem_unbounded_sent",
						"Number of elements sent to subsystems' unbounded queues",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			to_subsystem_unbounded_received: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_subsystem_unbounded_received",
						"Number of elements received by subsystems' unbounded queues",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			signals_sent: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_overseer_signals_sent",
						"Number of signals sent by overseer to subsystems",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			signals_received: prometheus::register(
				prometheus::GaugeVec::<prometheus::U64>::new(
					prometheus::Opts::new(
						"polkadot_parachain_overseer_signals_received",
						"Number of signals received by subsystems from overseer",
					),
					&["subsystem_name"],
				)?,
				registry,
			)?,
			#[cfg(any(target_os = "linux", feature = "jemalloc-allocator"))]
			memory_stats_allocated: prometheus::register(
				prometheus::Gauge::<prometheus::U64>::new(
					"polkadot_memory_allocated",
					"Total bytes allocated by the node",
				)?,
				registry,
			)?,
			#[cfg(any(target_os = "linux", feature = "jemalloc-allocator"))]
			memory_stats_resident: prometheus::register(
				prometheus::Gauge::<prometheus::U64>::new(
					"polkadot_memory_resident",
					"Bytes allocated by the node, and held in RAM",
				)?,
				registry,
			)?,
		};
		Ok(Metrics(Some(metrics)))
	}
}

impl fmt::Debug for Metrics {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		f.write_str("Metrics {{...}}")
	}
}