RPC to allow setting the log filter

client/cli/Cargo.toml

@@ -44,9 +44,9 @@ structopt = "0.3.8"
 sc-tracing = { version = "2.0.0", path = "../tracing" }
 chrono = "0.4.10"
 serde = "1.0.111"
-tracing = "0.1.10"
+tracing = "0.1.21"
 tracing-log = "0.1.1"
-tracing-subscriber = "0.2.10"
+tracing-subscriber = "0.2.14"
 sc-cli-proc-macro = { version = "2.0.0", path = "./proc-macro" }
 thiserror = "1.0.21"
 

client/cli/src/lib.rs

@@ -27,7 +27,6 @@ pub mod arg_enums;
 mod commands;
 mod config;
 mod error;
-mod logging;
 mod params;
 mod runner;
 
@@ -50,10 +49,14 @@ use structopt::{
 #[doc(hidden)]
 pub use tracing;
 use tracing_subscriber::{
-	filter::Directive, fmt::time::ChronoLocal, layer::SubscriberExt, FmtSubscriber, Layer,
+	filter::Directive, fmt::time::ChronoLocal, layer::SubscriberExt, FmtSubscriber, Layer, fmt::Formatter, reload::Handle, EnvFilter
 };
+pub use sc_tracing::logging;
 
 pub use logging::PREFIX_LOG_SPAN;
+use tracing_subscriber::layer::Layered;
+use crate::logging::{NodeNameLayer, EventFormat};
+use tracing_subscriber::fmt::format::DefaultFields;
 
 /// Substrate client CLI
 ///
@@ -243,21 +246,17 @@ pub fn init_logger(
 	pattern: &str,
 	tracing_receiver: sc_tracing::TracingReceiver,
 	profiling_targets: Option<String>,
-) -> std::result::Result<(), String> {
-	fn parse_directives(dirs: impl AsRef<str>) -> Vec<Directive> {
-		dirs.as_ref()
-			.split(',')
-			.filter_map(|s| s.parse().ok())
-			.collect()
-	}
+) -> std::result::Result<(), String>
+{
+	use sc_tracing::parse_directives;
 
 	if let Err(e) = tracing_log::LogTracer::init() {
 		return Err(format!(
 			"Registering Substrate logger failed: {:}!", e
 		))
 	}
 
-	let mut env_filter = tracing_subscriber::EnvFilter::default()
+	let mut env_filter: EnvFilter = tracing_subscriber::EnvFilter::default()
 		// Disable info logging by default for some modules.
 		.add_directive("ws=off".parse().expect("provided directive is valid"))
 		.add_directive("yamux=off".parse().expect("provided directive is valid"))
@@ -316,18 +315,24 @@ pub fn init_logger(
 		"%Y-%m-%d %H:%M:%S%.3f".to_string()
 	});
 
-	let subscriber = FmtSubscriber::builder()
+	let subscriber_builder = FmtSubscriber::builder()
 		.with_env_filter(env_filter)
-		.with_writer(std::io::stderr)
-		.event_format(logging::EventFormat {
-			timer,
-			ansi: enable_color,
-			display_target: !simple,
-			display_level: !simple,
-			display_thread_name: !simple,
-		})
-		.finish().with(logging::NodeNameLayer);
-
+		// TODO: Q - There's a small cost to this, do we make it opt-in/out with cli flag?
+		.with_filter_reloading();
+	let handle = subscriber_builder.reload_handle();
+	let subscriber = subscriber_builder
+		// TODO: re-enable this
+		// .with_writer(std::io::stderr)
+		// .event_format(logging::EventFormat {
+		// 	timer,
+		// 	ansi: enable_color,
+		// 	display_target: !simple,
+		// 	display_level: !simple,
+		// 	display_thread_name: !simple,
+		// })
+		.finish()
+		.with(logging::NodeNameLayer);
+		sc_tracing::set_reload_handle(handle);
 	if let Some(profiling_targets) = profiling_targets {
 		let profiling = sc_tracing::ProfilingLayer::new(tracing_receiver, &profiling_targets);
 

client/rpc-api/src/system/mod.rs

@@ -108,4 +108,9 @@ pub trait SystemApi<Hash, Number> {
 	/// known block.
 	#[rpc(name = "system_syncState", returns = "SyncState<Number>")]
 	fn system_sync_state(&self) -> Receiver<SyncState<Number>>;
+
+	/// Reloads the logging filter, replacing current with the supplied directives
+	#[rpc(name = "system_reloadLogFilter", returns = "()")]
+	fn system_reload_log_filter(&self, directives: String)
+		-> Result<(), jsonrpc_core::Error>;
 }

client/rpc/Cargo.toml

@@ -37,6 +37,7 @@ sc-block-builder = { version = "0.8.0", path = "../../client/block-builder" }
 sc-keystore = { version = "2.0.0", path = "../keystore" }
 sp-transaction-pool = { version = "2.0.0", path = "../../primitives/transaction-pool" }
 sp-blockchain = { version = "2.0.0", path = "../../primitives/blockchain" }
+sc-tracing = { version = "2.0.0", path = "../../client/tracing" }
 hash-db = { version = "0.15.2", default-features = false }
 parking_lot = "0.10.0"
 lazy_static = { version = "1.4.0", optional = true }

client/rpc/src/system/mod.rs

@@ -197,4 +197,8 @@ impl<B: traits::Block> SystemApi<B::Hash, <B::Header as HeaderT>::Number> for Sy
 		let _ = self.send_back.unbounded_send(Request::SyncState(tx));
 		Receiver(Compat::new(rx))
 	}
+
+	fn system_reload_log_filter(&self, directives: String)-> std::result::Result<(), rpc::Error> {
+		sc_tracing::reload_filter(directives).map_err(|e| rpc::Error::internal_error())
+	}
 }

