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

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

//! Metering primitives and globals

use prometheus::{
	core::{AtomicU64, GenericCounter, GenericGauge},
	Error as PrometheusError, Registry,
};
use std::sync::LazyLock;

use prometheus::{
	core::{GenericCounterVec, GenericGaugeVec},
	Opts,
};

pub static TOKIO_THREADS_TOTAL: LazyLock<GenericCounter<AtomicU64>> = LazyLock::new(|| {
	GenericCounter::new("substrate_tokio_threads_total", "Total number of threads created")
		.expect("Creating of statics doesn't fail. qed")
});

pub static TOKIO_THREADS_ALIVE: LazyLock<GenericGauge<AtomicU64>> = LazyLock::new(|| {
	GenericGauge::new("substrate_tokio_threads_alive", "Number of threads alive right now")
		.expect("Creating of statics doesn't fail. qed")
});

pub static UNBOUNDED_CHANNELS_COUNTER: LazyLock<GenericCounterVec<AtomicU64>> =
	LazyLock::new(|| {
		GenericCounterVec::new(
			Opts::new(
				"substrate_unbounded_channel_len",
				"Items sent/received/dropped on each mpsc::unbounded instance",
			),
			&["entity", "action"], // name of channel, send|received|dropped
		)
		.expect("Creating of statics doesn't fail. qed")
	});

pub static UNBOUNDED_CHANNELS_SIZE: LazyLock<GenericGaugeVec<AtomicU64>> = LazyLock::new(|| {
	GenericGaugeVec::new(
		Opts::new(
			"substrate_unbounded_channel_size",
			"Size (number of messages to be processed) of each mpsc::unbounded instance",
		),
		&["entity"], // name of channel
	)
	.expect("Creating of statics doesn't fail. qed")
});

pub static SENT_LABEL: &'static str = "send";
pub static RECEIVED_LABEL: &'static str = "received";
pub static DROPPED_LABEL: &'static str = "dropped";

/// Register the statics to report to registry
pub fn register_globals(registry: &Registry) -> Result<(), PrometheusError> {
	registry.register(Box::new(TOKIO_THREADS_ALIVE.clone()))?;
	registry.register(Box::new(TOKIO_THREADS_TOTAL.clone()))?;
	registry.register(Box::new(UNBOUNDED_CHANNELS_COUNTER.clone()))?;
	registry.register(Box::new(UNBOUNDED_CHANNELS_SIZE.clone()))?;

	Ok(())
}