Add various small log fixes

Add options to configure the logging level and ldk node number (to
identify each ldk node in lndk's integration tests). Also add a
couple helpful logs.

Cargo.toml

@@ -21,6 +21,7 @@ bitcoin = "0.29.0"
 bitcoin-bech32 = "0.12"
 bech32 = "0.8"
 libc = "0.2"
+log = "0.4.17"
 tempfile = "3.5.0"
 
 chrono = { version = "0.4", default-features = false, features = ["clock"] }

src/config.rs

@@ -1,5 +1,6 @@
 use bitcoin::network::constants::Network;
 use lightning::ln::msgs::SocketAddress;
+use lightning::util::logger::Level;
 use std::fs;
 use std::path::PathBuf;
 use tempfile::{Builder, TempDir};
@@ -14,6 +15,8 @@ pub struct LdkUserInfo {
 	pub ldk_announced_listen_addr: Vec<SocketAddress>,
 	pub ldk_announced_node_name: [u8; 32],
 	pub network: Network,
+	pub log_level: Level,
+	pub node_num: u8,
 }
 
 // Here we initialize three layers of directories needed for our tests. We won't persist ldk data, but we'll persist

src/disk.rs

@@ -3,7 +3,7 @@ use bitcoin::secp256k1::PublicKey;
 use bitcoin::Network;
 use chrono::Utc;
 use lightning::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringDecayParameters};
-use lightning::util::logger::{Logger, Record};
+use lightning::util::logger::{Logger, Record, Level};
 use lightning::util::ser::{Readable, ReadableArgs, Writer};
 use std::collections::HashMap;
 use std::fs;
@@ -18,15 +18,21 @@ pub(crate) const OUTBOUND_PAYMENTS_FNAME: &str = "outbound_payments";
 
 pub(crate) struct FilesystemLogger {
 	logs_dir: String,
+        level: Level,
+        // Specifies which ldk node this is in the integration tests.
+        node_num: u8,
 }
 impl FilesystemLogger {
-	pub(crate) fn new(logs_dir: String) -> Self {
-		fs::create_dir_all(logs_dir.clone()).unwrap();
-		Self { logs_dir }
+	pub(crate) fn new(logs_dir: String, level: Level, node_num: u8) -> Self {
+	fs::create_dir_all(logs_dir.clone()).unwrap();
+		Self { logs_dir, level, node_num }
 	}
 }
 impl Logger for FilesystemLogger {
 	fn log(&self, record: &Record) {
+		if record.level < self.level {
+			return;
+		}
 		let raw_log = record.args.to_string();
 		let log = format!(
 			"{} {:<5} [{}:{}] {}\n",
@@ -39,7 +45,7 @@ impl Logger for FilesystemLogger {
 			record.line,
 			raw_log
 		);
-		let logs_file_path = format!("{}/logs.txt", self.logs_dir.clone());
+		let logs_file_path = format!("{}/logs-ldk{}.txt", self.logs_dir.clone(), self.node_num);
 		fs::OpenOptions::new()
 			.create(true)
 			.append(true)

src/lib.rs

@@ -19,6 +19,7 @@ use bitcoin::network::constants::Network;
 use bitcoin::BlockHash;
 use bitcoin_bech32::WitnessProgram;
 use disk::{INBOUND_PAYMENTS_FNAME, OUTBOUND_PAYMENTS_FNAME};
+use lightning::log_info;
 use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
 use lightning::chain::{Filter, Watch};
 use lightning::events::bump_transaction::{BumpTransactionEventHandler, Wallet};
@@ -37,6 +38,7 @@ use lightning::routing::router::DefaultRouter;
 use lightning::routing::scoring::ProbabilisticScoringFeeParameters;
 use lightning::sign::{EntropySource, InMemorySigner, KeysManager, SpendableOutputDescriptor};
 use lightning::util::config::UserConfig;
+use lightning::util::logger::Logger;
 use lightning::util::persist::{KVStore, MonitorUpdatingPersister};
 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
 use lightning::{chain, impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
@@ -159,7 +161,7 @@ pub(crate) type GossipVerifier = lightning_block_sync::gossip::GossipVerifier<
 
 pub(crate) type P2PGossipSyncType = lightning::routing::gossip::P2PGossipSync<
         Arc<NetworkGraph>,
-        GossipVerifier, // Arc<BitcoindClient>,
+        GossipVerifier,
         Arc<FilesystemLogger>,
 >;
 
@@ -186,7 +188,7 @@ pub(crate) type OnionMessengerType = OnionMessenger<
 	Arc<KeysManager>,
 	Arc<FilesystemLogger>,
 	Arc<DefaultMessageRouter>,
-	IgnoringMessageHandler,
+        IgnoringMessageHandler,
 	Arc<OnionMessageHandler>,
 >;
 
@@ -548,7 +550,8 @@ pub async fn start_ldk(args: config::LdkUserInfo, test_name: &str) -> node_api::
 
 	// ## Setup
 	// Step 1: Initialize the Logger
-	let logger = Arc::new(FilesystemLogger::new(ldk_log_dir.clone()));
+	let logger = Arc::new(FilesystemLogger::new(ldk_log_dir.clone(), args.log_level, args.node_num));
+	log_info!(logger, "LDK node is starting up.");
 
 	// Initialize our bitcoind client.
 	let bitcoind_client = match BitcoindClient::new(
@@ -787,7 +790,7 @@ pub async fn start_ldk(args: config::LdkUserInfo, test_name: &str) -> node_api::
 
 	// Step 15: Initialize the PeerManager
 	let onion_message_handler =
-		Arc::new(OnionMessageHandler { messages: Arc::new(Mutex::new(VecDeque::new())) });
+		Arc::new(OnionMessageHandler { messages: Arc::new(Mutex::new(VecDeque::new())), logger: Arc::clone(&logger) });
 	let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
 	let onion_messenger: Arc<OnionMessengerType> = Arc::new(OnionMessenger::new(
 		Arc::clone(&keys_manager),

src/onion.rs

@@ -1,6 +1,9 @@
+use crate::disk::FilesystemLogger;
+use lightning::log_info;
 use lightning::io::Read;
 use lightning::ln::msgs::DecodeError;
 use lightning::onion_message::{CustomOnionMessageHandler, OnionMessageContents, PendingOnionMessage};
+use lightning::util::logger::Logger;
 use lightning::util::ser::{Writeable, Writer};
 use std::collections::VecDeque;
 use std::sync::{Arc, Mutex};
@@ -27,13 +30,14 @@ impl Writeable for UserOnionMessageContents {
 #[derive(Clone)]
 pub struct OnionMessageHandler {
 	pub messages: Arc<Mutex<VecDeque<UserOnionMessageContents>>>,
+	pub(crate) logger: Arc<FilesystemLogger>,
 }
 
 impl CustomOnionMessageHandler for OnionMessageHandler {
 	type CustomMessage = UserOnionMessageContents;
 
 	fn handle_custom_message(&self, msg: Self::CustomMessage) -> Option<UserOnionMessageContents> {
-		println!("Received a new custom message!");
+		log_info!(self.logger, "Received a new custom message!");
 		self.messages.lock().unwrap().push_back(msg.clone());
 		Some(msg)
 	}