Add performance logging for qdk native wheel build diagnostics by domorale · Pull Request #3492 · microsoft/qdk

domorale · 2026-07-21T00:04:14Z

Summary

Adds best-effort, non-blocking performance logging for qdk native wheel builds.
Moves logging helpers out of build.py into a dedicated module.
Logs pre-build, post-build, and failure snapshots (platform, Python version, sanitized command, system memory state).
Adds in-build peak indicators using OS-native tooling where available.

Scope

Logging is limited to the qdk native wheel build path.
Build outputs, flags, and packaging behavior are unchanged.
No new runtime dependencies were added.

Platform behavior

Linux: uses /usr/bin/time -v for peak indicator output.
macOS: uses /usr/bin/time -l for peak indicator output.
Windows: keeps snapshot logging; no built-in peak wrapper parity yet.

Validation

python3 -m py_compile performance_logging.py
python3 build.py --no-check-prereqs --no-check --no-test --qdk
python3 ./build.py

Risk

Low.
Logging is best-effort and non-blocking.
If logging collection fails, the build continues.

Current iteration scope

Rename runtime diagnostics wording to performance logging.
Move logging helpers out of the main build orchestration path into a dedicated module.
Add during-build peak indicators on Linux and macOS using OS-native tooling.
Keep diagnostics best-effort, non-blocking, and scoped to qdk native wheel builds.

Potential follow-up (if needed)

If current logs are insufficient, evaluate optional cross-platform library-based sampling (for example psutil) to complement OS-native logging.
If cost/benefit is favorable, add process-tree tracking during the build window to capture peak root-process RSS and peak aggregate child-process RSS.
If attribution remains unclear, report Top-N subprocess memory offenders near peak.
For reproducible failures, consider optional profiler-assisted deep dives outside the default CI path.

domorale · 2026-07-21T22:24:45Z

@microsoft-github-policy-service agree company="Microsoft"

domorale · 2026-07-22T02:39:14Z

Optional Next Iteration Proposal (qdk native wheel diagnostics)

Current iteration objective was to improve diagnostics for the qdk native wheel step using a dependency-free, OS-native approach.
That objective is satisfied in this PR.

A potential next iteration is to evaluate optional psutil-based process metrics, mainly to improve Windows peak-memory parity and add top offender attribution.

Why consider this next iteration

Current gap: Windows does not have OS-native peak-wrapper parity in the current implementation.
psutil can provide:
- peak largest-process RSS
- peak process-tree RSS
- top offenders at peak

Local experiment summary (same qdk native wheel path)

OS-native time max RSS: 3906428 kB (~3814.9 MiB)
psutil peak largest-process RSS: 3753.7 MiB (rustc)
psutil peak process-tree RSS: 4524.5 MiB
top offenders were identified with crate-level context

Interpretation:

largest-process peak from psutil was close to OS-native max RSS (good parity signal),
process-tree peak added extra attribution signal.

Cost / tradeoff

Adds one native dependency (psutil, ~1.1 MB installed in local test), which increases dependency/maintenance surface.

Decision

No change is proposed to current iteration scope in this PR by this comment.

If the team wants to pursue this next iteration, we can do either:

A new revision on this same PR, or
A separate follow-up PR.

If the team is satisfied with current status, we can keep this PR as-is and merge the dependency-free implementation.

domorale · 2026-07-24T04:04:30Z

Perf logging for the qdk native wheel build is now complete and validated.

This PR:

adds best-effort, non-blocking perf logging for the qdk build path
captures structured build context and memory diagnostics
uses psutil process-tree sampling for peak memory tracking
keeps psutil scoped to the qdk build flow only
adds build-system test coverage for the perf logging behavior
hardens path sanitization and normalization across Linux, macOS, and Windows

Validation:

targeted perf-logging tests pass locally
full python build.py passes locally
GitHub CI passed on all platforms

Add best-effort performance logging for the qdk native wheel build path. Log pre-build, post-build, and failure snapshots including: - platform - Python version - sanitized command - system memory state Keep diagnostics non-blocking and scoped to the qdk native wheel step only. Capture peak memory indicators during build execution with OS-native tooling: - Linux: /usr/bin/time -v - macOS: /usr/bin/time -l - Windows: snapshot logging with no built-in peak wrapper parity Move performance logging helpers into a dedicated module to keep build orchestration code focused.

