Skip to content

docs: update CLAUDE.md to reflect Python post-processor #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k-rister merged 1 commit into from
May 14, 2026
Merged

docs: update CLAUDE.md to reflect Python post-processor #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Collects periodic snapshots of `/proc` filesystem files during benchmark executi

## Languages
- Bash: collection scripts (`procstat-start`, `procstat-stop`, `procstat-collect`)
- Perl: post-processor (`procstat-post-process`)
- Python: post-processor (`procstat-post-process.py`)

## Key Files
| File | Purpose |
|------|---------|
| `procstat-start` | Validates collector, sets defaults, captures CPU topology, launches `procstat-collect` in background |
| `procstat-collect` | Reads configured /proc files at intervals, appends timestamped snapshots |
| `procstat-stop` | Kills collector, compresses output with xz |
| `procstat-post-process` | Derives interrupt-rate metrics from snapshots using 4 parallel processes (uses `toolbox::metrics`, `toolbox::json` from `$TOOLBOX_HOME/perl`) |
| `procstat-post-process.py` | Derives interrupt-rate metrics from snapshots using CDMMetrics |
| `rickshaw.json` | Rickshaw integration: endpoint allow/block lists, file deployment, post-process script |
| `workshop.json` | Engine image build requirements (minimal) |

Expand All @@ -24,4 +24,4 @@ Collects periodic snapshots of `/proc` filesystem files during benchmark executi
## Conventions
- Primary branch is `master`
- Runs as a profiler tool on master/worker/profiler roles, blocked on client/server
- Standard Bash/Perl modelines and 4-space indentation
- Standard Bash modelines and 4-space indentation
Loading