Add customizable logging to configuration.

Author: domZippilli

src/builder.rs

@@ -6,7 +6,9 @@
 // accordance with one or both of these licenses.
 
 use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
-use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
+use crate::config::{
+	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
+};
 
 use crate::connection::ConnectionManager;
 use crate::event::EventQueue;
@@ -29,8 +31,8 @@ use crate::types::{
 };
 use crate::wallet::persist::KVStoreWalletPersister;
 use crate::wallet::Wallet;
+use crate::Node;
 use crate::{io, NodeMetrics};
-use crate::{LogLevel, Node};
 
 use lightning::chain::{chainmonitor, BestBlock, Watch};
 use lightning::io::Cursor;
@@ -300,12 +302,6 @@ impl NodeBuilder {
 		self
 	}
 
-	/// Sets the log dir path if logs need to live separate from the storage directory path.
-	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
-		self.config.log_dir_path = Some(log_dir_path);
-		self
-	}
-
 	/// Sets the Bitcoin network used.
 	pub fn set_network(&mut self, network: Network) -> &mut Self {
 		self.config.network = network;
@@ -335,12 +331,6 @@ impl NodeBuilder {
 		Ok(self)
 	}
 
-	/// Sets the level at which [`Node`] will log messages.
-	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
-		self.config.log_level = level;
-		self
-	}
-
 	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
 	/// previously configured.
 	pub fn build(&self) -> Result<Node, BuildError> {
@@ -1234,20 +1224,21 @@ fn build_with_store_internal(
 }
 
 fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
-	let log_dir = match &config.log_dir_path {
-		Some(log_dir) => String::from(log_dir),
-		None => config.storage_dir_path.clone() + "/logs",
-	};
-	let filesystem_log_writer =
-		FilesystemLogWriter::new(log_dir.clone()).map_err(|_| BuildError::LoggerSetupFailed)?;
-	Ok(Arc::new(
-		LdkNodeLogger::new(
-			config.log_level,
-			Box::new(default_format),
-			Box::new(move |s| filesystem_log_writer.write(s)),
-		)
-		.map_err(|_| BuildError::LoggerSetupFailed)?,
-	))
+	match config.logging_config {
+		LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
+		LoggingConfig::Filesystem { ref log_dir, log_level } => {
+			let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
+				.map_err(|_| BuildError::LoggerSetupFailed)?;
+			Ok(Arc::new(
+				LdkNodeLogger::new(
+					log_level,
+					Box::new(default_format),
+					Box::new(move |s| filesystem_log_writer.write(s)),
+				)
+				.map_err(|_| BuildError::LoggerSetupFailed)?,
+			))
+		},
+	}
 }
 
 fn seed_bytes_from_config(

src/config.rs

@@ -7,6 +7,7 @@
 
 //! Objects for configuring the node.
 
+use crate::logger::LdkNodeLogger;
 use crate::payment::SendingParameters;
 
 use lightning::ln::msgs::SocketAddress;
@@ -105,8 +106,9 @@ pub struct Config {
 	pub storage_dir_path: String,
 	/// The path where logs are stored.
 	///
-	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
-	pub log_dir_path: Option<String>,
+	/// In the default configuration logs can be found in the `logs` subdirectory in
+	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
+	pub logging_config: LoggingConfig,
 	/// The used Bitcoin network.
 	pub network: Network,
 	/// The addresses on which the node will listen for incoming connections.
@@ -132,10 +134,6 @@ pub struct Config {
 	/// Channels with available liquidity less than the required amount times this value won't be
 	/// used to send pre-flight probes.
 	pub probing_liquidity_limit_multiplier: u64,
-	/// The level at which we log messages.
-	///
-	/// Any messages below this level will be excluded from the logs.
-	pub log_level: LogLevel,
 	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
 	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
 	///
@@ -167,19 +165,46 @@ impl Default for Config {
 	fn default() -> Self {
 		Self {
 			storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
-			log_dir_path: None,
+			logging_config: LoggingConfig::default(),
 			network: DEFAULT_NETWORK,
 			listening_addresses: None,
 			trusted_peers_0conf: Vec::new(),
 			probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
-			log_level: DEFAULT_LOG_LEVEL,
 			anchor_channels_config: Some(AnchorChannelsConfig::default()),
 			sending_parameters: None,
 			node_alias: None,
 		}
 	}
 }
 
+/// Configuration options for logging.
+#[derive(Debug, Clone)]
+pub enum LoggingConfig {
+	/// An opinionated filesystem logger.
+	///
+	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
+	/// most recent log file, which is created and timestamped at initialization.
+	Filesystem {
+		/// The absolute path where logs are stored.
+		log_dir: String,
+		/// The level at which we log messages.
+		///
+		/// Any messages below this level will be excluded from the logs.
+		log_level: LogLevel,
+	},
+	/// A custom logger.
+	Custom(std::sync::Arc<LdkNodeLogger>),
+}
+
+impl Default for LoggingConfig {
+	fn default() -> Self {
+		Self::Filesystem {
+			log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
+			log_level: DEFAULT_LOG_LEVEL,
+		}
+	}
+}
+
 /// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
 /// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
 ///