Tidy

client/cli/src/informant/display.rs

@@ -27,8 +27,8 @@ use prometheus_endpoint::{create_gauge, Gauge, U64};
 
 prometheus_endpoint::lazy_static! {
 	pub static ref SYNC_TARGET: Gauge<U64> = create_gauge(
-		"sync_target_number",
-		"block sync target number"
+		"substrate_sync_target_number",
+		"Block sync target number"
 	);
 }
 

client/cli/src/lib.rs

@@ -1049,7 +1049,7 @@ where
 	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)?);
 	config.prometheus_port = Some(
-		parse_address(&format!("{}:{}", prometheus_interface, 9955), cli.prometheus_port)?
+		parse_address(&format!("{}:{}", prometheus_interface, 9615), cli.prometheus_port)?
 	);
 
 	config.rpc_ws_max_connections = cli.ws_max_connections;

client/service/src/builder.rs

@@ -55,36 +55,36 @@ use prometheus_endpoint::{create_gauge, Gauge, U64, F64};
 
 prometheus_endpoint::lazy_static! {
 	pub static ref FINALITY_HEIGHT: Gauge<U64> = create_gauge(
-		"consensus_finality_block_height_number",
-		"block is finality HEIGHT"
+		"substrate_finality_block_height_number",
+		"Height of the highest finalized block"
 	);
 	pub static ref BEST_HEIGHT: Gauge<U64> = create_gauge(
-		"consensus_best_block_height_number",
-		"block is best HEIGHT"
+		"substrate_best_block_height_number",
+		"Height of the highest block"
 	);
-	pub static ref P2P_PEERS_NUM: Gauge<U64> = create_gauge(
-		"p2p_peers_number",
-		"network gosip peers number"
+	pub static ref PEERS_NUM: Gauge<U64> = create_gauge(
+		"substrate_peers_count",
+		"Number of network gossip peers"
 	);
 	pub static ref TX_COUNT: Gauge<U64> = create_gauge(
-		"consensus_num_txs",
+		"substrate_transaction_count",
 		"Number of transactions"
 	);
 	pub static ref NODE_MEMORY: Gauge<U64> = create_gauge(
-		"consensus_node_memory",
-		"node memory"
+		"substrate_memory_usage",
+		"Node memory usage"
 	);
 	pub static ref NODE_CPU: Gauge<F64> = create_gauge(
-		"consensus_node_cpu",
-		"node cpu"
+		"substrate_cpu_usage",
+		"Node CPU usage"
 	);
-	pub static ref P2P_NODE_DOWNLOAD: Gauge<U64> = create_gauge(
-		"p2p_peers_receive_byte_per_sec",
-		"p2p_node_download_per_sec_byte"
+	pub static ref NODE_DOWNLOAD: Gauge<U64> = create_gauge(
+		"substrate_receive_byte_per_sec",
+		"Received bytes per second"
 	);
-	pub static ref P2P_NODE_UPLOAD: Gauge<U64> = create_gauge(
-		"p2p_peers_send_byte_per_sec",
-		"p2p_node_upload_per_sec_byte"
+	pub static ref NODE_UPLOAD: Gauge<U64> = create_gauge(
+		"substrate_sent_byte_per_sec",
+		"Sent bytes per second"
 	);
 }
 /// Aggregator for the components required to build a service.
@@ -1006,9 +1006,9 @@ ServiceBuilder<
 			TX_COUNT.set(txpool_status.ready as u64);
 			FINALITY_HEIGHT.set(finalized_number);
 			BEST_HEIGHT.set(best_number);
-			P2P_PEERS_NUM.set(num_peers as u64);
-			P2P_NODE_DOWNLOAD.set(net_status.average_download_per_sec);
-			P2P_NODE_UPLOAD.set(net_status.average_upload_per_sec);
+			PEERS_NUM.set(num_peers as u64);
+			NODE_DOWNLOAD.set(net_status.average_download_per_sec);
+			NODE_UPLOAD.set(net_status.average_upload_per_sec);
 
 			ready(())
 		});

client/tracing/src/lib.rs

@@ -290,6 +290,6 @@ fn send_telemetry(span_datum: SpanDatum) {
 	);
 }
 
