Improved logging (#678)
Some checks are pending
Build and Release / Read metadata (push) Waiting to run
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-aarch64-apple-darwin, osx-arm64, macos-latest, aarch64-apple-darwin, dmg updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-aarch64-pc-windows-msvc.exe, win-arm64, windows-latest, aarch64-pc-windows-msvc, nsis updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-aarch64-unknown-linux-gnu, linux-arm64, ubuntu-22.04-arm, aarch64-unknown-linux-gnu, appimage deb updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-x86_64-apple-darwin, osx-x64, macos-latest, x86_64-apple-darwin, dmg updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-x86_64-pc-windows-msvc.exe, win-x64, windows-latest, x86_64-pc-windows-msvc, nsis updater) (push) Blocked by required conditions
Build and Release / Build app (${{ matrix.dotnet_runtime }}) (-x86_64-unknown-linux-gnu, linux-x64, ubuntu-22.04, x86_64-unknown-linux-gnu, appimage deb updater) (push) Blocked by required conditions
Build and Release / Prepare & create release (push) Blocked by required conditions
Build and Release / Publish release (push) Blocked by required conditions

This commit is contained in:
Thorsten Sommer 2026-02-25 19:30:46 +01:00 committed by GitHub
parent 09df19e6f5
commit 685f95245b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 169 additions and 39 deletions

View File

