feat(perf): live runtime logs tab in Performance Probe (#946)

* feat(perf): live runtime logs tab in Performance Probe

Add a Logs tab that streams the backend runtime log ring buffer in-app, so the
stdout/stderr console (unreachable on Windows without exporting) can be read
live. The buffer now tracks a monotonic seq; a new tail_runtime_logs command
returns lines incrementally and get_logging_mode reports the current depth.

The tab has a depth switch (off/normal/debug) mirroring app settings, a line cap
(500-5000), pause/clear, auto-follow, and an ordered comma-separated word filter
where a plain word includes and a -word excludes, applied left to right as
layers (sequence matters).

* docs(changelog): note Performance Probe logs tab (PR #946)

Add CHANGELOG entry and credits line for the live runtime logs tab.

* fix(perf): pin log view position when scrolled up

Auto-scroll keeps the logs tab at the tail, but once the user scrolls up the
view now stays put — the previously-topmost line is re-pinned each tick while
the log keeps appending below for further scrolling. History under the viewport
is no longer trimmed while scrolled up (kept up to the ring-buffer ceiling); the
cap is re-applied when following resumes. Buffer overflow is shown in the status
line instead of an injected marker row.

* fix(perf): scope logs tab to its own internal scroll

The whole probe body scrolled (controls + filter + log) because the log
container sized via height:100%, which WebKitGTK does not resolve against the
flex body. Make the body a flex column with hidden overflow on the Logs tab and
let the log view flex-fill, so depth/keep/pause/clear and the filter stay fixed
while only the log lines scroll.
This commit is contained in:
cucadmuh
2026-06-02 11:40:36 +03:00
committed by GitHub
parent c6df05e576
commit 975bb6d9af
12 changed files with 666 additions and 17 deletions
+71 -9
View File
@@ -8,7 +8,7 @@
use std::collections::VecDeque;
use std::io::Write;
use std::sync::{Mutex, OnceLock};
use std::sync::atomic::{AtomicU8, Ordering};
use std::sync::atomic::{AtomicU8, AtomicU64, Ordering};
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
@@ -21,8 +21,31 @@ pub enum LoggingMode {
static LOGGING_MODE: AtomicU8 = AtomicU8::new(LoggingMode::Normal as u8);
const LOG_BUFFER_MAX_LINES: usize = 20_000;
fn log_buffer() -> &'static Mutex<VecDeque<String>> {
static LOG_BUFFER: OnceLock<Mutex<VecDeque<String>>> = OnceLock::new();
/// Monotonic sequence assigned to each appended line; lets the UI tail
/// incrementally (request only lines newer than the last seq it has seen).
static LOG_SEQ: AtomicU64 = AtomicU64::new(0);
/// A single buffered log line plus its monotonic sequence number.
#[derive(Clone, Debug)]
pub struct LogLine {
pub seq: u64,
pub text: String,
}
/// Result of an incremental tail request.
#[derive(Clone, Debug, Default)]
pub struct LogTail {
pub lines: Vec<LogLine>,
/// Sequence to pass back on the next request (highest seq known, even if no
/// new lines were returned).
pub last_seq: u64,
/// True when the caller's `after_seq` predates the retained window, i.e. some
/// lines were dropped from the ring buffer before they could be delivered.
pub dropped: bool,
}
fn log_buffer() -> &'static Mutex<VecDeque<LogLine>> {
static LOG_BUFFER: OnceLock<Mutex<VecDeque<LogLine>>> = OnceLock::new();
LOG_BUFFER.get_or_init(|| Mutex::new(VecDeque::with_capacity(LOG_BUFFER_MAX_LINES)))
}
@@ -52,6 +75,15 @@ pub fn set_logging_mode_from_str(mode: &str) -> Result<(), String> {
Ok(())
}
/// Current logging mode as a stable lowercase string for the UI.
pub fn current_mode_str() -> &'static str {
match current_mode() {
LoggingMode::Off => "off",
LoggingMode::Normal => "normal",
LoggingMode::Debug => "debug",
}
}
fn current_mode() -> LoggingMode {
match LOGGING_MODE.load(Ordering::Acquire) {
0 => LoggingMode::Off,
@@ -69,12 +101,14 @@ pub fn should_log_debug() -> bool {
}
pub fn append_log_line(line: String) {
let mut buf = log_buffer().lock().unwrap();
if buf.len() >= LOG_BUFFER_MAX_LINES {
buf.pop_front();
let seq = LOG_SEQ.fetch_add(1, Ordering::Relaxed) + 1;
{
let mut buf = log_buffer().lock().unwrap();
if buf.len() >= LOG_BUFFER_MAX_LINES {
buf.pop_front();
}
buf.push_back(LogLine { seq, text: line.clone() });
}
buf.push_back(line.clone());
drop(buf);
let path = cli_log_channel_path();
if let Some(parent) = path.parent() {
let _ = std::fs::create_dir_all(parent);
@@ -84,13 +118,41 @@ pub fn append_log_line(line: String) {
}
}
/// Return retained log lines with `seq > after_seq`, capped to `max` (most
/// recent kept). Pass `after_seq = None` to fetch the latest `max` lines.
pub fn tail_logs(after_seq: Option<u64>, max: usize) -> LogTail {
let max = max.clamp(1, LOG_BUFFER_MAX_LINES);
let buf = log_buffer().lock().unwrap();
let last_seq = buf.back().map(|l| l.seq).unwrap_or(0);
let earliest_seq = buf.front().map(|l| l.seq).unwrap_or(0);
let after = after_seq.unwrap_or(0);
// A gap occurred if the caller already saw `after` lines but the buffer no
// longer holds the line right after it (it scrolled out of the window).
let dropped = after_seq.is_some()
&& after > 0
&& earliest_seq > 0
&& after + 1 < earliest_seq;
let mut lines: Vec<LogLine> = buf
.iter()
.filter(|l| l.seq > after)
.cloned()
.collect();
if lines.len() > max {
lines.drain(0..lines.len() - max);
}
LogTail { lines, last_seq, dropped }
}
pub fn export_logs_to_file(path: &str) -> Result<usize, String> {
let snapshot = {
let buf = log_buffer().lock().unwrap();
if buf.is_empty() {
String::new()
} else {
let mut s = buf.iter().cloned().collect::<Vec<_>>().join("\n");
let mut s = buf.iter().map(|l| l.text.clone()).collect::<Vec<_>>().join("\n");
s.push('\n');
s
}
+2
View File
@@ -612,6 +612,8 @@ pub fn run() {
linux_wayland_text_render_settings_available,
set_linux_wayland_text_render_profile,
set_logging_mode,
get_logging_mode,
tail_runtime_logs,
export_runtime_logs,
frontend_debug_log,
performance_cpu_snapshot,
@@ -24,11 +24,48 @@ pub(crate) fn set_logging_mode(mode: String) -> Result<(), String> {
crate::logging::set_logging_mode_from_str(&mode)
}
#[tauri::command]
pub(crate) fn get_logging_mode() -> String {
crate::logging::current_mode_str().to_string()
}
#[tauri::command]
pub(crate) fn export_runtime_logs(path: String) -> Result<usize, String> {
crate::logging::export_logs_to_file(&path)
}
#[derive(serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct LogLineDto {
pub seq: u64,
pub text: String,
}
#[derive(serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct LogTailDto {
pub lines: Vec<LogLineDto>,
pub last_seq: u64,
pub dropped: bool,
}
/// Incremental tail of the in-memory runtime log buffer for the Performance
/// Probe Logs tab. `after_seq` is the highest seq the UI already has (omit for
/// the initial fetch of the most recent `max` lines).
#[tauri::command]
pub(crate) fn tail_runtime_logs(after_seq: Option<u64>, max: Option<usize>) -> LogTailDto {
let tail = crate::logging::tail_logs(after_seq, max.unwrap_or(2000));
LogTailDto {
lines: tail
.lines
.into_iter()
.map(|l| LogLineDto { seq: l.seq, text: l.text })
.collect(),
last_seq: tail.last_seq,
dropped: tail.dropped,
}
}
#[tauri::command]
pub(crate) fn frontend_debug_log(scope: String, message: String) -> Result<(), String> {
crate::app_deprintln!("[frontend][{}] {}", scope, message);
+2 -2
View File
@@ -16,8 +16,8 @@ pub(crate) use cli_bridge::{
cli_publish_server_list,
};
pub(crate) use core::{
exit_app, export_runtime_logs, frontend_debug_log, greet, set_logging_mode,
set_subsonic_wire_user_agent,
exit_app, export_runtime_logs, frontend_debug_log, get_logging_mode, greet, set_logging_mode,
set_subsonic_wire_user_agent, tail_runtime_logs,
};
pub(crate) use perf::performance_cpu_snapshot;
pub(crate) use platform::{