R4R: prometheus exporter in substrate

Cargo.toml

@@ -48,6 +48,7 @@ members = [
 	"client/telemetry",
 	"client/transaction-pool",
 	"client/transaction-pool/graph",
+	"utils/prometheus",
 	"utils/wasm-builder-runner",
 	"utils/grafana-data-source",
 	"utils/grafana-data-source/test",

client/cli/Cargo.toml

@@ -29,6 +29,7 @@ sp-core = { version = "2.0.0", path = "../../primitives/core" }
 sc-service = { version = "2.0.0", default-features = false, path = "../service" }
 sp-state-machine = { version = "2.0.0", path = "../../primitives/state-machine" }
 sc-telemetry = { version = "2.0.0", path = "../telemetry" }
+sc-prometheus = { path = "../../utils/prometheus" }
 sp-keyring = { version = "2.0.0", path = "../../primitives/keyring" }
 names = "0.11.0"
 structopt = "=0.3.7"

client/cli/src/informant/display.rs

@@ -21,7 +21,7 @@ use sc_network::SyncState;
 use sp_runtime::traits::{Block as BlockT, CheckedDiv, NumberFor, Zero, Saturating};
 use sc_service::NetworkStatus;
 use std::{convert::{TryFrom, TryInto}, fmt, time};
-
+use sc_prometheus::prometheus_gauge;
 /// State of the informant display system.
 ///
 /// This is the system that handles the line that gets regularly printed and that looks something
@@ -63,7 +63,10 @@ impl<B: BlockT> InformantDisplay<B> {
 		let (status, target) = match (net_status.sync_state, net_status.best_seen_block) {
 			(SyncState::Idle, _) => ("Idle".into(), "".into()),
 			(SyncState::Downloading, None) => (format!("Syncing{}", speed), "".into()),
-			(SyncState::Downloading, Some(n)) => (format!("Syncing{}", speed), format!(", target=#{}", n)),
+			(SyncState::Downloading, Some(n)) => {
+				prometheus_gauge!(TARGET_NUM => n.saturated_into().try_into().unwrap());
+				(format!("Syncing{}", speed), format!(", target=#{}", n))
+			}
 		};
 
 		info!(

client/cli/src/lib.rs

@@ -910,6 +910,7 @@ where
 	let rpc_interface: &str = interface_str(cli.rpc_external, cli.unsafe_rpc_external, cli.validator)?;
 	let ws_interface: &str = interface_str(cli.ws_external, cli.unsafe_ws_external, cli.validator)?;
 	let grafana_interface: &str = if cli.grafana_external { "0.0.0.0" } else { "127.0.0.1" };
+	let prometheus_interface: &str = if cli.prometheus_external { "0.0.0.0" } else { "127.0.0.1" };
 
 	config.rpc_http = Some(parse_address(&format!("{}:{}", rpc_interface, 9933), cli.rpc_port)?);
 	config.rpc_ws = Some(parse_address(&format!("{}:{}", ws_interface, 9944), cli.ws_port)?);
@@ -941,7 +942,12 @@ where
 
 	config.tracing_targets = cli.tracing_targets.into();
 	config.tracing_receiver = cli.tracing_receiver.into();
-
+
+	// Override prometheus
+	if cli.prometheus_external {
+			config.prometheus_port = Some(
+		parse_address(&format!("{}:{}", prometheus_interface, 33333), cli.prometheus_port)?
+	)}
 	// Imply forced authoring on --dev
 	config.force_authoring = cli.shared_params.dev || cli.force_authoring;
 

client/cli/src/params.rs

@@ -440,6 +440,12 @@ pub struct RunCmd {
 	/// Use `--unsafe-ws-external` to suppress the warning if you understand the risks.
 	#[structopt(long = "ws-external")]
 	pub ws_external: bool,
+	/// Prometheus exporter TCP port.
+	#[structopt(long = "prometheus-port", value_name = "PORT")]
+	pub prometheus_port: Option<u16>,
+	/// Prometheus exporter on/off external".
+	#[structopt(long = "prometheus-external")]
+	pub prometheus_external: bool,
 
 	/// Listen to all Websocket interfaces.
 	///

client/service/Cargo.toml

@@ -54,6 +54,7 @@ parity-multiaddr = { package = "parity-multiaddr", version = "0.5.0" }
 grafana-data-source = { version = "2.0.0", path = "../../utils/grafana-data-source" }
 sc-tracing = { version = "2.0.0", path = "../tracing" }
 tracing = "0.1.10"
+sc-prometheus = { package = "sc-prometheus", path="../../utils/prometheus"}
 
 [dev-dependencies]
 substrate-test-runtime-client = { version = "2.0.0", path = "../../test-utils/runtime/client" }

client/service/src/builder.rs

@@ -53,6 +53,8 @@ use std::{
 use sysinfo::{get_current_pid, ProcessExt, System, SystemExt};
 use sc_telemetry::{telemetry, SUBSTRATE_INFO};
 use sp_transaction_pool::{TransactionPool, TransactionPoolMaintainer};
+use sc_prometheus::prometheus_gauge;
+
 use sp_blockchain;
 use grafana_data_source::{self, record_metrics};
 
@@ -954,6 +956,17 @@ ServiceBuilder<
 				"bandwidth_upload" => bandwidth_upload,
 				"used_state_cache_size" => used_state_cache_size,
 			);
+			prometheus_gauge!(
+				STATE_CACHE_SIZE => used_state_cache_size as u64,
+				NODE_MEMORY => memory as u64,
+				NODE_CPU => cpu_usage as u64,
+				TX_COUNT => txpool_status.ready as u64,
+				FINALITY_HEIGHT => finalized_number as u64,
+				BEST_HEIGHT => best_number as u64,
+				P2P_PEERS_NUM => num_peers as u64,
+				P2P_NODE_DOWNLOAD => net_status.average_download_per_sec as u64,
+				P2P_NODE_UPLOAD => net_status.average_upload_per_sec as u64
+			  );
 			let _ = record_metrics!(
 				"peers" => num_peers,
 				"height" => best_number,
@@ -964,8 +977,7 @@ ServiceBuilder<
 				"bandwidth_download" => bandwidth_download,
 				"bandwidth_upload" => bandwidth_upload,
 				"used_state_cache_size" => used_state_cache_size,
-			);
-
+			  );
 			Ok(())
 		}).select(exit.clone().map(Ok).compat()).then(|_| Ok(()));
 		let _ = to_spawn_tx.unbounded_send(Box::new(tel_task));
@@ -1103,7 +1115,17 @@ ServiceBuilder<
 				.then(|_| Ok(()))));
 			telemetry
 		});
