Unify metric names (#1209)

* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names

bridges/primitives/chain-rococo/src/lib.rs

@@ -44,7 +44,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: sp_version::create_runtime_str!("rococo"),
 	impl_name: sp_version::create_runtime_str!("parity-rococo-v1.6"),
 	authoring_version: 0,
-	spec_version: 9004,
+	spec_version: 9100,
 	impl_version: 0,
 	apis: sp_version::create_apis_vec![[]],
 	transaction_version: 0,

bridges/relays/bin-substrate/src/chains/kusama.rs

@@ -17,6 +17,8 @@
 use codec::Decode;
 use frame_support::weights::{DispatchClass, DispatchInfo, Pays, Weight};
 use relay_kusama_client::Kusama;
+use sp_core::storage::StorageKey;
+use sp_runtime::{FixedPointNumber, FixedU128};
 use sp_version::RuntimeVersion;
 
 use crate::cli::{
@@ -101,3 +103,14 @@ impl CliChain for Kusama {
 		anyhow::bail!("Sending messages from Kusama is not yet supported.")
 	}
 }
+
+/// Storage key and initial value of Polkadot -> Kusama conversion rate.
+pub(crate) fn polkadot_to_kusama_conversion_rate_params() -> (StorageKey, FixedU128) {
+	(
+		bp_runtime::storage_parameter_key(
+			bp_kusama::POLKADOT_TO_KUSAMA_CONVERSION_RATE_PARAMETER_NAME,
+		),
+		// starting relay before this parameter will be set to some value may cause troubles
+		FixedU128::from_inner(FixedU128::DIV),
+	)
+}

bridges/relays/bin-substrate/src/chains/kusama_headers_to_polkadot.rs

@@ -64,10 +64,7 @@ impl SubstrateFinalitySyncPipeline for KusamaFinalityToPolkadot {
 	type TargetChain = Polkadot;
 
 	fn customize_metrics(params: MetricsParams) -> anyhow::Result<MetricsParams> {
-		crate::chains::add_polkadot_kusama_price_metrics::<Self::FinalitySyncPipeline>(
-			Some(finality_relay::metrics_prefix::<Self::FinalitySyncPipeline>()),
-			params,
-		)
+		crate::chains::add_polkadot_kusama_price_metrics::<Self::FinalitySyncPipeline>(params)
 	}
 
 	fn start_relay_guards(&self) {

bridges/relays/bin-substrate/src/chains/kusama_messages_to_polkadot.rs

@@ -21,7 +21,6 @@ use std::ops::RangeInclusive;
 use codec::Encode;
 use frame_support::weights::Weight;
 use sp_core::{Bytes, Pair};
-use sp_runtime::{FixedPointNumber, FixedU128};
 
 use bp_messages::MessageNonce;
 use bridge_runtime_common::messages::target::FromBridgedChainMessagesProof;
@@ -33,7 +32,6 @@ use relay_polkadot_client::{
 	HeaderId as PolkadotHeaderId, Polkadot, SigningParams as PolkadotSigningParams,
 };
 use relay_substrate_client::{Chain, Client, TransactionSignScheme, UnsignedTransaction};
-use relay_utils::metrics::MetricsParams;
 use substrate_relay_helper::{
 	messages_lane::{
 		select_delivery_transaction_limits, MessagesRelayParams, StandaloneMessagesMetrics,
@@ -196,12 +194,13 @@ pub async fn run(
 
 	let lane_id = params.lane_id;
 	let source_client = params.source_client;
+	let target_client = params.target_client;
 	let lane = KusamaMessagesToPolkadot {
 		message_lane: SubstrateMessageLaneToSubstrate {
 			source_client: source_client.clone(),
 			source_sign: params.source_sign,
 			source_transactions_mortality: params.source_transactions_mortality,
-			target_client: params.target_client.clone(),
+			target_client: target_client.clone(),
 			target_sign: params.target_sign,
 			target_transactions_mortality: params.target_transactions_mortality,
 			relayer_id_at_source: relayer_id_at_kusama,
@@ -240,13 +239,10 @@ pub async fn run(
 		stall_timeout,
 	);
 
-	let (metrics_params, metrics_values) = add_standalone_metrics(
-		Some(messages_relay::message_lane_loop::metrics_prefix::<
-			<KusamaMessagesToPolkadot as SubstrateMessageLane>::MessageLane,
-		>(&lane_id)),
-		params.metrics_params,
-		source_client.clone(),
-	)?;
+	let standalone_metrics = params
+		.standalone_metrics
+		.map(Ok)
+		.unwrap_or_else(|| standalone_metrics(source_client.clone(), target_client.clone()))?;
 	messages_relay::message_lane_loop::run(
 		messages_relay::message_lane_loop::Params {
 			lane: lane_id,
@@ -272,41 +268,31 @@ pub async fn run(
 			params.target_to_source_headers_relay,
 		),
 		PolkadotTargetClient::new(
-			params.target_client,
+			target_client,
 			lane,
 			lane_id,
-			metrics_values,
+			standalone_metrics.clone(),
 			params.source_to_target_headers_relay,
 		),
-		metrics_params,
+		standalone_metrics.register_and_spawn(params.metrics_params)?,
 		futures::future::pending(),
 	)
 	.await
 	.map_err(Into::into)
 }
 
-/// Add standalone metrics for the Kusama -> Polkadot messages loop.
-pub(crate) fn add_standalone_metrics(
-	metrics_prefix: Option<String>,
-	metrics_params: MetricsParams,
+/// Create standalone metrics for the Kusama -> Polkadot messages loop.
+pub(crate) fn standalone_metrics(
 	source_client: Client<Kusama>,
-) -> anyhow::Result<(MetricsParams, StandaloneMessagesMetrics)> {
-	let polkadot_to_kusama_conversion_rate_key = bp_runtime::storage_parameter_key(
-		bp_kusama::POLKADOT_TO_KUSAMA_CONVERSION_RATE_PARAMETER_NAME,
-	)
-	.0;
-
-	substrate_relay_helper::messages_lane::add_standalone_metrics::<KusamaMessagesToPolkadot>(
-		metrics_prefix,
-		metrics_params,
+	target_client: Client<Polkadot>,
+) -> anyhow::Result<StandaloneMessagesMetrics<Kusama, Polkadot>> {
+	substrate_relay_helper::messages_lane::standalone_metrics(
 		source_client,
-		Some(crate::chains::polkadot::TOKEN_ID),
+		target_client,
 		Some(crate::chains::kusama::TOKEN_ID),
-		Some((
-			sp_core::storage::StorageKey(polkadot_to_kusama_conversion_rate_key),
-			// starting relay before this parameter will be set to some value may cause troubles
-			FixedU128::from_inner(FixedU128::DIV),
-		)),
+		Some(crate::chains::polkadot::TOKEN_ID),
+		Some(crate::chains::polkadot::kusama_to_polkadot_conversion_rate_params()),
+		Some(crate::chains::kusama::polkadot_to_kusama_conversion_rate_params()),
 	)
 }
 

bridges/relays/bin-substrate/src/chains/millau.rs

@@ -28,8 +28,17 @@ use bp_message_dispatch::{CallOrigin, MessagePayload};
 use codec::Decode;
 use frame_support::weights::{DispatchInfo, GetDispatchInfo, Weight};
 use relay_millau_client::Millau;
+use sp_core::storage::StorageKey;
+use sp_runtime::FixedU128;
 use sp_version::RuntimeVersion;
 
+// Millau/Rialto tokens have no any real value, so the conversion rate we use is always 1:1. But we
+// want to test our code that is intended to work with real-value chains. So to keep it close to
+// 1:1, we'll be treating Rialto as BTC and Millau as wBTC (only in relayer).
+
+/// The identifier of token, which value is associated with Millau token value by relayer.
+pub(crate) const ASSOCIATED_TOKEN_ID: &str = crate::chains::kusama::TOKEN_ID;
+
 impl CliEncodeCall for Millau {
 	fn max_extrinsic_size() -> u32 {
 		bp_millau::max_extrinsic_size()
@@ -123,3 +132,11 @@ impl CliChain for Millau {
 		}
 	}
 }
+
+/// Storage key and initial value of Rialto -> Millau conversion rate.
+pub(crate) fn rialto_to_millau_conversion_rate_params() -> (StorageKey, FixedU128) {
+	(
+		StorageKey(millau_runtime::rialto_messages::RialtoToMillauConversionRate::key().to_vec()),
+		millau_runtime::rialto_messages::INITIAL_RIALTO_TO_MILLAU_CONVERSION_RATE,
+	)
+}

bridges/relays/bin-substrate/src/chains/millau_messages_to_rialto.rs

@@ -33,7 +33,6 @@ use relay_rialto_client::{
 	HeaderId as RialtoHeaderId, Rialto, SigningParams as RialtoSigningParams,
 };
 use relay_substrate_client::{Chain, Client, IndexOf, TransactionSignScheme, UnsignedTransaction};
-use relay_utils::metrics::MetricsParams;
 use substrate_relay_helper::{
 	messages_lane::{
 		select_delivery_transaction_limits, MessagesRelayParams, StandaloneMessagesMetrics,
@@ -193,12 +192,13 @@ pub async fn run(
 
 	let lane_id = params.lane_id;
 	let source_client = params.source_client;
+	let target_client = params.target_client;
 	let lane = MillauMessagesToRialto {
 		message_lane: SubstrateMessageLaneToSubstrate {
 			source_client: source_client.clone(),
 			source_sign: params.source_sign,
 			source_transactions_mortality: params.source_transactions_mortality,
-			target_client: params.target_client.clone(),
+			target_client: target_client.clone(),
 			target_sign: params.target_sign,
 			target_transactions_mortality: params.target_transactions_mortality,
 			relayer_id_at_source: relayer_id_at_millau,
@@ -234,13 +234,10 @@ pub async fn run(
 		stall_timeout,
 	);
 
-	let (metrics_params, metrics_values) = add_standalone_metrics(
-		Some(messages_relay::message_lane_loop::metrics_prefix::<
-			<MillauMessagesToRialto as SubstrateMessageLane>::MessageLane,
-		>(&lane_id)),
-		params.metrics_params,
-		source_client.clone(),
-	)?;
+	let standalone_metrics = params
+		.standalone_metrics
+		.map(Ok)
+		.unwrap_or_else(|| standalone_metrics(source_client.clone(), target_client.clone()))?;
 	messages_relay::message_lane_loop::run(
 		messages_relay::message_lane_loop::Params {
 			lane: lane_id,
@@ -266,37 +263,31 @@ pub async fn run(
 			params.target_to_source_headers_relay,
 		),
 		RialtoTargetClient::new(
-			params.target_client,
+			target_client,
 			lane,
 			lane_id,
-			metrics_values,
+			standalone_metrics.clone(),
 			params.source_to_target_headers_relay,
 		),
-		metrics_params,
+		standalone_metrics.register_and_spawn(params.metrics_params)?,
 		futures::future::pending(),
 	)
 	.await
 	.map_err(Into::into)
 }
 
-/// Add standalone metrics for the Millau -> Rialto messages loop.
-pub(crate) fn add_standalone_metrics(
-	metrics_prefix: Option<String>,
-	metrics_params: MetricsParams,
+/// Create standalone metrics for the Millau -> Rialto messages loop.
+pub(crate) fn standalone_metrics(
 	source_client: Client<Millau>,
-) -> anyhow::Result<(MetricsParams, StandaloneMessagesMetrics)> {
-	substrate_relay_helper::messages_lane::add_standalone_metrics::<MillauMessagesToRialto>(
-		metrics_prefix,
-		metrics_params,
+	target_client: Client<Rialto>,
+) -> anyhow::Result<StandaloneMessagesMetrics<Millau, Rialto>> {
+	substrate_relay_helper::messages_lane::standalone_metrics(
 		source_client,
-		Some(crate::chains::MILLAU_ASSOCIATED_TOKEN_ID),
-		Some(crate::chains::RIALTO_ASSOCIATED_TOKEN_ID),
-		Some((
-			sp_core::storage::StorageKey(
-				millau_runtime::rialto_messages::RialtoToMillauConversionRate::key().to_vec(),
-			),
-			millau_runtime::rialto_messages::INITIAL_RIALTO_TO_MILLAU_CONVERSION_RATE,
-		)),
+		target_client,
+		Some(crate::chains::millau::ASSOCIATED_TOKEN_ID),
+		Some(crate::chains::rialto::ASSOCIATED_TOKEN_ID),
+		Some(crate::chains::rialto::millau_to_rialto_conversion_rate_params()),
+		Some(crate::chains::millau::rialto_to_millau_conversion_rate_params()),
 	)
 }
 

bridges/relays/bin-substrate/src/chains/mod.rs

@@ -39,31 +39,16 @@ mod rococo;
 mod westend;
 mod wococo;
 
-// Millau/Rialto tokens have no any real value, so the conversion rate we use is always 1:1. But we
-// want to test our code that is intended to work with real-value chains. So to keep it close to
-// 1:1, we'll be treating Rialto as BTC and Millau as wBTC (only in relayer).
-
-/// The identifier of token, which value is associated with Rialto token value by relayer.
-pub(crate) const RIALTO_ASSOCIATED_TOKEN_ID: &str = polkadot::TOKEN_ID;
-/// The identifier of token, which value is associated with Millau token value by relayer.
-pub(crate) const MILLAU_ASSOCIATED_TOKEN_ID: &str = kusama::TOKEN_ID;
-
-use relay_utils::metrics::MetricsParams;
+use relay_utils::metrics::{MetricsParams, StandaloneMetric};
 
 pub(crate) fn add_polkadot_kusama_price_metrics<T: finality_relay::FinalitySyncPipeline>(
-	prefix: Option<String>,
 	params: MetricsParams,
 ) -> anyhow::Result<MetricsParams> {
-	// Polkadot/Kusama prices are added as metrics here, because atm we don't have Polkadot <->
-	// Kusama relays, but we want to test metrics/dashboards in advance
-	Ok(relay_utils::relay_metrics(prefix, params)
-		.standalone_metric(|registry, prefix| {
-			substrate_relay_helper::helpers::token_price_metric(registry, prefix, "polkadot")
-		})?
-		.standalone_metric(|registry, prefix| {
-			substrate_relay_helper::helpers::token_price_metric(registry, prefix, "kusama")
-		})?
-		.into_params())
+	substrate_relay_helper::helpers::token_price_metric(polkadot::TOKEN_ID)?
+		.register_and_spawn(&params.registry)?;
+	substrate_relay_helper::helpers::token_price_metric(kusama::TOKEN_ID)?
+		.register_and_spawn(&params.registry)?;
+	Ok(params)
 }
 
 #[cfg(test)]

bridges/relays/bin-substrate/src/chains/polkadot.rs

@@ -17,6 +17,8 @@
 use codec::Decode;
 use frame_support::weights::{DispatchClass, DispatchInfo, Pays, Weight};
 use relay_polkadot_client::Polkadot;
+use sp_core::storage::StorageKey;
+use sp_runtime::{FixedPointNumber, FixedU128};
 use sp_version::RuntimeVersion;
 
 use crate::cli::{
@@ -101,3 +103,14 @@ impl CliChain for Polkadot {
 		anyhow::bail!("Sending messages from Polkadot is not yet supported.")
 	}
 }
+
+/// Storage key and initial value of Kusama -> Polkadot conversion rate.
+pub(crate) fn kusama_to_polkadot_conversion_rate_params() -> (StorageKey, FixedU128) {
+	(
+		bp_runtime::storage_parameter_key(
+			bp_polkadot::KUSAMA_TO_POLKADOT_CONVERSION_RATE_PARAMETER_NAME,
+		),
+		// starting relay before this parameter will be set to some value may cause troubles
+		FixedU128::from_inner(FixedU128::DIV),
+	)
+}

bridges/relays/bin-substrate/src/chains/polkadot_headers_to_kusama.rs

@@ -64,10 +64,7 @@ impl SubstrateFinalitySyncPipeline for PolkadotFinalityToKusama {
 	type TargetChain = Kusama;
 
 	fn customize_metrics(params: MetricsParams) -> anyhow::Result<MetricsParams> {
-		crate::chains::add_polkadot_kusama_price_metrics::<Self::FinalitySyncPipeline>(
-			Some(finality_relay::metrics_prefix::<Self::FinalitySyncPipeline>()),
-			params,
-		)
+		crate::chains::add_polkadot_kusama_price_metrics::<Self::FinalitySyncPipeline>(params)
 	}
 
 	fn start_relay_guards(&self) {