Introduce Prometheus metric endpoint replacing Grafana endpoint (#4981)

* Refactor rebase master prometheus_v0.3 * Milestone1: Final Version of v0.3 * no-std or warm compatibility issues, grapana-data -source code reference and correction,applicable * Cargo.lock paritytech/master rebase * prometheus networking.rs del, grafana-data-source networking.rs pub edit and note * chore: reflect various feedback * Spaces to tabs. * Replace grafana and tidy * Add generics * Add photo back * Re-fix spaces in primitives/consensus/babe/src/inherents.rs * Refactor rebase master prometheus_v0.3 * Milestone1: Final Version of v0.3 * no-std or warm compatibility issues, grapana-data -source code reference and correction,applicable * prometheus networking.rs del, grafana-data-source networking.rs pub edit and note * chore: reflect various feedback * Replace grafana and tidy * Add generics * Add photo back * Re-fix spaces in primitives/consensus/babe/src/inherents.rs * chore: revert this file back to paritytech/master inherents.rs. * Add newline at EOF * Tidy * Use local registry * fix typo Co-Authored-By: Max Inden <mail@max-inden.de> * chore: Apply review feedback * endpoint -> exporter * fix readme * Remove lazy_static, use ServiceMetrics struct instead * Switch to using GaugeVecs * chore: without nightly , edit README * block_height -> block_height_number * Switch to a ready_transactions_number gauge * Update utils/prometheus/src/lib.rs Co-Authored-By: Max Inden <mail@max-inden.de> * no-prometheus flag add * /metrics url Input check * remove prometheus in Tracing * remove prometheus in Tracing * chore: master code rebase edit * gitlab-check-web-wasm edit code * From:from and cargo.lock update * with_prometheus_registry add background_tasks * utils/prometheus/src/lib.rs: Restructure #[cfg] for wasm without hyper Given that Hyper is not compatible with WASM targets it needs to be excluded from WASM builds. Instead of introducing #[cfg] lines throughout the crate, this patch splits the crate into two: known_os and unknown_os (WASM). * utils/prometheus/src/lib.rs: Feature gate known_os module * client/cli/src/lib.rs: Re-add newline at end of file Co-authored-by: JeseonLEE <zeroday26@gmail.com> Co-authored-by: Gavin Wood <github@gavwood.com> Co-authored-by: Ashley <ashley.ruglys@gmail.com> Co-authored-by: Hyungsuk Kang <hskang9@gmail.com>
2026-06-12 07:41:08 +00:00 · 2020-02-19 15:36:24 +01:00
parent e417f986be
commit d8230ecf4b
22 changed files with 409 additions and 648 deletions
@@ -0,0 +1,144 @@
+// Copyright 2019 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+use futures_util::{FutureExt, future::Future};
+pub use prometheus::{
+	Registry, Error as PrometheusError, Opts,
+	core::{
+		GenericGauge as Gauge, GenericCounter as Counter,
+		GenericGaugeVec as GaugeVec, GenericCounterVec as CounterVec,
+		AtomicF64 as F64, AtomicI64 as I64, AtomicU64 as U64,
+	}
+};
+use prometheus::{Encoder, TextEncoder, core::Collector};
+use std::net::SocketAddr;
+
+#[cfg(not(target_os = "unknown"))]
+mod networking;
+
+#[cfg(target_os = "unknown")]
+pub use unknown_os::init_prometheus;
+#[cfg(not(target_os = "unknown"))]
+pub use known_os::init_prometheus;
+
+pub fn register<T: Clone + Collector + 'static>(metric: T, registry: &Registry) -> Result<T, PrometheusError> {
+	registry.register(Box::new(metric.clone()))?;
+	Ok(metric)
+}
+
+// On WASM `init_prometheus` becomes a no-op.
+#[cfg(target_os = "unknown")]
+mod unknown_os {
+	use super::*;
+
+	pub enum Error {}
+
+	pub async fn init_prometheus(_: SocketAddr, _registry: Registry) -> Result<(), Error> {
+		Ok(())
+	}
+}
+
+#[cfg(not(target_os = "unknown"))]
+mod known_os {
+	use super::*;
+	use hyper::http::StatusCode;
+	use hyper::{Server, Body, Request, Response, service::{service_fn, make_service_fn}};
+
+	#[derive(Debug, derive_more::Display, derive_more::From)]
+	pub enum Error {
+		/// Hyper internal error.
+		Hyper(hyper::Error),
+		/// Http request error.
+		Http(hyper::http::Error),
+		/// i/o error.
+		Io(std::io::Error),
+		#[display(fmt = "Prometheus exporter 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::PortInUse(_) => None
+			}
+		}
+	}
+
+	async fn request_metrics(req: Request<Body>, registry: Registry) -> Result<Response<Body>, Error> {
+		if req.uri().path() == "/metrics" {
+			let metric_families = registry.gather();
+			let mut buffer = vec![];
+			let encoder = TextEncoder::new();
+			encoder.encode(&metric_families, &mut buffer).unwrap();
+
+			Response::builder().status(StatusCode::OK)
+				.header("Content-Type", encoder.format_type())
+				.body(Body::from(buffer))
+				.map_err(Error::Http)
+		} else {
+			Response::builder().status(StatusCode::NOT_FOUND)
+				.body(Body::from("Not found."))
+				.map_err(Error::Http)
+		}
+
+	}
+
+	#[derive(Clone)]
+	pub struct Executor;
+
+	impl<T> hyper::rt::Executor<T> for Executor
+	where
+		T: Future + Send + 'static,
+		T::Output: Send + 'static,
+	{
+		fn execute(&self, future: T) {
+			async_std::task::spawn(future);
+		}
+	}
+
+	/// Initializes the metrics context, and starts an HTTP server
+	/// to serve metrics.
+	pub async fn init_prometheus(prometheus_addr: SocketAddr, registry: Registry) -> Result<(), Error>{
+		use networking::Incoming;
+		let listener = async_std::net::TcpListener::bind(&prometheus_addr)
+			.await
+			.map_err(|_| Error::PortInUse(prometheus_addr))?;
+
+		log::info!("Prometheus server started at {}", prometheus_addr);
+
+		let service = make_service_fn(move |_| {
+			let registry = registry.clone();
+
+			async move {
+				Ok::<_, hyper::Error>(service_fn(move |req: Request<Body>| {
+					request_metrics(req, registry.clone())
+				}))
+			}
+		});
+
+		let server = Server::builder(Incoming(listener.incoming()))
+			.executor(Executor)
+			.serve(service)
+			.boxed();
+
+		let result = server.await.map_err(Into::into);
+
+		result
+	}
+}
@@ -0,0 +1,66 @@
+// Copyright 2019-2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+use async_std::pin::Pin;
+use std::task::{Poll, Context};
+use futures_util::{stream::Stream, io::{AsyncRead, AsyncWrite}};
+
+pub struct Incoming<'a>(pub async_std::net::Incoming<'a>);
+
+impl hyper::server::accept::Accept for Incoming<'_> {
+	type Conn = TcpStream;
+	type Error = async_std::io::Error;
+
+	fn poll_accept(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Result<Self::Conn, Self::Error>>> {
+		Pin::new(&mut Pin::into_inner(self).0)
+			.poll_next(cx)
+			.map(|opt| opt.map(|res| res.map(TcpStream)))
+	}
+}
+
+pub struct TcpStream(pub async_std::net::TcpStream);
+
+impl tokio::io::AsyncRead for TcpStream {
+	fn poll_read(
+		self: Pin<&mut Self>,
+		cx: &mut Context,
+		buf: &mut [u8]
+	) -> Poll<Result<usize, std::io::Error>> {
+		Pin::new(&mut Pin::into_inner(self).0)
+			.poll_read(cx, buf)
+	}
+}
+
+impl tokio::io::AsyncWrite for TcpStream {
+	fn poll_write(
+		self: Pin<&mut Self>,
+		cx: &mut Context,
+		buf: &[u8]
+	) -> Poll<Result<usize, std::io::Error>> {
+		Pin::new(&mut Pin::into_inner(self).0)
+			.poll_write(cx, buf)
+	}
+
+	fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), std::io::Error>> {
+		Pin::new(&mut Pin::into_inner(self).0)
+			.poll_flush(cx)
+	}
+
+	fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), std::io::Error>> {
+		Pin::new(&mut Pin::into_inner(self).0)
+			.poll_close(cx)
+	}
+}