Skip to content

docs: document Overview page sub-sections in TECHNICAL.md#60

Merged
navidpadid merged 1 commit into
mainfrom
docs/overview-subsections-technical-aca7aa75e473b2e1
Apr 10, 2026
Merged

docs: document Overview page sub-sections in TECHNICAL.md#60
navidpadid merged 1 commit into
mainfrom
docs/overview-subsections-technical-aca7aa75e473b2e1

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Summary

PR #59 (summary-page branch) adds a new Overview section (key 5) to the live dashboard. Previous doc commits updated the section number, controls, and trend-lane descriptions, but did not document the four content sub-sections the Overview page renders below the sparklines.

This PR fills that gap.

Changes

File Why
docs/TECHNICAL.md Added a bulleted list of the four Overview sub-sections (MEMORY SNAPSHOT, NETWORK SNAPSHOT with top-talkers table, I/O SNAPSHOT, THREAD HOTSPOTS) with field and column details.

Detail

The Overview page (print_overview_view) renders:

  • MEMORY SNAPSHOT — RSS, VSZ, Swap Usage, page faults (major/minor)
  • NETWORK SNAPSHOT — socket total, cumulative rx/tx bytes, TCP retransmits, drops, and a top-talkers table (up to 2 sockets: FD, proto, family, RX_BYTES, TX_BYTES, TOTAL_BYTES)
  • I/O SNAPSHOT — read_bytes, write_bytes, syscr, syscw, io_intensity (or aggregated status)
  • THREAD HOTSPOTS — total thread count and up to 3 top threads by CPU (TID, name, CPU%, state, priority, nice, CPU affinity)

No code changes; documentation only.

Generated by Update ProcLens Docs for issue #59 ·

The Overview page (section 5) introduced in the summary-page branch
renders four sub-sections below the sparkline trend lanes:
- MEMORY SNAPSHOT (RSS, VSZ, Swap, page faults)
- NETWORK SNAPSHOT (sockets, rx/tx bytes, retransmits, drops, top talkers)
- I/O SNAPSHOT (read/write bytes, syscr/syscw, io_intensity)
- THREAD HOTSPOTS (total threads, top 3 by CPU)

Add these to docs/TECHNICAL.md to complete the coverage started in
commits 1cdd886 and d659802.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 10, 2026
@github-actions github-actions Bot mentioned this pull request Apr 10, 2026
@github-actions github-actions Bot requested a review from navidpadid as a code owner April 10, 2026 07:44
@navidpadid navidpadid merged commit 93a21ab into main Apr 10, 2026
3 checks passed
@navidpadid navidpadid deleted the docs/overview-subsections-technical-aca7aa75e473b2e1 branch April 10, 2026 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant