Logs Tab
Overview
The Logs tab (LogsPage.qml, route Logs) displays the desktop application’s client-side log file in a read-only scrollable console so engineers and support teams can diagnose WSI loading, Java/Bio-Formats initialization, sync polling, and connectivity issues directly inside the app.
Step-by-Step User Workflows
1. Inspect Recent Events
- Open Admin → Logs; the view immediately refreshes (
vm.refresh()) and scrolls to the bottom oflogTextArea. - Switch Logging detail to
Detailed diagnosticsin Settings before reproducing tricky bugs, then clickRefresh(logsRefreshButton).
2. Share or Clear Logs
- Open Folder (
logsOpenFolderButton): Opens the directory configured under Desktop logs folder (vm.logsFolder) in Windows Explorer (shown whenlogsFolder !== ""). - Copy (
logsCopyButton): Copies the current log buffer to the system clipboard and displays a"Logs copied"confirmation toast. - Clear (
logsClearButton): Disabled when no logs exist (!vm.hasLogs). Clicking opensClear desktop logs(clearConfirmDialog), warning"Are you sure you want to clear the desktop log file? This cannot be undone."before emptying the file.
flowchart LR
EnableDebug["Optional: Settings -> Detailed diagnostics"] --> Reproduce["Reproduce Action in Desktop"]
Reproduce --> OpenLogs["Admin -> Logs (Auto-scroll to latest)"]
OpenLogs --> Share["Copy to Clipboard or Open Folder"]
OpenLogs --> Clear["Clear -> Confirm Clear Logs"]UI Controls & Dialogs Reference
| Control | Object Name | Visibility / Disabled Rule | Action |
|---|---|---|---|
| Open Folder | logsOpenFolderButton (Open Folder) |
Visible when logsFolder !== "" |
Opens desktop log folder in OS file manager |
| Refresh | logsRefreshButton (Refresh) |
Always enabled | Reloads log file contents and scrolls to end |
| Clear | logsClearButton (Clear) |
Disabled when `!vm | |
| Copy | logsCopyButton (Copy) |
Enabled when logs exist | Copies text to clipboard ("Logs copied" toast) |
clearConfirmDialog |
clearConfirmDialog (Clear desktop logs) |
Modal (420×180) |
Actions: Cancel / Clear Logs (confirmClearLogsButton, danger) |
Technical Reference
- Auto-Scroll on Append: Whenever
onLogTextChangedfires,scrollToBottom()movescursorPositiontologTextArea.text.lengthusingQt.callLater. - Scope Boundary: This page shows desktop client logs. For remote training, SSH node provisioning, or worker container logs, inspect task output in Tasks.