Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change(log): Silence verbose failed connection logs #8072

Merged
merged 2 commits into from
Dec 7, 2023
Merged

change(log): Silence verbose failed connection logs #8072

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d99968a
Silence verbose failed connection logs
teor2345 Dec 6, 2023
7a51714
Update comment and fix formatting
teor2345 Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions zebra-network/src/peer_set/initialize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,10 +863,8 @@ where

// Increment the connection count before we spawn the connection.
let outbound_connection_tracker = active_outbound_connections.track_connection();
debug!(
outbound_connections = ?active_outbound_connections.update_count(),
"opening an outbound peer connection"
);
let outbound_connections = active_outbound_connections.update_count();
debug!(?outbound_connections, "opening an outbound peer connection");

// Spawn each handshake or crawl into an independent task, so handshakes can make
// progress while crawls are running.
Expand All @@ -892,6 +890,7 @@ where
candidate,
outbound_connector,
outbound_connection_tracker,
outbound_connections,
peerset_tx,
address_book_updater,
demand_tx,
Expand Down Expand Up @@ -1026,6 +1025,7 @@ where
#[instrument(skip(
outbound_connector,
outbound_connection_tracker,
outbound_connections,
peerset_tx,
address_book_updater,
demand_tx
Expand All @@ -1034,6 +1034,7 @@ async fn dial<C>(
candidate: MetaAddr,
mut outbound_connector: C,
outbound_connection_tracker: ConnectionTracker,
outbound_connections: usize,
mut peerset_tx: futures::channel::mpsc::Sender<DiscoveredPeer>,
address_book_updater: tokio::sync::mpsc::Sender<MetaAddrChange>,
mut demand_tx: futures::channel::mpsc::Sender<MorePeers>,
Expand All @@ -1048,6 +1049,10 @@ where
+ 'static,
C::Future: Send + 'static,
{
// If Zebra only has a few connections, we log connection failures at info level,
// so users can diagnose and fix the problem. This defines the threshold for info logs.
const MAX_CONNECTIONS_FOR_INFO_LOG: usize = 5;

// # Correctness
//
// To avoid hangs, the dialer must only await:
Expand Down Expand Up @@ -1076,7 +1081,13 @@ where
}
// The connection was never opened, or it failed the handshake and was dropped.
Err(error) => {
info!(?error, ?candidate.addr, "failed to make outbound connection to peer");
// Silence verbose info logs in production, but keep logs if the number of connections is low.
// Also silence them completely in tests.
if outbound_connections <= MAX_CONNECTIONS_FOR_INFO_LOG && !cfg!(test) {
info!(?error, ?candidate.addr, "failed to make outbound connection to peer");
} else {
debug!(?error, ?candidate.addr, "failed to make outbound connection to peer");
}
report_failed(address_book_updater.clone(), candidate).await;

// The demand signal that was taken out of the queue to attempt to connect to the
Expand Down
Loading