Skip to content

Commit 804df89

Browse files
kantaikantai
committed
chore: logging niceties
A selection of logging cleanup: 1. Narrower thread names: use the bind port rather than the whole bind addr. 2. Downgrade mempool reject to debug. 3. Use message_description in HTTP handler log line 4. Narrow local peer name 5. Downgrade unconfigured stackerdb chunk receipt
1 parent 59213ab commit 804df89

File tree

7 files changed

+58
-43
lines changed

7 files changed

+58
-43
lines changed

‎stackslib/src/config/mod.rs

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2468,13 +2468,24 @@ impl Default for NodeConfig {
24682468
impl NodeConfig {
24692469
/// Get a SocketAddr for this node's RPC endpoint which uses the loopback address
24702470
pub fn get_rpc_loopback(&self) -> Option<SocketAddr> {
2471-
let rpc_port = SocketAddr::from_str(&self.rpc_bind)
2472-
.map_err(|e| {
2471+
let rpc_port = self.rpc_bind_addr()?.port();
2472+
Some(SocketAddr::new(Ipv4Addr::LOCALHOST.into(), rpc_port))
2473+
}
2474+
2475+
pub fn rpc_bind_addr(&self) -> Option<SocketAddr> {
2476+
SocketAddr::from_str(&self.rpc_bind)
2477+
.inspect_err(|e| {
24732478
error!("Could not parse node.rpc_bind configuration setting as SocketAddr: {e}");
24742479
})
2475-
.ok()?
2476-
.port();
2477-
Some(SocketAddr::new(Ipv4Addr::LOCALHOST.into(), rpc_port))
2480+
.ok()
2481+
}
2482+
2483+
pub fn p2p_bind_addr(&self) -> Option<SocketAddr> {
2484+
SocketAddr::from_str(&self.p2p_bind)
2485+
.inspect_err(|e| {
2486+
error!("Could not parse node.rpc_bind configuration setting as SocketAddr: {e}");
2487+
})
2488+
.ok()
24782489
}
24792490

24802491
pub fn add_signers_stackerdbs(&mut self, is_mainnet: bool) {

‎stackslib/src/net/db.rs

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -103,29 +103,17 @@ pub struct LocalPeer {
103103

104104
impl fmt::Display for LocalPeer {
105105
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
106-
write!(
107-
f,
108-
"local.{:x}://(bind={:?})(pub={:?})",
109-
self.network_id,
110-
&self.addrbytes.to_socketaddr(self.port),
111-
&self
112-
.public_ip_address
113-
.map(|(ref addrbytes, ref port)| addrbytes.to_socketaddr(*port))
114-
)
106+
write!(f, "local::{}", self.port)?;
107+
match &self.public_ip_address {
108+
None => Ok(()),
109+
Some((addr, port)) => write!(f, "::pub={}", addr.to_socketaddr(*port)),
110+
}
115111
}
116112
}
117113

118114
impl fmt::Debug for LocalPeer {
119115
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
120-
write!(
121-
f,
122-
"local.{:x}://(bind={:?})(pub={:?})",
123-
self.network_id,
124-
&self.addrbytes.to_socketaddr(self.port),
125-
&self
126-
.public_ip_address
127-
.map(|(ref addrbytes, ref port)| addrbytes.to_socketaddr(*port))
128-
)
116+
write!(f, "{self}")
129117
}
130118
}
131119

‎stackslib/src/net/p2p.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5260,7 +5260,7 @@ impl PeerNetwork {
52605260
&stacks_epoch.block_limit,
52615261
&stacks_epoch.epoch_id,
52625262
) {
5263-
info!("Transaction rejected from mempool, {}", &e.into_json(&txid));
5263+
debug!("Transaction rejected from mempool, {}", &e.into_json(&txid));
52645264
return false;
52655265
}
52665266

‎stackslib/src/net/relay.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2459,19 +2459,19 @@ impl Relayer {
24592459
// forward if not stale
24602460
if chunk.rc_consensus_hash != *rc_consensus_hash {
24612461
debug!("Drop stale uploaded StackerDB chunk";
2462-
"stackerdb_contract_id" => &format!("{}", &chunk.contract_id),
2462+
"stackerdb_contract_id" => %chunk.contract_id,
24632463
"slot_id" => chunk.chunk_data.slot_id,
24642464
"slot_version" => chunk.chunk_data.slot_version,
24652465
"chunk.rc_consensus_hash" => %chunk.rc_consensus_hash,
24662466
"network.rc_consensus_hash" => %rc_consensus_hash);
24672467
continue;
24682468
}
24692469

2470-
debug!("Got uploaded StackerDB chunk"; "stackerdb_contract_id" => &format!("{}", &chunk.contract_id), "slot_id" => chunk.chunk_data.slot_id, "slot_version" => chunk.chunk_data.slot_version);
2470+
debug!("Got uploaded StackerDB chunk"; "stackerdb_contract_id" => %chunk.contract_id, "slot_id" => chunk.chunk_data.slot_id, "slot_version" => chunk.chunk_data.slot_version);
24712471

24722472
let msg = StacksMessageType::StackerDBPushChunk(chunk);
24732473
if let Err(e) = self.p2p.broadcast_message(vec![], msg) {
2474-
warn!("Failed to broadcast Nakamoto blocks: {:?}", &e);
2474+
warn!("Failed to broadcast Nakamoto blocks: {e:?}");
24752475
}
24762476
}
24772477
for (contract_id, new_chunks) in all_events.into_iter() {
@@ -2516,7 +2516,7 @@ impl Relayer {
25162516
// to distinguish it from other message types.
25172517
debug!(
25182518
"Dropping stale StackerDB chunk";
2519-
"stackerdb_contract_id" => &format!("{}", &sync_result.contract_id),
2519+
"stackerdb_contract_id" => %sync_result.contract_id,
25202520
"slot_id" => md.slot_id,
25212521
"slot_version" => md.slot_version,
25222522
"num_bytes" => chunk.data.len(),
@@ -2525,7 +2525,7 @@ impl Relayer {
25252525
} else {
25262526
warn!(
25272527
"Failed to store chunk for StackerDB";
2528-
"stackerdb_contract_id" => &format!("{}", &sync_result.contract_id),
2528+
"stackerdb_contract_id" => %sync_result.contract_id,
25292529
"slot_id" => md.slot_id,
25302530
"slot_version" => md.slot_version,
25312531
"num_bytes" => chunk.data.len(),
@@ -2534,7 +2534,7 @@ impl Relayer {
25342534
}
25352535
continue;
25362536
} else {
2537-
debug!("Stored chunk"; "stackerdb_contract_id" => &format!("{}", &sync_result.contract_id), "slot_id" => md.slot_id, "slot_version" => md.slot_version);
2537+
debug!("Stored chunk"; "stackerdb_contract_id" => %sync_result.contract_id, "slot_id" => md.slot_id, "slot_version" => md.slot_version);
25382538
}
25392539

25402540
if let Some(event_list) = all_events.get_mut(&sync_result.contract_id) {
@@ -2548,13 +2548,13 @@ impl Relayer {
25482548
chunk_data: chunk,
25492549
});
25502550
if let Err(e) = self.p2p.broadcast_message(vec![], msg) {
2551-
warn!("Failed to broadcast StackerDB chunk: {:?}", &e);
2551+
warn!("Failed to broadcast StackerDB chunk: {e:?}");
25522552
}
25532553
}
25542554
}
25552555
tx.commit()?;
25562556
} else {
2557-
info!("Got chunks for unconfigured StackerDB replica"; "stackerdb_contract_id" => &format!("{}", &sc));
2557+
debug!("Got chunks for unconfigured StackerDB replica"; "stackerdb_contract_id" => %sc);
25582558
}
25592559
}
25602560

@@ -2579,7 +2579,7 @@ impl Relayer {
25792579
let sync_results = stackerdb_chunks
25802580
.into_iter()
25812581
.map(|chunk_data| {
2582-
debug!("Received pushed StackerDB chunk {:?}", &chunk_data);
2582+
debug!("Received pushed StackerDB chunk {chunk_data:?}");
25832583
let sync_result = StackerDBSyncResult::from_pushed_chunk(chunk_data);
25842584
sync_result
25852585
})

‎stackslib/src/net/rpc.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,14 +548,19 @@ impl ConversationHttp {
548548
|conv_http, req| conv_http.handle_request(req, node),
549549
)?;
550550

551+
let msg_opt_log = if let Some(ref msg) = msg_opt {
552+
msg.get_message_description()
553+
} else {
554+
"None".into()
555+
};
551556
info!("Handled StacksHTTPRequest";
552557
"verb" => %verb,
553558
"path" => %request_path,
554559
"processing_time_ms" => start_time.elapsed().as_millis(),
555560
"latency_ms" => latency,
556561
"conn_id" => self.conn_id,
557562
"peer_addr" => &self.peer_addr,
558-
"p2p_msg" => ?msg_opt);
563+
"p2p_msg" => msg_opt_log);
559564

560565
if let Some(msg) = msg_opt {
561566
ret.push(msg);

‎testnet/stacks-node/src/nakamoto_node.rs

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -250,22 +250,31 @@ impl StacksNode {
250250

251251
StacksNode::set_monitoring_miner_address(&keychain, &relayer_thread);
252252

253+
let relayer_thread_name = format!("relayer:{}", local_peer.port);
253254
let relayer_thread_handle = thread::Builder::new()
254-
.name(format!("relayer-{}", &local_peer.data_url))
255+
.name(relayer_thread_name)
255256
.stack_size(BLOCK_PROCESSOR_STACK_SIZE)
256257
.spawn(move || {
257258
relayer_thread.main(relay_recv);
258259
})
259260
.expect("FATAL: failed to start relayer thread");
260261

262+
let p2p_port = config
263+
.node
264+
.p2p_bind_addr()
265+
.unwrap_or_else(|| panic!("Failed to parse socket: {}", &config.node.p2p_bind))
266+
.port();
267+
let rpc_port = config
268+
.node
269+
.rpc_bind_addr()
270+
.unwrap_or_else(|| panic!("Failed to parse socket: {}", &config.node.rpc_bind))
271+
.port();
272+
261273
let p2p_event_dispatcher = runloop.get_event_dispatcher();
262274
let p2p_thread = PeerThread::new(runloop, p2p_net);
263275
let p2p_thread_handle = thread::Builder::new()
264276
.stack_size(BLOCK_PROCESSOR_STACK_SIZE)
265-
.name(format!(
266-
"p2p-({},{})",
267-
&config.node.p2p_bind, &config.node.rpc_bind
268-
))
277+
.name(format!("p2p:({p2p_port},{rpc_port})"))
269278
.spawn(move || {
270279
p2p_thread.main(p2p_event_dispatcher);
271280
})

‎testnet/stacks-node/src/run_loop/nakamoto.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -306,11 +306,13 @@ impl RunLoop {
306306
let coordinator_indexer =
307307
make_bitcoin_indexer(&self.config, Some(self.should_keep_running.clone()));
308308

309+
let rpc_port = moved_config
310+
.node
311+
.rpc_bind_addr()
312+
.unwrap_or_else(|| panic!("Failed to parse socket: {}", &moved_config.node.rpc_bind))
313+
.port();
309314
let coordinator_thread_handle = thread::Builder::new()
310-
.name(format!(
311-
"chains-coordinator-{}",
312-
&moved_config.node.rpc_bind
313-
))
315+
.name(format!("chains-coordinator:{rpc_port}"))
314316
.stack_size(BLOCK_PROCESSOR_STACK_SIZE)
315317
.spawn(move || {
316318
debug!(

0 commit comments

Comments
 (0)