feat(monitor): Add HeapMonitor class to monitor component#435
Merged
feat(monitor): Add HeapMonitor class to monitor component#435
monitor component#435Conversation
|
✅Static analysis result - no issues found! ✅ |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new HeapMonitor class to the monitor component to extend memory monitoring capabilities and update associated documentation and examples.
- Added HeapMonitor class with methods for retrieving and formatting heap info.
- Updated documentation and Doxygen configuration to reflect the new component.
- Expanded the monitor example to demonstrate HeapMonitor usage.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/en/monitor.rst | Added new section with documentation for Heap Monitor. |
| doc/Doxyfile | Updated Doxyfile to include heap_monitor.hpp in documentation. |
| components/monitor/src/heap_monitor.cpp | Implemented HeapMonitor methods for retrieving and formatting heap info. |
| components/monitor/include/heap_monitor.hpp | Declared HeapMonitor class and its API along with fmt::formatter specialization. |
| components/monitor/example/main/monitor_example.cpp | Extended example to demonstrate HeapMonitor usage. |
| components/monitor/CMakeLists.txt | Included source directory for the new HeapMonitor implementation. |
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.
Description
HeapMonitorclass tomonitorcomponentmonitor/exampleto test the HeapMonitor APIsMotivation and Context
In addition to tracking task memory / utilization (which the
monitorcomponent currently does), it is frequently useful to track system memory utilization in various memory regions (e.g. DRAM, SPIRAM, and DMA memories). This PR adds functionality to simplify and make more consistent code which does that.How has this been tested?
Build and run
monitor/exampleon QtPy ESP32s3Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):
Types of changes
Checklist:
Software
.github/workflows/build.ymlfile to add my new test to the automated cloud build github action.