Companion for init the RuntimeLogger automatically (#2522)

* Lol

* Add the features

* Remove some more runtime logger init calls

* Make companion check work

* Revert "Make companion check work"

This reverts commit a255c79.

* Update Substrate

Author: bkchr

Cargo.lock

@@ -8,7 +8,7 @@ build = "build.rs"
 [dependencies]
 bitvec = { version = "0.20.1", default-features = false, features = ["alloc"] }
 parity-scale-codec = { version = "2.0.0", default-features = false, features = ["derive"] }
-log = { version = "0.4.13", optional = true }
+log = { version = "0.4.14", default-features = false }
 rustc-hex = { version = "2.1.0", default-features = false }
 serde = { version = "1.0.123", default-features = false }
 serde_derive = { version = "1.0.117", optional = true }
@@ -145,7 +145,7 @@ std = [
 	"pallet-vesting/std",
 	"serde_derive",
 	"serde/std",
-	"log",
+	"log/std",
 	"pallet-babe/std",
 	"babe-primitives/std",
 	"sp-session/std",
@@ -194,3 +194,10 @@ try-runtime = [
 # runtime without clashing with the runtime api exported functions
 # in WASM.
 disable-runtime-api = []
+
+# A feature that should be enabled when the runtime should be build for on-chain
+# deployment. This will disable stuff that shouldn't be part of the on-chain wasm
+# to make it smaller like logging for example.
+on-chain-release-build = [
+	"sp-api/disable-logging",
+]

runtime/kusama/Cargo.toml

@@ -56,15 +56,15 @@ use sp_version::NativeVersion;
 use sp_core::OpaqueMetadata;
 use sp_staking::SessionIndex;
 use frame_support::{
-	parameter_types, construct_runtime, debug, RuntimeDebug,
+	parameter_types, construct_runtime, RuntimeDebug,
 	traits::{KeyOwnerProofSystem, Randomness, LockIdentifier, Filter, InstanceFilter},
 	weights::Weight,
 };
 use frame_system::{EnsureRoot, EnsureOneOf};
 use pallet_im_online::sr25519::AuthorityId as ImOnlineId;
 use authority_discovery_primitives::AuthorityId as AuthorityDiscoveryId;
 use pallet_transaction_payment::{FeeDetails, RuntimeDispatchInfo};
-use pallet_session::{historical as session_historical};
+use pallet_session::historical as session_historical;
 use static_assertions::const_assert;
 
 #[cfg(feature = "std")]
@@ -696,7 +696,7 @@ impl<LocalCall> frame_system::offchain::CreateSignedTransaction<LocalCall> for R
 			pallet_transaction_payment::ChargeTransactionPayment::<Runtime>::from(tip),
 		);
 		let raw_payload = SignedPayload::new(call, extra).map_err(|e| {
-			debug::warn!("Unable to create signed payload: {:?}", e);
+			log::warn!("Unable to create signed payload: {:?}", e);
 		}).ok()?;
 		let signature = raw_payload.using_encoded(|payload| {
 			C::sign(payload, public)
@@ -1318,7 +1318,6 @@ sp_api::impl_runtime_apis! {
 	#[cfg(feature = "try-runtime")]
 	impl frame_try_runtime::TryRuntime<Block> for Runtime {
 		fn on_runtime_upgrade() -> Result<(Weight, Weight), sp_runtime::RuntimeString> {
-			frame_support::debug::RuntimeLogger::init();
 			let weight = Executive::try_runtime_upgrade()?;
 			Ok((weight, BlockWeights::get().max_block))
 		}

runtime/kusama/src/lib.rs

@@ -7,7 +7,7 @@ edition = "2018"
 [dependencies]
 bitvec = { version = "0.20.1", default-features = false, features = ["alloc"] }
 parity-scale-codec = { version = "2.0.0", default-features = false, features = ["derive"] }
-log = "0.4.13"
+log = { version = "0.4.14", default-features = false }
 rustc-hex = { version = "2.1.0", default-features = false }
 serde = { version = "1.0.123", features = [ "derive" ], optional = true }
 derive_more = "0.99.11"
@@ -86,6 +86,7 @@ std = [
 	"pallet-vesting/std",
 	"xcm/std",
 	"xcm-executor/std",
+	"log/std",
 ]
 runtime-benchmarks = [
 	"libsecp256k1/hmac",

runtime/parachains/Cargo.toml

@@ -28,8 +28,8 @@ use primitives::v1::{
 	CandidateReceipt, HeadData, CandidateHash, Hash,
 };
 use frame_support::{
-	decl_storage, decl_module, decl_error, decl_event, ensure, debug,
-	dispatch::DispatchResult, IterableStorageMap, weights::Weight, traits::Get,
+	decl_storage, decl_module, decl_error, decl_event, ensure, dispatch::DispatchResult, IterableStorageMap,
+	weights::Weight, traits::Get,
 };
 use parity_scale_codec::{Encode, Decode};
 use bitvec::{order::Lsb0 as BitOrderLsb0, vec::BitVec};
@@ -213,7 +213,7 @@ decl_module! {
 	}
 }
 
-const LOG_TARGET: &str = "parachains_runtime_inclusion";
+const LOG_TARGET: &str = "runtime::inclusion";
 
 impl<T: Config> Module<T> {
 	/// Block initialization logic, called by initializer.
@@ -343,11 +343,11 @@ impl<T: Config> Module<T> {
 				let commitments = match PendingAvailabilityCommitments::take(&para_id) {
 					Some(commitments) => commitments,
 					None => {
-						debug::warn!(r#"
-						Inclusion::process_bitfields:
-							PendingAvailability and PendingAvailabilityCommitments
-							are out of sync, did someone mess with the storage?
-						"#);
+						log::warn!(
+							target: LOG_TARGET,
+							"Inclusion::process_bitfields: PendingAvailability and PendingAvailabilityCommitments
+							are out of sync, did someone mess with the storage?",
+						);
 						continue;
 					}
 				};
@@ -460,7 +460,6 @@ impl<T: Config> Module<T> {
 						&candidate.candidate.commitments.horizontal_messages,
 					)
 				{
-					frame_support::debug::RuntimeLogger::init();
 					log::debug!(
 						target: LOG_TARGET,
 						"Validation outputs checking during inclusion of a candidate {} for parachain `{}` failed: {:?}",
@@ -631,7 +630,6 @@ impl<T: Config> Module<T> {
 			T::BlockNumber::from(validation_outputs.hrmp_watermark),
 			&validation_outputs.horizontal_messages,
 		) {
-			frame_support::debug::RuntimeLogger::init();
 			log::debug!(
 				target: LOG_TARGET,
 				"Validation outputs checking for parachain `{}` failed: {:?}",

runtime/parachains/src/inclusion.rs

@@ -227,8 +227,7 @@ impl<T: Config> ProvideInherent for Module<T> {
 					) {
 						Ok(_) => (signed_bitfields, backed_candidates),
 						Err(err) => {
-							frame_support::debug::RuntimeLogger::init();
-							frame_support::debug::warn!(
+							log::warn!(
 								target: "runtime_inclusion_inherent",
 								"dropping signed_bitfields and backed_candidates because they produced \
 								an invalid inclusion inherent: {:?}",

runtime/parachains/src/inclusion_inherent.rs

@@ -27,7 +27,6 @@ use primitives::v1::{
 	GroupIndex, CandidateEvent, PersistedValidationData, SessionInfo,
 	InboundDownwardMessage, InboundHrmpMessage, Hash, AuthorityDiscoveryId
 };
-use frame_support::debug;
 use crate::{initializer, inclusion, scheduler, configuration, paras, session_info, dmp, hrmp, shared};
 
 
@@ -85,8 +84,11 @@ pub fn availability_cores<T: initializer::Config>() -> Vec<CoreState<T::Hash, T:
 		match <scheduler::Module<T>>::group_assigned_to_core(core_index, backed_in_number) {
 			Some(g) => g,
 			None =>  {
-				debug::warn!("Could not determine the group responsible for core extracted \
-					from list of cores for some prior block in same session");
+				log::warn!(
+					target: "runtime::polkadot-api::v1",
+					"Could not determine the group responsible for core extracted \
+					from list of cores for some prior block in same session",
+				);
 
 				GroupIndex(0)
 			}

runtime/parachains/src/runtime_api_impl/v1.rs

@@ -75,8 +75,8 @@ impl<Config: xcm_executor::Config> UmpSink for XcmSink<Config> {
 				}
 			}
 		} else {
-			frame_support::debug::error!(
-				target: "xcm",
+			log::error!(
+				target: "runtime::ump-sink",
 				"Failed to decode versioned XCM from upward message.",
 			);
 		}

runtime/parachains/src/ump.rs

@@ -8,7 +8,7 @@ build = "build.rs"
 [dependencies]
 bitvec = { version = "0.20.1", default-features = false, features = ["alloc"] }
 parity-scale-codec = { version = "2.0.0", default-features = false, features = ["derive"] }
-log = { version = "0.4.13", optional = true }
+log = { version = "0.4.14", default-features = false }
 rustc-hex = { version = "2.1.0", default-features = false }
 serde = { version = "1.0.123", default-features = false }
 serde_derive = { version = "1.0.117", optional = true }
@@ -139,7 +139,7 @@ std = [
 	"sp-version/std",
 	"serde_derive",
 	"serde/std",
-	"log",
+	"log/std",
 	"pallet-babe/std",
 	"babe-primitives/std",
 	"sp-session/std",
@@ -189,3 +189,10 @@ try-runtime = [
 # runtime without clashing with the runtime api exported functions
 # in WASM.
 disable-runtime-api = []
+
+# A feature that should be enabled when the runtime should be build for on-chain
+# deployment. This will disable stuff that shouldn't be part of the on-chain wasm
+# to make it smaller like logging for example.
+on-chain-release-build = [
+	"sp-api/disable-logging",
+]

runtime/polkadot/Cargo.toml

@@ -56,7 +56,7 @@ use sp_version::NativeVersion;
 use sp_core::OpaqueMetadata;
 use sp_staking::SessionIndex;
 use frame_support::{
-	parameter_types, construct_runtime, debug, RuntimeDebug,
+	parameter_types, construct_runtime, RuntimeDebug,
 	traits::{KeyOwnerProofSystem, Randomness, LockIdentifier, Filter},
 	weights::Weight,
 };
@@ -742,7 +742,7 @@ impl<LocalCall> frame_system::offchain::CreateSignedTransaction<LocalCall> for R
 			claims::PrevalidateAttests::<Runtime>::new(),
 		);
 		let raw_payload = SignedPayload::new(call, extra).map_err(|e| {
-			debug::warn!("Unable to create signed payload: {:?}", e);
+			log::warn!("Unable to create signed payload: {:?}", e);
 		}).ok()?;
 		let signature = raw_payload.using_encoded(|payload| {
 			C::sign(payload, public)
@@ -1314,7 +1314,6 @@ sp_api::impl_runtime_apis! {
 	#[cfg(feature = "try-runtime")]
 	impl frame_try_runtime::TryRuntime<Block> for Runtime {
 		fn on_runtime_upgrade() -> Result<(Weight, Weight), sp_runtime::RuntimeString> {
-			frame_support::debug::RuntimeLogger::init();
 			let weight = Executive::try_runtime_upgrade()?;
 			Ok((weight, BlockWeights::get().max_block))
 		}