TraceScope Documentation

TraceScope is a native C++/Qt desktop application for investigating file-based telemetry and diagnostic logs. The stable v1.0.0 release is available through GitHub Releases. For a project overview, features, and screenshots, see the Project README.

User Guides

• Getting Started — Set up TraceScope and complete a first investigation.
• Importing Logs — Select log files, configure imports, and preview records.
• Investigating Logs — Filter, navigate, and analyze imported events.
• Findings — Bookmark records, record observations, and manage findings.
• Live Following — Follow growing files and handle source changes.
• Saving and Restoring — Preserve investigations and reopen workspaces.
• Comparing Sessions — Compare investigation sessions using point-in-time results.
• Reporting and Export — Export records and findings, and generate HTML reports.

Reference

• Supported Formats — Supported log formats, requirements, and limitations.
• Import Profiles — Field mapping, parsing options, and saved profile configuration.
• Troubleshooting — Diagnose common import, investigation, and workspace issues.

Technical Documentation

• Architecture — Application components, data flow, and key design decisions.
• Testing — Automated tests, CI, and manual verification.
• Building from Source — Development setup, builds, and local test execution.
• Performance Notes — Measured import scenarios and the limits of those measurements.
• Live-Log Generator — Deterministic test scenarios, generator design, and usage.

Project History and Examples

• Expansion Roadmap — Completed development phases and the history of TraceScope through v1.0.0.
• Original Prototype Plan — Initial project scope and design goals.
• Example HTML Report — View a representative Field Gateway investigation report.
• Example PDF Print — View the print-formatted version of the Field Gateway investigation report.