//! The second one, client-side by implementing check against Record Level field.
//! Each module may have its own Logger or share one.
-use std::cmp;
-use std::fmt;
+use bitcoin::secp256k1::PublicKey;
-static LOG_LEVEL_NAMES: [&'static str; 6] = ["OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE"];
+use core::cmp;
+use core::fmt;
+use core::ops::Deref;
+
+use crate::ln::ChannelId;
+#[cfg(c_bindings)]
+use crate::prelude::*; // Needed for String
+
+static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
/// An enum representing the available verbosity levels of the logger.
#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
pub enum Level {
- ///Designates logger being silent
- Off,
- /// Designates very serious errors
- Error,
- /// Designates hazardous situations
- Warn,
- /// Designates useful information
- Info,
- /// Designates lower priority information
- Debug,
+ /// Designates extremely verbose information, including gossip-induced messages
+ Gossip,
/// Designates very low priority, often extremely verbose, information
Trace,
+ /// Designates lower priority information
+ Debug,
+ /// Designates useful information
+ Info,
+ /// Designates hazardous situations
+ Warn,
+ /// Designates very serious errors
+ Error,
}
impl PartialOrd for Level {
/// Returns the most verbose logging level.
#[inline]
pub fn max() -> Level {
- Level::Trace
+ Level::Gossip
}
}
/// A Record, unit of logging output with Metadata to enable filtering
/// Module_path, file, line to inform on log's source
-#[derive(Clone,Debug)]
+#[derive(Clone, Debug)]
pub struct Record<'a> {
/// The verbosity level of the message.
pub level: Level,
+ /// The node id of the peer pertaining to the logged record.
+ 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.
+ pub channel_id: Option<ChannelId>,
+ #[cfg(not(c_bindings))]
/// The message body.
pub args: fmt::Arguments<'a>,
+ #[cfg(c_bindings)]
+ /// The message body.
+ pub args: String,
/// The module path of the message.
- pub module_path: &'a str,
+ pub module_path: &'static str,
/// The source file containing the message.
- pub file: &'a str,
+ pub file: &'static str,
/// The line containing the message.
pub line: u32,
+
+ #[cfg(c_bindings)]
+ /// We don't actually use the lifetime parameter in C bindings (as there is no good way to
+ /// communicate a lifetime to a C, or worse, Java user).
+ _phantom: core::marker::PhantomData<&'a ()>,
}
impl<'a> Record<'a> {
/// Returns a new Record.
+ ///
+ /// This is not exported to bindings users as fmt can't be used in C
#[inline]
- pub fn new(level: Level, args: fmt::Arguments<'a>, module_path: &'a str, file: &'a str, line: u32) -> Record<'a> {
+ pub fn new(
+ level: Level, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>,
+ args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32
+ ) -> Record<'a> {
Record {
level,
+ peer_id,
+ channel_id,
+ #[cfg(not(c_bindings))]
args,
+ #[cfg(c_bindings)]
+ args: format!("{}", args),
module_path,
file,
- line
+ line,
+ #[cfg(c_bindings)]
+ _phantom: core::marker::PhantomData,
}
}
}
-/// A trait encapsulating the operations required of a logger
-pub trait Logger: Sync + Send {
- /// Logs the `Record`
- fn log(&self, record: &Record);
+/// A trait encapsulating the operations required of a logger.
+pub trait Logger {
+ /// Logs the [`Record`].
+ 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
+#[doc(hidden)]
+pub struct DebugPubKey<'a>(pub &'a PublicKey);
+impl<'a> core::fmt::Display for DebugPubKey<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ for i in self.0.serialize().iter() {
+ write!(f, "{:02x}", i)?;
+ }
+ Ok(())
+ }
+}
+
+/// Wrapper for logging byte slices in hex format.
+///
+/// This is not exported to bindings users as fmt can't be used in C
+#[doc(hidden)]
+pub struct DebugBytes<'a>(pub &'a [u8]);
+impl<'a> core::fmt::Display for DebugBytes<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ for i in self.0 {
+ write!(f, "{:02x}", i)?;
+ }
+ Ok(())
+ }
+}
+
+/// Wrapper for logging `Iterator`s.
+///
+/// This is not exported to bindings users as fmt can't be used in C
+#[doc(hidden)]
+pub struct DebugIter<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone>(pub I);
+impl<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone> fmt::Display for DebugIter<T, I> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+ write!(f, "[")?;
+ let mut iter = self.0.clone();
+ if let Some(item) = iter.next() {
+ write!(f, "{}", item)?;
+ }
+ while let Some(item) = iter.next() {
+ write!(f, ", {}", item)?;
+ }
+ write!(f, "]")?;
+ Ok(())
+ }
}
#[cfg(test)]
mod tests {
- use util::logger::{Logger, Level};
- use util::test_utils::TestLogger;
- use std::sync::Arc;
+ 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;
#[test]
fn test_level_show() {
log_info!(self.logger, "This is an info");
log_debug!(self.logger, "This is a debug");
log_trace!(self.logger, "This is a trace");
+ log_gossip!(self.logger, "This is a gossip");
}
}
#[test]
fn test_logging_macros() {
let mut logger = TestLogger::new();
- logger.enable(Level::Trace);
+ logger.enable(Level::Gossip);
let logger : Arc<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);
+ assert!(Level::Error >= Level::Warn);
+ assert!(Level::Error >= Level::Error);
+ assert!(Level::Warn > Level::Info);
+ assert!(Level::Warn >= Level::Info);
+ assert!(Level::Warn >= Level::Warn);
+ assert!(Level::Info > Level::Debug);
+ assert!(Level::Info >= Level::Debug);
+ assert!(Level::Info >= Level::Info);
+ assert!(Level::Debug > Level::Trace);
+ assert!(Level::Debug >= Level::Trace);
+ assert!(Level::Debug >= Level::Debug);
+ assert!(Level::Trace > Level::Gossip);
+ assert!(Level::Trace >= Level::Gossip);
+ assert!(Level::Trace >= Level::Trace);
+ assert!(Level::Gossip >= Level::Gossip);
+
+ assert!(Level::Error <= Level::Error);
+ assert!(Level::Warn < Level::Error);
+ assert!(Level::Warn <= Level::Error);
+ assert!(Level::Warn <= Level::Warn);
+ assert!(Level::Info < Level::Warn);
+ assert!(Level::Info <= Level::Warn);
+ assert!(Level::Info <= Level::Info);
+ assert!(Level::Debug < Level::Info);
+ assert!(Level::Debug <= Level::Info);
+ assert!(Level::Debug <= Level::Debug);
+ assert!(Level::Trace < Level::Debug);
+ assert!(Level::Trace <= Level::Debug);
+ assert!(Level::Trace <= Level::Trace);
+ assert!(Level::Gossip < Level::Trace);
+ assert!(Level::Gossip <= Level::Trace);
+ assert!(Level::Gossip <= Level::Gossip);
+ }
}
projects / rust-lightning / blobdiff