@ -100,7 +100,7 @@ public sealed class RustAvailabilityMonitorService : BackgroundService, IMessage
{ {
try try
{ {
await this.rustService.ReadUserLanguage(); await this.rustService.ReadUserLanguage(forceRequest: true);
} }
catch (Exception e) catch (Exception e)
{ {

View File

@ -2,15 +2,34 @@
public sealed partial class RustService public sealed partial class RustService
{ {
public async Task<string> ReadUserLanguage() public async Task<string> ReadUserLanguage(bool forceRequest = false)
{ {
var response = await this.http.GetAsync("/system/language"); if (!forceRequest && !string.IsNullOrWhiteSpace(this.cachedUserLanguage))
if (!response.IsSuccessStatusCode) return this.cachedUserLanguage;
await this.userLanguageLock.WaitAsync();
try
{ {
this.logger!.LogError($"Failed to read the user language from Rust: '{response.StatusCode}'"); if (!forceRequest && !string.IsNullOrWhiteSpace(this.cachedUserLanguage))
return string.Empty; return this.cachedUserLanguage;
var response = await this.http.GetAsync("/system/language");
if (!response.IsSuccessStatusCode)
{
this.logger!.LogError($"Failed to read the user language from Rust: '{response.StatusCode}'");
return string.Empty;
}
var userLanguage = (await response.Content.ReadAsStringAsync()).Trim();
if (string.IsNullOrWhiteSpace(userLanguage))
return string.Empty;
this.cachedUserLanguage = userLanguage;
return userLanguage;
}
finally
{
this.userLanguageLock.Release();
} }
return await response.Content.ReadAsStringAsync();
} }
} }

View File

@ -17,6 +17,7 @@ public sealed partial class RustService : BackgroundService
private static string TB(string fallbackEN) => I18N.I.T(fallbackEN, typeof(RustService).Namespace, nameof(RustService)); private static string TB(string fallbackEN) => I18N.I.T(fallbackEN, typeof(RustService).Namespace, nameof(RustService));
private readonly HttpClient http; private readonly HttpClient http;
private readonly SemaphoreSlim userLanguageLock = new(1, 1);
private readonly JsonSerializerOptions jsonRustSerializerOptions = new() private readonly JsonSerializerOptions jsonRustSerializerOptions = new()
{ {
@ -29,6 +30,7 @@ public sealed partial class RustService : BackgroundService
private ILogger<RustService>? logger; private ILogger<RustService>? logger;
private Encryption? encryptor; private Encryption? encryptor;
private string? cachedUserLanguage;
private readonly string apiPort; private readonly string apiPort;
private readonly string certificateFingerprint; private readonly string certificateFingerprint;
@ -88,6 +90,7 @@ public sealed partial class RustService : BackgroundService
public override void Dispose() public override void Dispose()
{ {
this.http.Dispose(); this.http.Dispose();
this.userLanguageLock.Dispose();
base.Dispose(); base.Dispose();
} }

View File

@ -13,6 +13,12 @@ public sealed class TerminalLogger() : ConsoleFormatter(FORMATTER_NAME)
public const string FORMATTER_NAME = "AI Studio Terminal Logger"; public const string FORMATTER_NAME = "AI Studio Terminal Logger";
private static RustService? RUST_SERVICE; private static RustService? RUST_SERVICE;
// ReSharper disable FieldCanBeMadeReadOnly.Local
// ReSharper disable ConvertToConstant.Local
private static bool LOG_TO_STDOUT = true;
// ReSharper restore ConvertToConstant.Local
// ReSharper restore FieldCanBeMadeReadOnly.Local
// Buffer for early log events before the RustService is available: // Buffer for early log events before the RustService is available:
private static readonly ConcurrentQueue<LogEventRequest> EARLY_LOG_BUFFER = new(); private static readonly ConcurrentQueue<LogEventRequest> EARLY_LOG_BUFFER = new();
@ -44,6 +50,10 @@ public sealed class TerminalLogger() : ConsoleFormatter(FORMATTER_NAME)
bufferedEvent.StackTrace bufferedEvent.StackTrace
); );
} }
#if !DEBUG
LOG_TO_STDOUT = false;
#endif
} }
public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider? scopeProvider, TextWriter textWriter) public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider? scopeProvider, TextWriter textWriter)
@ -56,19 +66,22 @@ public sealed class TerminalLogger() : ConsoleFormatter(FORMATTER_NAME)
var stackTrace = logEntry.Exception?.StackTrace; var stackTrace = logEntry.Exception?.StackTrace;
var colorCode = GetColorForLogLevel(logEntry.LogLevel); var colorCode = GetColorForLogLevel(logEntry.LogLevel);
textWriter.Write($"[{colorCode}{timestamp}{ANSI_RESET}] {colorCode}{logLevel}{ANSI_RESET} [{category}] {colorCode}{message}{ANSI_RESET}"); if (LOG_TO_STDOUT)
if (logEntry.Exception is not null)
{ {
textWriter.Write($" {colorCode}Exception: {exceptionMessage}{ANSI_RESET}"); textWriter.Write($"[{colorCode}{timestamp}{ANSI_RESET}] {colorCode}{logLevel}{ANSI_RESET} [{category}] {colorCode}{message}{ANSI_RESET}");
if (stackTrace is not null) if (logEntry.Exception is not null)
{ {
textWriter.WriteLine(); textWriter.Write($" {colorCode}Exception: {exceptionMessage}{ANSI_RESET}");
foreach (var line in stackTrace.Split('\n')) if (stackTrace is not null)
textWriter.WriteLine($" {colorCode}{line.TrimEnd()}{ANSI_RESET}"); {
textWriter.WriteLine();
foreach (var line in stackTrace.Split('\n'))
textWriter.WriteLine($" {colorCode}{line.TrimEnd()}{ANSI_RESET}");
}
} }
else
textWriter.WriteLine();
} }
else
textWriter.WriteLine();
// Send log event to Rust via API (fire-and-forget): // Send log event to Rust via API (fire-and-forget):
if (RUST_SERVICE is not null) if (RUST_SERVICE is not null)
@ -90,4 +103,4 @@ public sealed class TerminalLogger() : ConsoleFormatter(FORMATTER_NAME)
_ => ANSI_RESET _ => ANSI_RESET
}; };
} }

View File

