Skip to content

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.

Logs screen showing Open Folder, Refresh, Clear, and Copy header actions above the auto-scrolling desktop log viewer.

Step-by-Step User Workflows

1. Inspect Recent Events

  1. Open Admin → Logs; the view immediately refreshes (vm.refresh()) and scrolls to the bottom of logTextArea.
  2. Switch Logging detail to Detailed diagnostics in Settings before reproducing tricky bugs, then click Refresh (logsRefreshButton).

2. Share or Clear Logs

  • Open Folder (logsOpenFolderButton): Opens the directory configured under Desktop logs folder (vm.logsFolder) in Windows Explorer (shown when logsFolder !== "").
  • 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 opens Clear 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 onLogTextChanged fires, scrollToBottom() moves cursorPosition to logTextArea.text.length using Qt.callLater.
  • Scope Boundary: This page shows desktop client logs. For remote training, SSH node provisioning, or worker container logs, inspect task output in Tasks.