chore: reflect various feedback

paritytech · nodebreaker0-0 · Nov 28, 2019 · Dec 10, 2019 · Jan 2, 2020 · Jan 2, 2020
commit f3e444ec1c5bd699fff1bb7bcbca126a69b409f9
diff --git a/client/service/src/config.rs b/client/service/src/config.rs
@@ -75,7 +75,7 @@ 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
+	/// Prometheus Port.`None` if disabled and port 33333 by default.
 	pub prometheus_port: Option<SocketAddr>,
 	/// Telemetry service URL. `None` if disabled.
 	pub telemetry_endpoints: Option<TelemetryEndpoints>,

diff --git a/utils/prometheus/Cargo.toml b/utils/prometheus/Cargo.toml
@@ -17,4 +17,4 @@ 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"] }
+async-std = { version = "1.0.1", features = ["unstable"] }
diff --git a/utils/prometheus/README.md b/utils/prometheus/README.md
@@ -2,12 +2,12 @@
 ![grants](./photo_2019-12-13_16-32-53.jpg)
 ## 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 exporter in substrate, node operators can easily adopt widely used display/alert tool such as Grafana without seting-up/operating external Prometheus agent through RPC connections. Easy access to such monitoring tools will benefit parachain develepers/operators and validators to have much higher availability quality of their services.
+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.
 
-## List of Contents
+## Table of Contents
 
 Hack Prometheus in Substrate
- - Prometheus starter
+ - Prometheus primer
  - CLI Config
  - Metrics Add
 
@@ -23,11 +23,11 @@ Start Grafana
  - Install Grafana
 
 ## Substrate Dev hack
-### Prometheus starter
+### Prometheus primer
 
 Here is the entry point of prometheus core module in Parity Substrate.
 
-In existing sources, refer to the grapana source due to the issue of the wasm.
+In existing sources, refer to the Grafana source due to the issue of the wasm.
 
 utils/prometheus/src/lib.rs
 ```rust
@@ -74,13 +74,11 @@ async fn request_metrics(req: Request<Body>) -> Result<Response<Body>, Error> {
       .header("Content-Type", encoder.format_type())
       .body(Body::from(buffer))
       .map_err(Error::Http)
-      //.expect("Sends OK(200) response with one or more data metrics")
   } else {
     Response::builder()
       .status(StatusCode::NOT_FOUND)
       .body(Body::from("Not found."))
       .map_err(Error::Http)
-      //.expect("Sends NOT_FOUND(404) message with no data metric")
   }
 
 }
@@ -168,18 +166,7 @@ macro_rules! prometheus_histogram(
   }
 );
 
-/*
-TODO: Make abstract type for all metrics(e.g. Gauge, Histogram, Counter) with generic traits so that all metrics can be set up with one function `set`
-#[macro_export]
-macro_rules! prometheus(
-  ($($a: expr; $metric:expr => $value:expr),*) => {
-    use $crate::{metrics::*};
-    $(
-        metrics::set(#$a, &$metric, $value);
-    )*
-  }
-);
-*/
+
 ```
 
 
@@ -338,7 +325,7 @@ client/service/src/config.rs
 #[derive(Clone)]
 pub struct Configuration<C, G, E = NoExtension> {
     ...
-	/// Promteheus Port. `None` if disabled. and defult port 33333
+	/// Prometheus Port.`None` if disabled and port 33333 by default.
 	pub prometheus_port: Option<SocketAddr>,
     ...
 }