-
+		// prometheus init
+		if let Some(port) = config.prometheus_port {
+			let future = select(
+					sc_prometheus::init_prometheus(port).boxed()
+					,exit.clone()
+				).map(|either| match either {
+					Either::Left((result, _)) => result.map_err(|_| ()),
+					Either::Right(_) => Ok(())
+				}).compat();
+				let _ = to_spawn_tx.unbounded_send(Box::new(future));
+		}
 		// Grafana data source
 		if let Some(port) = config.grafana_port {
 			let future = select(

client/service/src/config.rs

@@ -75,6 +75,8 @@ pub struct Configuration<C, G, E = NoExtension> {
 	pub rpc_cors: Option<Vec<String>>,
 	/// Grafana data source http port. `None` if disabled.
 	pub grafana_port: Option<SocketAddr>,
+	/// Promteheus Port. `None` if disabled. and defult port 33333
+	pub prometheus_port: Option<SocketAddr>,
 	/// Telemetry service URL. `None` if disabled.
 	pub telemetry_endpoints: Option<TelemetryEndpoints>,
 	/// External WASM transport for the telemetry. If `Some`, when connection to a telemetry
@@ -153,6 +155,7 @@ impl<C, G, E> Configuration<C, G, E> where
 			rpc_ws: None,
 			rpc_ws_max_connections: None,
 			rpc_cors: Some(vec![]),
+			prometheus_port: None,
 			grafana_port: None,
 			telemetry_endpoints: None,
 			telemetry_external_transport: None,

client/service/test/src/lib.rs

@@ -192,6 +192,7 @@ fn node_config<G, E: Clone> (
 		rpc_ws: None,
 		rpc_ws_max_connections: None,
 		rpc_cors: None,
+		prometheus_port: None,
 		grafana_port: None,
 		telemetry_endpoints: None,
 		telemetry_external_transport: None,

utils/grafana-data-source/src/lib.rs

@@ -31,7 +31,7 @@ use parking_lot::RwLock;
 mod types;
 mod server;
 #[cfg(not(target_os = "unknown"))]
-mod networking;
+pub mod networking;
 mod database;
 
 use database::Database;

utils/prometheus/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "sc-prometheus"
+version = "2.0.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+description = "prometheus utils"
+edition = "2018"
+
+[dependencies]
+hyper = { version = "0.13.1", default-features = false, features = ["stream"] }
+lazy_static = "1.4"
+log = "0.4.8"
+prometheus = { version = "0.7", features = ["nightly", "process"]}
+tokio = "0.2"
+futures-util = { version = "0.3.1", default-features = false, features = ["io"] }
+sp-runtime = { package = "sp-runtime",path = "../../primitives/runtime" }
+derive_more = "0.99"
+grafana-data-source = { version = "2.0.0", path = "../grafana-data-source" }
+
+[target.'cfg(not(target_os = "unknown"))'.dependencies]
+async-std = { version = "1.0.1", features = ["unstable"] }