Add error percentage to cpu and ram monitor#548
Open
sangteak601 wants to merge 6 commits into
Open
Conversation
Author
|
@ct2034 |
ct2034
requested changes
Mar 30, 2026
ct2034
added
the
needs more work
ct2034
added
the
enhancement
Collaborator
|
@sangteak601 are you planning to work on this? |
Author
All comments are addressed now I believe. Can you take another look? |
There was a problem hiding this comment.
Pull request overview
Adds error_percentage thresholds to cpu_monitor and ram_monitor so they can publish ERROR status, and adds a use_average switch to cpu_monitor to compare the threshold against the average CPU usage (consistent with the RAM monitor) instead of per-core usage. Documentation and the CPU system test are updated accordingly.
Changes:
CpuTaskgains requirederror_percentageanduse_averageconstructor args; status logic now selects max-core or average CPU, then evaluates OK / WARN / ERROR.RamTaskgains a requirederror_percentageconstructor arg and emits ERROR when RAM average exceeds it.- README and the CPU system test updated; new ROS parameters (
error_percentagedefault 95,use_averagedefault False) declared in both monitors'main().
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| diagnostic_common_diagnostics/diagnostic_common_diagnostics/cpu_monitor.py | Adds ERROR threshold and use_average switch, removes constructor defaults, declares new parameters. |
| diagnostic_common_diagnostics/diagnostic_common_diagnostics/ram_monitor.py | Adds ERROR threshold to RAM monitoring and declares the new parameter. |
| diagnostic_common_diagnostics/test/systemtest/test_cpu_monitor.py | Updates CpuTask constructor calls to match new required args; updates warn message assertion. |
| diagnostic_common_diagnostics/README.md | Documents new use_average and error_percentage args for CPU/RAM monitors. |
| diagnostic_common_diagnostics/diagnostic_common_diagnostics/param_decl.yaml | Empty file; no content change visible. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * Name of the node is "cpu_monitor_" + hostname. | ||
| * Uses the following args: | ||
| * use_average: If true, the average CPU usage over all cores will be used to determine the status. If false, the maximum CPU usage among all cores will be used. | ||
| * warning_percentage: If the CPU usage is > warning_percentage, a WARN status will be publised. |
| class CpuTask(DiagnosticTask): | ||
|
|
||
| def __init__(self, warning_percentage=90, window=1): | ||
| def __init__(self, warning_percentage, error_percentage, window, use_average): |
| DiagnosticTask.__init__(self, 'CPU Information') | ||
|
|
||
| self._warning_percentage = int(warning_percentage) | ||
| self._error_percentage = int(error_percentage) |
Comment on lines
82
to
+99
| @@ -96,7 +96,7 @@ def test_updater(self): | |||
| node = Node('cpu_monitor_test') | |||
| updater = Updater(node) | |||
| updater.setHardwareID('test_id') | |||
| updater.add(CpuTask()) | |||
| updater.add(CpuTask(warning_percentage=95, error_percentage=100, window=1, use_average=False)) | |||
Comment on lines
+16
to
+18
| * use_average: If true, the average CPU usage over all cores will be used to determine the status. If false, the maximum CPU usage among all cores will be used. | ||
| * warning_percentage: If the CPU usage is > warning_percentage, a WARN status will be publised. | ||
| * error_percentage: If the CPU usage is > error_percentage, an ERROR status will be published. |
ct2034
requested changes
May 28, 2026
Collaborator
ct2034
left a comment
ct2034
left a comment
There was a problem hiding this comment.
I agree with all of the copilot comments
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
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.
At the moment, it is not possible to configure
cpu_monitororram_monitorto publish ERROR status. It would be good to have ERROR state. It would allow us to take actions before program exhibits unexpected behaviour.Also,
cpu_monitorwas updated to compare threshold to average cpu usage rather than individual cpu usage. This is aligned with howram_monitorworks and makes more sense, as in most cases users are more interested in average usage than individual usage.