doc: list the benchmark host telemetry module in the source tree

[Pedro Henrique Penna (ppenna)]

Summary

PR #479 added scripts/nvx_tools/host_telemetry.py, but Project structure did not list it. It was the only tracked module in scripts/nvx_tools/ (apart from the empty __init__.py) missing from the source tree. This PR adds it to the directory tree and to the scripts/ overview, and links to the benchmark guide sections that describe what it records.

Changes

• doc/project-structure.md, directory tree: adds host_telemetry.py as "Benchmark host provenance and Windows capture storage telemetry". Evidence: git ls-files scripts/nvx_tools and the module docstring in scripts/nvx_tools/host_telemetry.py.
• doc/project-structure.md, scripts/ section: states that host_telemetry.py records the benchmark host's provenance and, on Windows, the storage activity during profiled snapshot captures. It links to Snapshot lifecycle profile and CI collection rather than repeating their detail. Evidence:
  • benchmark_host_provenance() in scripts/nvx_tools/benchmark.py calls host_telemetry.host_provenance().
  • create_storage_telemetry() returns None unless sys.platform == "win32".
  • benchmark.py creates the sampler only when snapshot_profile and a profile sink are set.
  • performance.py renders host_provenance_rows() in reports.

The design docs did not change. For reference, the pinned OpenVMM SHA is 7bf0ee28b826374a2d386067df0456b81bcae818.

Follow-ups (out of scope)

• unittest_results.txt is tracked at the repository root. It holds a 50 KB unittest log from the initial commit and looks like an accidentally committed artifact. This PR doesn't document it. A maintainer should decide whether to delete it, which is a non-documentation change.
• scripts/setup/README.md is documentation outside doc/. Moving it into doc/ means updating links in doc/ci.md and doc/setup.md, which open PRs filesystem: share single host files without their directories #475, Adopt bind-once microVM image slots #406, and test-microvm: pause and resume a microVM through OpenVMM state control #405 also change, and a path in scripts/test_nvx_tools.py, so I left it for a later run.

Validation

• python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests: 117 tests passed (1 skipped).
• A throwaway link checker, kept outside the repository, checked every relative link and anchor in doc/project-structure.md and in README.md, the file that links to it. It also confirmed that the changed file has one H1 and balanced code fences, and that doc/design.md links every chapter in doc/design/. Result: OK.
• git diff --check: clean.
• python scripts\nvx.py verify: passed. The submodule checkout matches the openvmm gitlink.
• The diff changes only doc/project-structure.md, so CI classifies this PR as documentation-only.

[Copilot]

🟢 Approval recommended

The documentation accurately reflects the module’s implementation and uses valid section links.

0 open findings

What changed in this PR

Documents the benchmark host telemetry module in NVX’s project structure.

Changes:

• Adds host_telemetry.py to the source tree.
• Describes its provenance and Windows storage telemetry responsibilities with benchmark-guide links.

File	Description
doc/​project-structure.md	Documents the host telemetry module and related benchmark guidance.

🧠 Review effort: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.