Skip to content

Commit

Permalink
deps(udp): make tracing optional and add optional log
Browse files Browse the repository at this point in the history
This commit makes the `tracing` dependency in `quinn-udp` optional, but enabled
by default. In additional it adds optional logging via `log`. `tracing` takes
precedence over `log`.
  • Loading branch information
mxinden committed Jul 18, 2024
1 parent 2f197c0 commit 91a667c
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 7 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ futures-io = "0.3.19"
hdrhistogram = { version = "7.2", default-features = false }
hex-literal = "0.4"
lazy_static = "1"
log = "0.4"
once_cell = "1.19"
pin-project-lite = "0.2"
rand = "0.8"
Expand Down
8 changes: 4 additions & 4 deletions quinn-udp/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ workspace = ".."
all-features = true

[features]
default = ["log"]
# Write logs via the `log` crate when no `tracing` subscriber exists
log = ["tracing/log"]
default = ["tracing-log"]
tracing-log = ["tracing", "tracing/log"]

[dependencies]
libc = "0.2.113"
log = { workspace = true, optional = true }
socket2 = { workspace = true }
tracing = { workspace = true }
tracing = { workspace = true, optional = true }

[target.'cfg(windows)'.dependencies]
once_cell = { workspace = true }
Expand Down
8 changes: 8 additions & 0 deletions quinn-udp/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ use std::{
time::{Duration, Instant},
};

#[cfg(all(feature = "log", not(feature = "tracing")))]
use log::warn;
#[cfg(feature = "tracing")]
use tracing::warn;

#[cfg(any(unix, windows))]
Expand Down Expand Up @@ -126,6 +129,7 @@ const IO_ERROR_LOG_INTERVAL: Duration = std::time::Duration::from_secs(60);
///
/// Logging will only be performed if at least [`IO_ERROR_LOG_INTERVAL`]
/// has elapsed since the last error was logged.
#[cfg(any(feature = "tracing", feature = "log"))]
fn log_sendmsg_error(
last_send_error: &Mutex<Instant>,
err: impl core::fmt::Debug,
Expand All @@ -141,6 +145,10 @@ fn log_sendmsg_error(
}
}

// No-op
#[cfg(not(any(feature = "tracing", feature = "log")))]
fn log_sendmsg_error(_: &Mutex<Instant>, _: impl core::fmt::Debug, _: &Transmit) {}

/// A borrowed UDP socket
///
/// On Unix, constructible via `From<T: AsFd>`. On Windows, constructible via `From<T:
Expand Down
8 changes: 7 additions & 1 deletion quinn-udp/src/unix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ use std::{
time::Instant,
};

#[cfg(all(feature = "log", not(feature = "tracing")))]
use log::{debug, error};
use socket2::SockRef;
#[cfg(feature = "tracing")]
use tracing::{debug, error};

use super::{
Expand Down Expand Up @@ -86,9 +89,11 @@ impl UdpSocketState {
// older macos versions also don't have the flag and will error out if we don't ignore it
#[cfg(not(any(target_os = "openbsd", target_os = "netbsd")))]
if is_ipv4 || !io.only_v6()? {
#[allow(unused_variables)]
if let Err(err) = set_socket_option(&*io, libc::IPPROTO_IP, libc::IP_RECVTOS, OPTION_ON)
{
debug!("Ignoring error setting IP_RECVTOS on socket: {err:?}",);
#[cfg(any(feature = "tracing", feature = "log"))]
debug!("Ignoring error setting IP_RECVTOS on socket: {err:?}");
}
}

Expand Down Expand Up @@ -284,6 +289,7 @@ fn send(
// Prevent new transmits from being scheduled using GSO. Existing GSO transmits
// may already be in the pipeline, so we need to tolerate additional failures.
if state.max_gso_segments() > 1 {
#[cfg(any(feature = "tracing", feature = "log"))]
error!("got transmit error, halting segmentation offload");
state
.max_gso_segments
Expand Down
4 changes: 2 additions & 2 deletions quinn/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ runtime-async-std = ["async-io", "async-std"]
runtime-smol = ["async-io", "smol"]

# Write logs via the `log` crate when no `tracing` subscriber exists
log = ["tracing/log", "proto/log", "udp/log"]
log = ["tracing/log", "proto/log", "udp/tracing-log"]

[dependencies]
async-io = { workspace = true, optional = true }
Expand All @@ -45,7 +45,7 @@ socket2 = { workspace = true }
thiserror = { workspace = true }
tracing = { workspace = true }
tokio = { workspace = true }
udp = { package = "quinn-udp", path = "../quinn-udp", version = "0.5", default-features = false }
udp = { package = "quinn-udp", path = "../quinn-udp", version = "0.5", default-features = false, features = ["tracing"] }

[dev-dependencies]
anyhow = { workspace = true }
Expand Down

0 comments on commit 91a667c

Please sign in to comment.