Sweep every first-party crate source (1956 .rs files) to the project comment guidelines: delete redundant restatements, decorative banners, change narration, and end-of-line comments; keep and tighten the crucial ones (invariants, bug rationale, SAFETY blocks, ported-source attribution). No functional code changed. Every edit is proven comment-only against the prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a separate doctest-fence check. Where removing a comment made rustfmt or clippy want to re-lay-out adjacent code, the minimal triggering comment is restored so code tokens stay byte-identical. Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy --workspace --all-targets (0 warnings). Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for these guidelines (flags banners, end-of-line comments, change narration, and commented-out code).
119 lines
3.7 KiB
Rust
119 lines
3.7 KiB
Rust
//! Memory system tracing target and optional file-based logging layer.
|
|
//!
|
|
//! Emit events with `tracing::info!(target: memory_log::TARGET, ...)` at memory
|
|
//! system lifecycle points — config resolution, storage init, flush, search.
|
|
//! They are always emitted, at zero cost when the layer is absent.
|
|
//!
|
|
//! ```bash
|
|
//! # build with memory logging enabled, then:
|
|
//! KIGI_MEMORY_LOG=0 kigi # disable even when enabled
|
|
//! tail -f ~/.kigi/logs/memory.log # watch in another terminal
|
|
//! ```
|
|
|
|
/// Tracing target for all memory system operations.
|
|
pub const TARGET: &str = "xai_memory";
|
|
|
|
#[cfg(feature = "memory-log")]
|
|
mod inner {
|
|
use std::fmt;
|
|
use std::path::PathBuf;
|
|
use std::sync::Mutex;
|
|
use std::time::Instant;
|
|
|
|
use tracing::Subscriber;
|
|
use tracing_subscriber::fmt::format::Writer;
|
|
use tracing_subscriber::fmt::time::FormatTime;
|
|
use tracing_subscriber::fmt::writer::BoxMakeWriter;
|
|
use tracing_subscriber::layer::Layer;
|
|
use tracing_subscriber::registry::LookupSpan;
|
|
|
|
use super::TARGET;
|
|
use kigi_config::kigi_home;
|
|
|
|
const ENV_MEMORY_LOG: &str = "KIGI_MEMORY_LOG";
|
|
|
|
static LOG_GUARD: std::sync::OnceLock<
|
|
Mutex<Option<tracing_appender::non_blocking::WorkerGuard>>,
|
|
> = std::sync::OnceLock::new();
|
|
|
|
#[derive(Clone)]
|
|
struct UptimeTimer {
|
|
epoch: Instant,
|
|
}
|
|
|
|
impl UptimeTimer {
|
|
fn new() -> Self {
|
|
Self {
|
|
epoch: Instant::now(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl FormatTime for UptimeTimer {
|
|
fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
|
|
let elapsed = self.epoch.elapsed();
|
|
write!(w, "+{}.{:03}s", elapsed.as_secs(), elapsed.subsec_millis())
|
|
}
|
|
}
|
|
|
|
/// Writes to `~/.kigi/logs/memory.log`, filtered to `xai_memory=trace`.
|
|
/// Set `KIGI_MEMORY_LOG=0` to disable, `KIGI_MEMORY_LOG=/path` to redirect.
|
|
pub fn layer<S>() -> Option<impl Layer<S>>
|
|
where
|
|
S: Subscriber + for<'span> LookupSpan<'span>,
|
|
{
|
|
let path = resolve_log_path()?;
|
|
|
|
if let Some(parent) = path.parent() {
|
|
let _ = std::fs::create_dir_all(parent);
|
|
}
|
|
|
|
let file = match std::fs::OpenOptions::new()
|
|
.create(true)
|
|
.append(true)
|
|
.open(&path)
|
|
{
|
|
Ok(f) => f,
|
|
Err(e) => {
|
|
tracing::warn!("[memory-log] Failed to open {:?}: {}", path, e);
|
|
return None;
|
|
}
|
|
};
|
|
|
|
let (non_blocking, guard) = tracing_appender::non_blocking(file);
|
|
let guard_slot = LOG_GUARD.get_or_init(|| Mutex::new(None));
|
|
if let Ok(mut slot) = guard_slot.lock() {
|
|
*slot = Some(guard);
|
|
}
|
|
|
|
let filter = tracing_subscriber::filter::EnvFilter::new(format!("{TARGET}=trace"));
|
|
let fmt_layer = tracing_subscriber::fmt::layer()
|
|
.with_target(true)
|
|
.with_ansi(false)
|
|
.with_thread_ids(true)
|
|
.with_timer(UptimeTimer::new())
|
|
.with_writer(BoxMakeWriter::new(non_blocking))
|
|
.with_filter(filter);
|
|
|
|
tracing::info!("[memory-log] Memory logging enabled");
|
|
Some(fmt_layer)
|
|
}
|
|
|
|
fn resolve_log_path() -> Option<PathBuf> {
|
|
let default_path = || kigi_home().join("logs").join("memory.log");
|
|
let raw = match std::env::var(ENV_MEMORY_LOG) {
|
|
Ok(val) => val,
|
|
Err(_) => return Some(default_path()),
|
|
};
|
|
let raw = raw.trim();
|
|
match raw {
|
|
"" | "0" | "false" | "off" | "no" => None,
|
|
"1" | "true" | "on" | "yes" => Some(default_path()),
|
|
path => Some(PathBuf::from(path)),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "memory-log")]
|
|
pub use inner::layer;
|