-fn send_prometheus(span_datum: SpanDatum) {
+fn send_prometheus(_span_datum: SpanDatum) {
 	unimplemented!()
 }

utils/prometheus/README.md

@@ -1,8 +1,8 @@
-# Substrate Prometheus Node Exporter
-![grants](./photo_2019-12-13_16-32-53.jpg)
+# Substrate Prometheus Exporter
+
 ## Introduction
 
-Prometheus is one of the most widely used monitoring tool for managing high availability services supported by [Cloud Native Computing Foundation](https://www.cncf.io/). By providing Prometheus metrics in Substrate, node operators can easily adopt widely used display/alert tools such as Grafana and Alertmanager without setting-up/operating external Prometheus push gateways (which is an antipattern in the first place) through RPC connections. Easy access to such monitoring tools will benefit parachain developers/operators and validators to have much higher availability of their services.
+Prometheus is one of the most widely used monitoring tool for managing highly available services supported by [Cloud Native Computing Foundation](https://www.cncf.io/). By providing Prometheus metrics in Substrate, node operators can easily adopt widely used display/alert tools such as Grafana and Alertmanager without setting-up/operating external Prometheus push gateways (which is an antipattern in the first place) through RPC connections. Easy access to such monitoring tools will benefit parachain developers/operators and validators to have much higher availability of their services.
 
 ## Table of Contents
 
@@ -24,37 +24,7 @@ Start Grafana
 
 ## Metrics
 
-substrate can report and serve the Prometheus metrics, which in their turn can be consumed by Prometheus collector(s).
-
-This functionality is disabled by default.
-
-To enable the Prometheus metrics, set in your cli command (--prometheus-addr,--prometheus-port ). 
-Metrics will be served under /metrics on 33333 port by default.
-
-### List of available metrics
-
-
-Consensus metrics, namespace: `substrate`
-
-| **Name**                               | **Type**  | **Tags** | **Description**                                                 |
-| -------------------------------------- | --------- | -------- | --------------------------------------------------------------- |
-| consensus_finality_block_height_number | IntGauge  |          | finality Height of the chain                                    |
-| consensus_best_block_height_number     | IntGauge  |          | best Height of the chain                                        |
-| consensus_target_syn_number            | IntGauge  |          | syning Height target number                                     |
-| consensus_num_txs                      | Gauge     |          | Number of transactions                                          |
-| consensus_node_memory                  | IntGauge  |          | Node's primary memory                                           |
-| consensus_node_cpu                     | IntGauge  |          | Node's cpu load                                                 |
-| consensus_state_cache_size             | IntGauge  |          | used state cache size                             			  |
-| p2p_peers_number                       | IntGauge  |          | Number of peers node's connected to                             |
-| p2p_peer_receive_bytes_per_sec         | IntGauge  |          | number of bytes received from a given peer                      |
-| p2p_peer_send_bytes_per_sec            | IntGauge  |          | number of bytes sent to a given peer                            |
-| Resource_receive_bytes_per_sec(Future) | IntGauge  |          | Operating System of bytes received                              |
-| Resource_send_bytes_per_sec(Future)    | IntGauge  |          | Operating System of bytes sent                                  |
-| Resource_cpu_use(Future)               | IntGauge  |          | Operating System cpu load                                       |
-| Resource_disk_use(Future)              | IntGauge  |          | Operating System disk use                                       |
-| validator_sign_prevote(Future)         | IntGauge  | validator addr | validator sign vote list                               	  |
-| validator_sign_precommit(Future)       | IntGauge  | validator addr | validator sign commit list                                |
-
+Substrate can report and serve the Prometheus metrics, which in turn can be consumed by Prometheus collector(s). Metrics will be served under /metrics on 9615 port by default.
 
 ## Start Prometheus
 ### Install prometheus
@@ -84,7 +54,7 @@ Then edit `prometheus.yml` and add `jobs` :
 ### Start Prometheus
 
 ```bash
-cd <prometheus file>
+cd <prometheus folder>
 ./prometheus
 ```
 

utils/prometheus/src/lib.rs

@@ -43,19 +43,22 @@ pub enum Error {
 	/// Http request error.
 	Http(hyper::http::Error),
 	/// i/o error.
-	Io(std::io::Error)
+	Io(std::io::Error),
+	#[display(fmt = "Prometheus export port {} already in use.", _0)]
+	PortInUse(SocketAddr)
 }
 impl std::error::Error for Error {
 	fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
 		match self {
 			Error::Hyper(error) => Some(error),
 			Error::Http(error) => Some(error),
-			Error::Io(error) => Some(error)
+			Error::Io(error) => Some(error),
+			Error::PortInUse(_) => None
 		}
 	}
 }
 
-async fn request_metrics(req: Request<Body>) -> Result<Response<Body>, Error> {
+async fn request_metrics(_req: Request<Body>) -> Result<Response<Body>, Error> {
 	let metric_families = prometheus::gather();
 	let mut buffer = vec![];
 	let encoder = TextEncoder::new();
@@ -84,40 +87,24 @@ impl<T> hyper::rt::Executor<T> for Executor
 /// Initializes the metrics context, and starts an HTTP server
 /// to serve metrics.
 #[cfg(not(target_os = "unknown"))]
-pub  async fn init_prometheus(mut prometheus_addr: SocketAddr) -> Result<(), Error>{
-	use async_std::{net, io};
+pub  async fn init_prometheus(prometheus_addr: SocketAddr) -> Result<(), Error>{
 	use networking::Incoming;
-	let listener = loop {
-		let listener = net::TcpListener::bind(&prometheus_addr).await;
-		match listener {
-			Ok(listener) => {
-				log::info!("Prometheus server started at {}", prometheus_addr);
-				break listener
-			},
-			Err(err) => match err.kind() {
-				io::ErrorKind::AddrInUse | io::ErrorKind::PermissionDenied if prometheus_addr.port() != 0 => {
-					log::warn!(
-						"Prometheus server to already {} port.", prometheus_addr.port()
-					);
-					prometheus_addr.set_port(0);
-					continue;
-				},
-				_ => return Err(err.into())
-			}
-		}
-	};
+	let listener = async_std::net::TcpListener::bind(&prometheus_addr)
+		.await
+		.map_err(|_| Error::PortInUse(prometheus_addr))?;
+
 	let service = make_service_fn(|_| {
 		async {
 			Ok::<_, Error>(service_fn(request_metrics))
 		}
 	});
 
-	let _server = Server::builder(Incoming(listener.incoming()))
+	let server = Server::builder(Incoming(listener.incoming()))
 		.executor(Executor)
 		.serve(service)
 		.boxed();
 
-	let result = _server.await.map_err(Into::into);
+	let result = server.await.map_err(Into::into);
 
 	result
 }