Skip to content

Validate quiver otel_* event names at compile time #2977

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

Open
cijothomas wants to merge 3 commits into
base: main
Choose a base branch
from
+56 −20
Open

Validate quiver otel_* event names at compile time #2977

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cd6868
Validate quiver otel_* event names at compile time
cijothomas May 14, 2026
1a534e7
Merge branch 'main' into validate-quiver-event-names
cijothomas May 18, 2026
1b83cc2
Merge branch 'main' into validate-quiver-event-names
cijothomas May 19, 2026
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
76 changes: 56 additions & 20 deletions rust/otap-dataflow/crates/quiver/src/logging.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,32 @@
//! otel_debug!("quiver.wal.replay", status = "stopped_incomplete");
//! ```

/// Compile-time validator for event names used by the crate-local
/// `otel_info!` / `otel_warn!` / `otel_debug!` / `otel_error!` /
/// `otel_event!` macros.
///
/// Event names must be short, stable identifiers (e.g. `quiver.wal.rotate`)
/// — not free-form sentences. This function is called from a `const`
/// context so any violation surfaces as a compile error at the macro call
/// site, not at runtime.
///
/// Rules enforced:
/// - non-empty
/// - no ASCII whitespace (space, tab, newline, carriage return)
pub(crate) const fn validate_event_name(name: &str) {
let bytes = name.as_bytes();
assert!(!bytes.is_empty(), "otel event name must not be empty");
let mut i = 0;
while i < bytes.len() {
let b = bytes[i];
assert!(
b != b' ' && b != b'\t' && b != b'\n' && b != b'\r',
"otel event name must not contain whitespace; use a short stable identifier (e.g. \"component.action\")"
);
i += 1;
}
}

/// Macro for logging informational messages with a required event name.
///
/// # Arguments
Expand All @@ -125,12 +151,14 @@
/// ```
#[allow(unused_macro_rules)]
macro_rules! otel_info {
($name:expr, $($fields:tt)+) => {
($name:expr, $($fields:tt)+) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::info!(name: $name, target: env!("CARGO_PKG_NAME"), $($fields)+);
};
($name:expr) => {
}};
($name:expr) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::info!(name: $name, target: env!("CARGO_PKG_NAME"), "");
};
}};
}

/// Macro for logging warning messages with a required event name.
Expand All @@ -149,12 +177,14 @@ macro_rules! otel_info {
/// ```
#[allow(unused_macro_rules)]
macro_rules! otel_warn {
($name:expr, $($fields:tt)+) => {
($name:expr, $($fields:tt)+) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::warn!(name: $name, target: env!("CARGO_PKG_NAME"), $($fields)+);
};
($name:expr) => {
}};
($name:expr) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::warn!(name: $name, target: env!("CARGO_PKG_NAME"), "");
};
}};
}

/// Macro for logging error messages with a required event name.
Expand All @@ -172,12 +202,14 @@ macro_rules! otel_warn {
/// ```
#[allow(unused_macro_rules)]
macro_rules! otel_error {
($name:expr, $($fields:tt)+) => {
($name:expr, $($fields:tt)+) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::error!(name: $name, target: env!("CARGO_PKG_NAME"), $($fields)+);
};
($name:expr) => {
}};
($name:expr) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::error!(name: $name, target: env!("CARGO_PKG_NAME"), "");
};
}};
}

/// Macro for logging debug messages with a required event name.
Expand All @@ -193,12 +225,14 @@ macro_rules! otel_error {
/// ```
#[allow(unused_macro_rules)]
macro_rules! otel_debug {
($name:expr, $($fields:tt)+) => {
($name:expr, $($fields:tt)+) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::debug!(name: $name, target: env!("CARGO_PKG_NAME"), $($fields)+);
};
($name:expr) => {
}};
($name:expr) => {{
const _: () = $crate::logging::validate_event_name($name);
tracing::debug!(name: $name, target: env!("CARGO_PKG_NAME"), "");
};
}};
}

/// Macro for logging messages at a runtime-selectable severity level.
Expand All @@ -223,7 +257,8 @@ macro_rules! otel_debug {
// otel_event! may not be used yet in production code within this crate; suppress the lint.
#[allow(unused_macros)]
macro_rules! otel_event {
($level:expr, $name:expr, $($fields:tt)+) => {
($level:expr, $name:expr, $($fields:tt)+) => {{
const _: () = $crate::logging::validate_event_name($name);
match $level {
tracing::Level::TRACE => {
tracing::trace!(name: $name, target: env!("CARGO_PKG_NAME"), $($fields)+);
Expand All @@ -241,8 +276,9 @@ macro_rules! otel_event {
tracing::error!(name: $name, target: env!("CARGO_PKG_NAME"), $($fields)+);
}
}
};
($level:expr, $name:expr) => {
}};
($level:expr, $name:expr) => {{
const _: () = $crate::logging::validate_event_name($name);
match $level {
tracing::Level::TRACE => {
tracing::trace!(name: $name, target: env!("CARGO_PKG_NAME"), "");
Expand All @@ -260,7 +296,7 @@ macro_rules! otel_event {
tracing::error!(name: $name, target: env!("CARGO_PKG_NAME"), "");
}
}
};
}};
}

// Make macros available within this crate only (no #[macro_export])
Expand Down
Loading