@ -1 +1,5 @@
# v26.3.1, build 235 (2026-03-xx xx:xx UTC) # v26.3.1, build 235 (2026-03-xx xx:xx UTC)
- Improved the performance by caching the OS language detection and requesting the user language only once per app start.
- Improved the user-language logging by limiting language detection logs to a single entry per app start.
- Improved the logbook readability by removing non-readable special characters from log entries.
- Improved the logbook reliability by significantly reducing duplicate log entries.

View File

@ -33,6 +33,59 @@ static DOTNET_INITIALIZED: Lazy<Mutex<bool>> = Lazy::new(|| Mutex::new(false));
pub const PID_FILE_NAME: &str = "mindwork_ai_studio.pid"; pub const PID_FILE_NAME: &str = "mindwork_ai_studio.pid";
const SIDECAR_TYPE:SidecarType = SidecarType::Dotnet; const SIDECAR_TYPE:SidecarType = SidecarType::Dotnet;
/// Removes ANSI escape sequences and non-printable control chars from stdout lines.
fn sanitize_stdout_line(line: &str) -> String {
let mut sanitized = String::with_capacity(line.len());
let mut chars = line.chars().peekable();
while let Some(ch) = chars.next() {
if ch == '\u{1B}' {
if let Some(next) = chars.peek().copied() {
// CSI sequence: ESC [ ... <final>
if next == '[' {
chars.next();
for csi_char in chars.by_ref() {
let code = csi_char as u32;
if (0x40..=0x7E).contains(&code) {
break;
}
}
continue;
}
// OSC sequence: ESC ] ... (BEL or ESC \)
if next == ']' {
chars.next();
let mut previous_was_escape = false;
for osc_char in chars.by_ref() {
if osc_char == '\u{07}' {
break;
}
if previous_was_escape && osc_char == '\\' {
break;
}
previous_was_escape = osc_char == '\u{1B}';
}
continue;
}
}
// Unknown escape sequence: ignore the escape char itself.
continue;
}
if ch.is_control() && ch != '\t' {
continue;
}
sanitized.push(ch);
}
sanitized
}
/// Returns the desired port of the .NET server. Our .NET app calls this endpoint to get /// Returns the desired port of the .NET server. Our .NET app calls this endpoint to get
/// the port where the .NET server should listen to. /// the port where the .NET server should listen to.
#[get("/system/dotnet/port")] #[get("/system/dotnet/port")]
@ -111,11 +164,12 @@ pub fn start_dotnet_server() {
// NOTE: Log events are sent via structured HTTP API calls. // NOTE: Log events are sent via structured HTTP API calls.
// This loop serves for fundamental output (e.g., startup errors). // This loop serves for fundamental output (e.g., startup errors).
while let Some(CommandEvent::Stdout(line)) = rx.recv().await { while let Some(CommandEvent::Stdout(line)) = rx.recv().await {
let line = line.trim_end(); let line = sanitize_stdout_line(line.trim_end());
info!(Source = ".NET Server (stdout)"; "{line}"); if !line.trim().is_empty() {
info!(Source = ".NET Server (stdout)"; "{line}");
}
} }
}); });
} }
/// This endpoint is called by the .NET server to signal that the server is ready. /// This endpoint is called by the .NET server to signal that the server is ready.

View File