client/tracing/Cargo.toml

@@ -13,15 +13,18 @@ readme = "README.md"
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+ansi_term = "0.12.1"
+tracing-log = "0.1.1"
 erased-serde = "0.3.9"
 log = { version = "0.4.8" }
+once_cell = "1.4.1"
 parking_lot = "0.10.0"
 rustc-hash = "1.1.0"
 serde = "1.0.101"
 serde_json = "1.0.41"
 slog = { version = "2.5.2", features = ["nested-values"] }
 tracing = "0.1.21"
 tracing-core = "0.1.17"
-tracing-subscriber = "0.2.13"
+tracing-subscriber = "0.2.14"
 sp-tracing = { version = "2.0.0", path = "../../primitives/tracing" }
 sc-telemetry = { version = "2.0.0", path = "../telemetry" }

client/tracing/src/lib.rs

@@ -23,6 +23,7 @@
 //! See `sp-tracing` for examples on how to use tracing.
 //!
 //! Currently we provide `Log` (default), `Telemetry` variants for `Receiver`
+pub mod logging;
 
 use rustc_hash::FxHashMap;
 use std::fmt;
@@ -37,12 +38,44 @@ use tracing::{
 	span::{Attributes, Id, Record},
 	subscriber::Subscriber,
 };
-use tracing_subscriber::{CurrentSpan, layer::{Layer, Context}};
+use tracing_subscriber::{CurrentSpan, layer::{Layer, Context}, EnvFilter};
 
 use sc_telemetry::{telemetry, SUBSTRATE_INFO};
 use sp_tracing::{WASM_NAME_KEY, WASM_TARGET_KEY, WASM_TRACE_IDENTIFIER};
+use tracing_subscriber::reload::Handle;
+use tracing_subscriber::fmt::Formatter;
+use once_cell::sync::OnceCell;
+use tracing_subscriber::filter::Directive;
+
 const ZERO_DURATION: Duration = Duration::from_nanos(0);
 
+static FILTER_RELOAD_HANDLE: OnceCell<Handle<EnvFilter, Formatter>> = OnceCell::new();
+
+/// Initialize FILTER_RELOAD_HANDLE, only possible once
+pub fn set_reload_handle(handle: Handle<EnvFilter, Formatter>) {
+	let _ = FILTER_RELOAD_HANDLE.set(handle);
+}
+
+/// Reload the logging filter with the supplied directives
+pub fn reload_filter(directives: String) -> Result<(), String> {
+	let mut env_filter = tracing_subscriber::EnvFilter::default();
+	for directive in parse_directives(directives) {
+		env_filter = env_filter.add_directive(directive);
+	}
+	FILTER_RELOAD_HANDLE.get()
+		.ok_or("No reload handle present".to_string())?
+		.reload(env_filter)
+		.map_err(|e| format!("{}", e))
+}
+
+/// Parse the supplied text directives into `Vec<tracing_subscriber::filter::Directive>`
+pub fn parse_directives(dirs: impl AsRef<str>) -> Vec<Directive> {
+	dirs.as_ref()
+		.split(',')
+		.filter_map(|s| s.parse().ok())
+		.collect()
+}
+
 /// Responsible for assigning ids to new spans, which are not re-used.
 pub struct ProfilingLayer {
 	targets: Vec<(String, Level)>,