Skip to content

Commit 0b699e3

Browse files
author
Elias Rohrer
committed
Introduce GOSSIP log level to PeerHandler
1 parent 8d886ee commit 0b699e3

File tree

3 files changed

+37
-19
lines changed

3 files changed

+37
-19
lines changed

‎lightning/src/ln/peer_handler.rs‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -892,7 +892,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
892892
match e {
893893
msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
894894
msgs::DecodeError::UnknownRequiredFeature => {
895-
log_trace!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
895+
log_gossip!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
896896
continue;
897897
}
898898
msgs::DecodeError::InvalidValue => {
@@ -906,7 +906,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
906906
msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
907907
msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
908908
msgs::DecodeError::UnsupportedCompression => {
909-
log_trace!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
909+
log_gossip!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
910910
continue;
911911
}
912912
}
@@ -953,7 +953,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
953953
peer: &mut Peer,
954954
message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
955955
) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
956-
log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(peer.their_node_id.unwrap()));
956+
log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(peer.their_node_id.unwrap()));
957957
peer.received_message_since_timer_tick = true;
958958

959959
// Need an Init as first message
@@ -1120,7 +1120,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11201120
return Err(PeerHandleError{ no_connection_possible: true }.into());
11211121
},
11221122
wire::Message::Unknown(type_id) => {
1123-
log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1123+
log_gossip!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
11241124
},
11251125
wire::Message::Custom(custom) => {
11261126
self.custom_message_handler.handle_custom_message(custom, &peer.their_node_id.unwrap())?;
@@ -1132,7 +1132,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11321132
fn forward_broadcast_msg(&self, peers: &mut PeerHolder<Descriptor>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
11331133
match msg {
11341134
wire::Message::ChannelAnnouncement(ref msg) => {
1135-
log_trace!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1135+
log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
11361136
let encoded_msg = encode_msg!(msg);
11371137

11381138
for (_, peer) in peers.peers.iter_mut() {
@@ -1143,7 +1143,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11431143
if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
11441144
|| peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
11451145
{
1146-
log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1146+
log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
11471147
continue;
11481148
}
11491149
if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
@@ -1157,7 +1157,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11571157
}
11581158
},
11591159
wire::Message::NodeAnnouncement(ref msg) => {
1160-
log_trace!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1160+
log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
11611161
let encoded_msg = encode_msg!(msg);
11621162

11631163
for (_, peer) in peers.peers.iter_mut() {
@@ -1168,7 +1168,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11681168
if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
11691169
|| peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
11701170
{
1171-
log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1171+
log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
11721172
continue;
11731173
}
11741174
if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
@@ -1181,7 +1181,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11811181
}
11821182
},
11831183
wire::Message::ChannelUpdate(ref msg) => {
1184-
log_trace!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1184+
log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
11851185
let encoded_msg = encode_msg!(msg);
11861186

11871187
for (_, peer) in peers.peers.iter_mut() {
@@ -1192,7 +1192,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11921192
if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
11931193
|| peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
11941194
{
1195-
log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1195+
log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
11961196
continue;
11971197
}
11981198
if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
@@ -1358,7 +1358,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
13581358
}
13591359
},
13601360
MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1361-
log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1361+
log_gossip!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
13621362
log_pubkey!(node_id), msg.contents.short_channel_id);
13631363
let peer = get_peer_for_forwarding!(node_id);
13641364
peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
@@ -1369,15 +1369,15 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
13691369
if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
13701370
if let Some(mut peer) = peers.peers.remove(&descriptor) {
13711371
if let Some(ref msg) = *msg {
1372-
log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1372+
log_gossip!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
13731373
log_pubkey!(node_id),
13741374
msg.data);
13751375
self.enqueue_message(&mut peer, msg);
13761376
// This isn't guaranteed to work, but if there is enough free
13771377
// room in the send buffer, put the error message there...
13781378
self.do_attempt_write_data(&mut descriptor, &mut peer);
13791379
} else {
1380-
log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1380+
log_gossip!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
13811381
}
13821382
}
13831383
descriptor.disconnect_socket();
@@ -1391,7 +1391,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
13911391
log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
13921392
},
13931393
msgs::ErrorAction::SendErrorMessage { ref msg } => {
1394-
log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1394+
log_gossip!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
13951395
log_pubkey!(node_id),
13961396
msg.data);
13971397
self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
@@ -1405,7 +1405,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
14051405
self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
14061406
}
14071407
MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1408-
log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1408+
log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
14091409
log_pubkey!(node_id),
14101410
msg.short_channel_ids.len(),
14111411
msg.first_blocknum,

