X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Flogger.rs;h=92ea8ffed55a91c218c4481e01a83f924536585d;hb=68e25c6c851b76115613dfd770e27b182404cc56;hp=4018b8bf7af4180be712fb7c433ccfe69b2e2bd0;hpb=a42aeb5667106ad921386c8ff9279aafe39da341;p=rust-lightning

diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs
index 4018b8bf..92ea8ffe 100644
--- a/lightning/src/util/logger.rs
+++ b/lightning/src/util/logger.rs
@@ -18,6 +18,7 @@ use bitcoin::secp256k1::PublicKey;
 
 use core::cmp;
 use core::fmt;
+use core::ops::Deref;
 
 use crate::ln::ChannelId;
 #[cfg(c_bindings)]
@@ -97,6 +98,10 @@ pub struct Record<'a> {
 	/// The verbosity level of the message.
 	pub level: Level,
 	/// The node id of the peer pertaining to the logged record.
+	///
+	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
+	/// `None`, depending on if the peer information is readily available in LDK when the log is
+	/// generated.
 	pub peer_id: Option<PublicKey>,
 	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
 	/// the channel has been funded.
@@ -152,6 +157,39 @@ pub trait Logger {
 	fn log(&self, record: Record);
 }
 
+/// Adds relevant context to a [`Record`] before passing it to the wrapped [`Logger`].
+pub struct WithContext<'a, L: Deref> where L::Target: Logger {
+	/// The logger to delegate to after adding context to the record.
+	logger: &'a L,
+	/// The node id of the peer pertaining to the logged record.
+	peer_id: Option<PublicKey>,
+	/// The channel id of the channel pertaining to the logged record.
+	channel_id: Option<ChannelId>,
+}
+
+impl<'a, L: Deref> Logger for WithContext<'a, L> where L::Target: Logger {
+	fn log(&self, mut record: Record) {
+		if self.peer_id.is_some() {
+			record.peer_id = self.peer_id
+		};
+		if self.channel_id.is_some() {
+			record.channel_id = self.channel_id;
+		}
+		self.logger.log(record)
+	}
+}
+
+impl<'a, L: Deref> WithContext<'a, L> where L::Target: Logger {
+	/// Wraps the given logger, providing additional context to any logged records.
+	pub fn from(logger: &'a L, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>) -> Self {
+		WithContext {
+			logger,
+			peer_id,
+			channel_id,
+		}
+	}
+}
+
 /// Wrapper for logging a [`PublicKey`] in hex format.
 ///
 /// This is not exported to bindings users as fmt can't be used in C
@@ -202,7 +240,9 @@ impl<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone> fmt::Display fo
 
 #[cfg(test)]
 mod tests {
-	use crate::util::logger::{Logger, Level};
+	use bitcoin::secp256k1::{PublicKey, SecretKey, Secp256k1};
+	use crate::ln::ChannelId;
+	use crate::util::logger::{Logger, Level, WithContext};
 	use crate::util::test_utils::TestLogger;
 	use crate::sync::Arc;
 
@@ -214,11 +254,11 @@ mod tests {
 	}
 
 	struct WrapperLog {
-		logger: Arc<Logger>
+		logger: Arc<dyn Logger>
 	}
 
 	impl WrapperLog {
-		fn new(logger: Arc<Logger>) -> WrapperLog {
+		fn new(logger: Arc<dyn Logger>) -> WrapperLog {
 			WrapperLog {
 				logger,
 			}
@@ -238,11 +278,46 @@ mod tests {
 	fn test_logging_macros() {
 		let mut logger = TestLogger::new();
 		logger.enable(Level::Gossip);
-		let logger : Arc<Logger> = Arc::new(logger);
+		let logger : Arc<dyn Logger> = Arc::new(logger);
 		let wrapper = WrapperLog::new(Arc::clone(&logger));
 		wrapper.call_macros();
 	}
 
+	#[test]
+	fn test_logging_with_context() {
+		let logger = &TestLogger::new();
+		let secp_ctx = Secp256k1::new();
+		let pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
+		let context_logger = WithContext::from(&logger, Some(pk), Some(ChannelId([0; 32])));
+		log_error!(context_logger, "This is an error");
+		log_warn!(context_logger, "This is an error");
+		log_debug!(context_logger, "This is an error");
+		log_trace!(context_logger, "This is an error");
+		log_gossip!(context_logger, "This is an error");
+		log_info!(context_logger, "This is an error");
+		logger.assert_log_context_contains(
+			"lightning::util::logger::tests", Some(pk), Some(ChannelId([0;32])), 6
+		);
+	}
+
+	#[test]
+	fn test_logging_with_multiple_wrapped_context() {
+		let logger = &TestLogger::new();
+		let secp_ctx = Secp256k1::new();
+		let pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
+		let context_logger = &WithContext::from(&logger, None, Some(ChannelId([0; 32])));
+		let full_context_logger = WithContext::from(&context_logger, Some(pk), None);
+		log_error!(full_context_logger, "This is an error");
+		log_warn!(full_context_logger, "This is an error");
+		log_debug!(full_context_logger, "This is an error");
+		log_trace!(full_context_logger, "This is an error");
+		log_gossip!(full_context_logger, "This is an error");
+		log_info!(full_context_logger, "This is an error");
+		logger.assert_log_context_contains(
+			"lightning::util::logger::tests", Some(pk), Some(ChannelId([0;32])), 6
+		);
+	}
+
 	#[test]
 	fn test_log_ordering() {
 		assert!(Level::Error > Level::Warn);