@@ -392,7 +379,6 @@ lazy_static! {
     pub static ref FINALITY_HEIGHT: Result<IntGauge> = try_create_int_gauge(
         "consensus_finality_block_height_number",
         "block is finality HEIGHT"
-
     );
 }
 ```

diff --git a/utils/prometheus/src/lib.rs b/utils/prometheus/src/lib.rs
@@ -60,13 +60,11 @@ async fn request_metrics(req: Request<Body>) -> Result<Response<Body>, Error> {
       .header("Content-Type", encoder.format_type())
       .body(Body::from(buffer))
       .map_err(Error::Http)
-      //.expect("Sends OK(200) response with one or more data metrics")
   } else {
     Response::builder()
       .status(StatusCode::NOT_FOUND)
       .body(Body::from("Not found."))
       .map_err(Error::Http)
-      //.expect("Sends NOT_FOUND(404) message with no data metric")
   }
 
 }
@@ -152,16 +150,3 @@ macro_rules! prometheus_histogram(
     )*
   }
 );
-
-/*
-TODO: Make abstract type for all metrics(e.g. Gauge, Histogram, Counter) with generic traits so that all metrics can be set up with one function `set`
-#[macro_export]
-macro_rules! prometheus(
-  ($($a: expr; $metric:expr => $value:expr),*) => {
-    use $crate::{metrics::*};
-    $(
-        metrics::set(#$a, &$metric, $value);
-    )*
-  }
-);
-*/
diff --git a/utils/prometheus/src/metrics.rs b/utils/prometheus/src/metrics.rs
@@ -32,65 +32,69 @@ pub fn try_create_histogram(name: &str, help: &str) -> Result<Histogram> {
     Ok(histogram)
 }
 
-///Gauge Metrics a value in injection.
+/// Gauge Metrics a value in injection.
 pub fn set_gauge(gauge: &Result<IntGauge>, value: u64) {
     if let Ok(gauge) = gauge {
         gauge.set(value as i64);
     }
 }
-///histogram Metrics a value in injection.
+/// histogram Metrics a value in injection.
 pub fn set_histogram(histogram: &Result<Histogram>, value: f64) {
     if let Ok(histogram) = histogram {
         histogram.observe(value)
     }
 }
-//All of the metrics in the prometheus are managed by the lazy_static.
+/// All of the metrics in the prometheus are managed by the lazy_static.
 
 lazy_static! {
     pub static ref FINALITY_HEIGHT: Result<IntGauge> = try_create_int_gauge(
         "consensus_finality_block_height_number",
         "block is finality HEIGHT"
 
     );
+
     pub static ref BEST_HEIGHT: Result<IntGauge> = try_create_int_gauge(
         "consensus_best_block_height_number",
         "block is best HEIGHT"
     );
 
-    pub static ref BLOCK_INTERVAL_SECONDS: Result<Histogram> = try_create_histogram(
-        "consensus_block_interval_seconds",
-        "Time between this and last block(Block.Header.Time) in seconds"
-    );
     pub static ref P2P_PEERS_NUM: Result<IntGauge> = try_create_int_gauge(
         "p2p_peers_number",
         "network gosip peers number"
     );
+
     pub static ref TARGET_NUM: Result<IntGauge> = try_create_int_gauge(
         "consensus_target_syn_number",
         "block syn target number"
     );
+
     pub static ref TX_COUNT: Result<IntGauge> = try_create_int_gauge(
         "consensus_num_txs",
         "Number of transactions"
     );
+
     pub static ref NODE_MEMORY: Result<IntGauge> = try_create_int_gauge(
         "consensus_node_memory",
         "node memory"
     );
+
     pub static ref NODE_CPU: Result<IntGauge> = try_create_int_gauge(
         "consensus_node_cpu",
         "node cpu"
     );
+
     pub static ref STATE_CACHE_SIZE: Result<IntGauge> = try_create_int_gauge(
         "consensus_state_cache_size",
         "used state cache size"
     );
+
     pub static ref P2P_NODE_DOWNLOAD: Result<IntGauge> = try_create_int_gauge(
         "p2p_peers_receive_byte_per_sec",
         "p2p_node_download_per_sec_byte"
     );
+
     pub static ref P2P_NODE_UPLOAD: Result<IntGauge> = try_create_int_gauge(
         "p2p_peers_send_byte_per_sec",
         "p2p_node_upload_per_sec_byte"
     );
-}
+}