Add block construction prometheus metrics (#6030)

* Add basic authorship metrics * fixes * no arc * move to crate * Update client/proposer-metrics/Cargo.toml Co-authored-by: Max Inden <mail@max-inden.de> * remove prefix * use HistogramTimer * Update client/proposer-metrics/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/basic-authorship/src/basic_authorship.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/basic-authorship/src/basic_authorship.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/basic-authorship/src/basic_authorship.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/basic-authorship/src/basic_authorship.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/basic-authorship/src/basic_authorship.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/proposer-metrics/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/proposer-metrics/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Max Inden <mail@max-inden.de> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2026-06-19 19:21:03 +00:00 · 2020-05-18 16:48:44 +03:00
parent 09a16a30a6
commit dd573374e0
11 changed files with 139 additions and 16 deletions
@@ -0,0 +1,67 @@
+// Copyright 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/>.
+
+//! Prometheus basic proposer metrics.
+
+use prometheus_endpoint::{register, PrometheusError, Registry, Histogram, HistogramOpts, Gauge, U64};
+
+/// Optional shareable link to basic authorship metrics.
+#[derive(Clone, Default)]
+pub struct MetricsLink(Option<Metrics>);
+
+impl MetricsLink {
+	pub fn new(registry: Option<&Registry>) -> Self {
+		Self(
+			registry.and_then(|registry|
+				Metrics::register(registry)
+					.map_err(|err| log::warn!("Failed to register proposer prometheus metrics: {}", err))
+					.ok()
+			)
+		)
+	}
+
+	pub fn report<O>(&self, do_this: impl FnOnce(&Metrics) -> O) -> Option<O> {
+		Some(do_this(self.0.as_ref()?))
+	}
+}
+
+/// Authorship metrics.
+#[derive(Clone)]
+pub struct Metrics {
+    pub block_constructed: Histogram,
+    pub number_of_transactions: Gauge<U64>,
+}
+
+impl Metrics {
+	pub fn register(registry: &Registry) -> Result<Self, PrometheusError> {
+		Ok(Self {
+			block_constructed: register(
+				Histogram::with_opts(HistogramOpts::new(
+					"proposer_block_constructed",
+					"Histogram of time taken to construct new block",
+				))?,
+				registry,
+            )?,
+            number_of_transactions: register(
+                Gauge::new(
+                    "proposer_number_of_transactions",
+                    "Number of transactions included in block",
+                )?,
+                registry,
+            )?,
+		})
+    }
+}