@ -15,6 +15,9 @@ pub static DATA_DIRECTORY: OnceLock<String> = OnceLock::new();
/// The config directory where the application stores its configuration. /// The config directory where the application stores its configuration.
pub static CONFIG_DIRECTORY: OnceLock<String> = OnceLock::new(); pub static CONFIG_DIRECTORY: OnceLock<String> = OnceLock::new();
/// The user language cached once per runtime process.
static USER_LANGUAGE: OnceLock<String> = OnceLock::new();
/// Returns the config directory. /// Returns the config directory.
#[get("/system/directories/config")] #[get("/system/directories/config")]
pub fn get_config_directory(_token: APIToken) -> String { pub fn get_config_directory(_token: APIToken) -> String {
@ -87,12 +90,11 @@ fn normalize_locale_tag(locale: &str) -> Option<String> {
} }
#[cfg(target_os = "linux")] #[cfg(target_os = "linux")]
fn read_locale_from_environment() -> Option<String> { fn read_locale_from_environment() -> Option<(String, &'static str)> {
if let Ok(language) = env::var("LANGUAGE") { if let Ok(language) = env::var("LANGUAGE") {
for candidate in language.split(':') { for candidate in language.split(':') {
if let Some(locale) = normalize_locale_tag(candidate) { if let Some(locale) = normalize_locale_tag(candidate) {
info!("Detected user language from Linux environment variable 'LANGUAGE': '{}'.", locale); return Some((locale, "LANGUAGE"));
return Some(locale);
} }
} }
} }
@ -100,8 +102,7 @@ fn read_locale_from_environment() -> Option<String> {
for key in ["LC_ALL", "LC_MESSAGES", "LANG"] { for key in ["LC_ALL", "LC_MESSAGES", "LANG"] {
if let Ok(value) = env::var(key) { if let Ok(value) = env::var(key) {
if let Some(locale) = normalize_locale_tag(&value) { if let Some(locale) = normalize_locale_tag(&value) {
info!("Detected user language from Linux environment variable '{}': '{}'.", key, locale); return Some((locale, key));
return Some(locale);
} }
} }
} }
@ -110,10 +111,35 @@ fn read_locale_from_environment() -> Option<String> {
} }
#[cfg(not(target_os = "linux"))] #[cfg(not(target_os = "linux"))]
fn read_locale_from_environment() -> Option<String> { fn read_locale_from_environment() -> Option<(String, &'static str)> {
None None
} }
enum LanguageDetectionSource {
SysLocale,
LinuxEnvironmentVariable(&'static str),
DefaultLanguage,
}
fn detect_user_language() -> (String, LanguageDetectionSource) {
if let Some(locale) = get_locale() {
if let Some(normalized_locale) = normalize_locale_tag(&locale) {
return (normalized_locale, LanguageDetectionSource::SysLocale);
}
warn!("sys-locale returned an unusable locale value: '{}'.", locale);
}
if let Some((locale, key)) = read_locale_from_environment() {
return (locale, LanguageDetectionSource::LinuxEnvironmentVariable(key));
}
(
String::from(DEFAULT_LANGUAGE),
LanguageDetectionSource::DefaultLanguage,
)
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::normalize_locale_tag; use super::normalize_locale_tag;
@ -137,21 +163,32 @@ mod tests {
#[get("/system/language")] #[get("/system/language")]
pub fn read_user_language(_token: APIToken) -> String { pub fn read_user_language(_token: APIToken) -> String {
if let Some(locale) = get_locale() { USER_LANGUAGE
if let Some(normalized_locale) = normalize_locale_tag(&locale) { .get_or_init(|| {
info!("Detected user language from sys-locale: '{}'.", normalized_locale); let (user_language, source) = detect_user_language();
return normalized_locale; match source {
} LanguageDetectionSource::SysLocale => {
info!("Detected user language from sys-locale: '{}'.", user_language);
},
warn!("sys-locale returned an unusable locale value: '{}'.", locale); LanguageDetectionSource::LinuxEnvironmentVariable(key) => {
} info!(
"Detected user language from Linux environment variable '{}': '{}'.",
key, user_language
);
},
if let Some(locale) = read_locale_from_environment() { LanguageDetectionSource::DefaultLanguage => {
return locale; warn!(
} "Could not determine the system language. Use default '{}'.",
DEFAULT_LANGUAGE
);
},
}
warn!("Could not determine the system language. Use default '{}'.", DEFAULT_LANGUAGE); user_language
String::from(DEFAULT_LANGUAGE) })
.clone()
} }
#[get("/system/enterprise/config/id")] #[get("/system/enterprise/config/id")]