‎lightning/src/util/logger.rs‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
use core::cmp;
1818
use core::fmt;
1919

20-
static LOG_LEVEL_NAMES: [&'static str; 5] = ["TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
20+
static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
2121

2222
/// An enum representing the available verbosity levels of the logger.
2323
#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
2424
pub enum Level {
25+
/// Designates extremely verbose information, including gossip-induced messages
26+
Gossip,
2527
/// Designates very low priority, often extremely verbose, information
2628
Trace,
2729
/// Designates lower priority information
@@ -78,7 +80,7 @@ impl Level {
7880
/// Returns the most verbose logging level.
7981
#[inline]
8082
pub fn max() -> Level {
81-
Level::Trace
83+
Level::Gossip
8284
}
8385
}
8486

@@ -163,13 +165,14 @@ mod tests {
163165
log_info!(self.logger, "This is an info");
164166
log_debug!(self.logger, "This is a debug");
165167
log_trace!(self.logger, "This is a trace");
168+
log_gossip!(self.logger, "This is a gossip");
166169
}
167170
}
168171

169172
#[test]
170173
fn test_logging_macros() {
171174
let mut logger = TestLogger::new();
172-
logger.enable(Level::Trace);
175+
logger.enable(Level::Gossip);
173176
let logger : Arc<Logger> = Arc::new(logger);
174177
let wrapper = WrapperLog::new(Arc::clone(&logger));
175178
wrapper.call_macros();
@@ -189,7 +192,10 @@ mod tests {
189192
assert!(Level::Debug > Level::Trace);
190193
assert!(Level::Debug >= Level::Trace);
191194
assert!(Level::Debug >= Level::Debug);
192-
assert!(Level::Trace >= Level::Trace);
195+
assert!(Level::Trace > Level::Gossip);
196+
assert!(Level::Trace >= Level::Gossip);
197+
assert!(Level::Trace >= Level::Trace);
198+
assert!(Level::Gossip >= Level::Gossip);
193199

194200
assert!(Level::Error <= Level::Error);
195201
assert!(Level::Warn < Level::Error);
@@ -204,5 +210,8 @@ mod tests {
204210
assert!(Level::Trace < Level::Debug);
205211
assert!(Level::Trace <= Level::Debug);
206212
assert!(Level::Trace <= Level::Trace);
213+
assert!(Level::Gossip < Level::Trace);
214+
assert!(Level::Gossip <= Level::Trace);
215+
assert!(Level::Gossip <= Level::Gossip);
207216
}
208217
}

‎lightning/src/util/macro_logger.rs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,8 @@ macro_rules! log_given_level {
174174
$crate::util::logger::Level::Debug => log_internal!($logger, $lvl, $($arg)*),
175175
#[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug")))]
176176
$crate::util::logger::Level::Trace => log_internal!($logger, $lvl, $($arg)*),
177+
#[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug", feature = "max_level_trace")))]
178+
$crate::util::logger::Level::Gossip => log_internal!($logger, $lvl, $($arg)*),
177179

178180
#[cfg(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug"))]
179181
_ => {
@@ -216,3 +218,10 @@ macro_rules! log_trace {
216218
log_given_level!($logger, $crate::util::logger::Level::Trace, $($arg)*)
217219
)
218220
}
221+
222+
/// Log a gossip log.
223+
macro_rules! log_gossip {
224+
($logger: expr, $($arg:tt)*) => (
225+
log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
226+
)
227+
}

0 commit comments

Comments
 (0)