docs(cli): correct the dora top note about what each metric column means - #3111
Draft
phil-opp wants to merge 1 commit into
Draft
docs(cli): correct the dora top note about what each metric column means#3111phil-opp wants to merge 1 commit into
dora top note about what each metric column means#3111phil-opp wants to merge 1 commit into
Conversation
…means The header note claimed "Values are averaged over the last refresh period", but that is only true for the disk-I/O columns. Verified against the data source: - NET TX / NET RX are monotonic counters (`fetch_add`-ed, never reset in the daemon) — lifetime cumulative totals, not per-period averages. - RESTARTS is a cumulative count; QUEUE and MEMORY are point-in-time snapshots; CPU% is an instantaneous sample. - Only I/O READ / I/O WRITE are a per-refresh-interval rate. A steadily growing cumulative "NET TX" read as an ever-rising throughput under the old wording. Reword the note to state per-column semantics accurately. Documentation only; no behavior change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PYiYgEo2WKBXfGooqP2WG5
Contributor
|
Merging to
After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here |
Collaborator
Author
|
🤖 Automated review by Claude — this is a fully automated review with no human in the loop. Treat it as advisory. Reviewed the diff — documentation-only change to the Generated by Claude Code |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
The
dora tophelp note (binaries/cli/src/command/inspect/top.rs) states:That is inaccurate for most of the table. Verified against the data source:
net_bytes_sent/net_bytes_receivedare monotonic counters that are only everfetch_add-ed and never reset (running_dataflow.rs, incremented indaemon/src/lib.rs). They are lifetime cumulative totals, not per-period averages.Under the old wording, a steadily growing cumulative "NET TX" reads as an ever-rising throughput.
Fix
Reword the note to state per-column semantics accurately (instantaneous vs. per-interval rate vs. cumulative/point-in-time). Documentation only — no behavior change.
Validation
(Doc-comment-only change to a clap
Argshelp string.)origin/mainbefore opening. Please review carefully before merging.🤖 Generated with Claude Code
Generated by Claude Code