…ntegration Follow up the perf logging refactor with clearer architecture and validation. - Switch peak-memory indicators to psutil process-tree sampling. - Keep diagnostics best-effort and non-blocking. - Keep psutil build-time only (no runtime dependency change). - Separate build-context reporting from system-memory snapshot phase reporting. - Move build perf tests to tests/build and integrate them into build.py qdk test flow. - Add psutil prereq version checks with install/update behavior. Validation: - python3 -m py_compile build.py prereqs.py performance_logging.py tests/build/test_performance_logging.py - python -m pytest tests/build -q - python build.py --qdk --test --no-check --no-check-prereqs Architecture validation (lazy imports and scoped psutil): - Fresh venv without psutil: wasm build succeeds (psutil not required for non-qdk targets) - Fresh venv without psutil: qdk build auto-installs psutil (installed on-demand) - Verified --no-check-prereqs doesn't prevent qdk psutil auto-install - Lazy import cost: ExecutionPolicy imported only on first run() call for perf logging path, then cached in sys.modules; plain-path subprocess calls avoid import entirely

- Use pathlib.Path.resolve() and .relative_to() for cleaner path logic - Use .as_posix() to ensure forward slashes on all platforms (including Windows) - Removed os.path module usage (expanduser, isabs, basename) - Applied DRY: extracted _detect_path_type() helper to replace 4 code repetitions Example: path_type = _detect_path_type(path) instead of manual conditional - Updated test mock: os.path.expanduser → pathlib.Path.home() Uses established QDK patterns (like _path_stem in _context.py) for cross-platform path parsing. All 23 tests pass including Windows path sanitization. Fixes test_sanitize_path_repo_root_and_home on Windows CI

fedimser · 2026-07-24T20:17:19Z

@@ -0,0 +1,393 @@
+import subprocess
+import unittest


We use pytest for Python tests everywhere else in QDK. Would be good to use only one testing framework for all Python tests.
Is there a reason to prefer unittest over pytest for this test?

No reason at all. I agree we should use pytest.

I have the update in my local branch just using pytest. On monday we'll discuss with the team about the pros/cons of adding functionality and dependencies (psutil in this PR) to the QDK build.

domorale requested review from amcasey, billti, idavis and swernli as code owners July 21, 2026 00:04

billti reviewed Jul 21, 2026

View reviewed changes

Comment thread build.py Outdated

billti reviewed Jul 21, 2026

View reviewed changes

Comment thread build.py

billti reviewed Jul 21, 2026

View reviewed changes

Comment thread build.py Outdated

domorale force-pushed the feature/qdk-native-wheel-telemetry-build branch from af22ec3 to 0cc83c7 Compare July 21, 2026 21:19

domorale changed the title ~~Add telemetry for qdk native wheel build diagnostics~~ Add performance logging for qdk native wheel build diagnostics Jul 21, 2026

amcasey reviewed Jul 22, 2026

View reviewed changes

Comment thread performance_logging.py Outdated

Comment thread performance_logging.py

Comment thread performance_logging.py Outdated

Comment thread performance_logging.py Outdated

Comment thread performance_logging.py Outdated

Comment thread performance_logging.py Outdated

domorale force-pushed the feature/qdk-native-wheel-telemetry-build branch 2 times, most recently from 88de101 to 9222cea Compare July 24, 2026 03:14

domorale added 3 commits July 23, 2026 21:21

domorale force-pushed the feature/qdk-native-wheel-telemetry-build branch from 9222cea to bd86c16 Compare July 24, 2026 04:45

domorale requested review from amcasey and billti July 24, 2026 05:33

fedimser reviewed Jul 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add performance logging for qdk native wheel build diagnostics#3492

Add performance logging for qdk native wheel build diagnostics#3492
domorale wants to merge 3 commits into
mainfrom
feature/qdk-native-wheel-telemetry-build

domorale commented Jul 21, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domorale commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domorale commented Jul 22, 2026

Uh oh!

domorale commented Jul 24, 2026

Uh oh!

fedimser Jul 24, 2026

Uh oh!

domorale Jul 25, 2026

Uh oh!

domorale Jul 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

domorale commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Scope

Platform behavior

Validation

Risk

Current iteration scope

Potential follow-up (if needed)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domorale commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domorale commented Jul 22, 2026

Optional Next Iteration Proposal (qdk native wheel diagnostics)

Why consider this next iteration

Local experiment summary (same qdk native wheel path)

Cost / tradeoff

Decision

Uh oh!

domorale commented Jul 24, 2026

Uh oh!

fedimser Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

domorale Jul 25, 2026

Choose a reason for hiding this comment

Uh oh!

domorale Jul 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

domorale commented Jul 21, 2026 •

edited

Loading