Added some doc to system_metric_collector #75
Conversation
| There are two parameters defined: | ||
|
|
||
| - **measurement_period**: | ||
| ```sh |
There was a problem hiding this comment.
Consider using yaml for better readability
|
|
||
| ## Usage: | ||
|
|
||
| You can run the following command to generate CPU and Memory statistics. for both, all the system and the node running: |
There was a problem hiding this comment.
Remove the second sentence, you only need the first
| ros2 run system_metrics_collector main | ||
| ``` | ||
|
|
||
| Change `publish_period` or `measurement_period` using `--ros-args`: |
There was a problem hiding this comment.
publish_period or measurement_period can be modified using...
There was a problem hiding this comment.
Thanks for the PR! I forsee this documentation drastically changing as we add the preferred mechanisms to run the collection processes. Specifically once we have the composable and lifecycle PRs merged, the current main will be used as an example or simply removed entirely.
| You can run the following command to generate CPU and Memory statistics. for both, all the system and the node running: | ||
|
|
||
| ``` | ||
| ros2 run system_metrics_collector main |
There was a problem hiding this comment.
This usage isn't quite correct. At some point in the next 2 weeks, we will be moving this main to an example directory. The preferred way to launch the system CPU and system memory collector will be to use their entry points (standalone mains) or the launch file. Per process CPU and memory will use composition.
There was a problem hiding this comment.
@dabonnie Is this the correct usage now? If yes, I think we can merge as it is and the refactoring PR should update the doc accordingly at this time?
There was a problem hiding this comment.
@thomas-moulard sounds good, why I didn't submit as a blocking review ;-)
|
Merging as build passes but codecov is broken. |
Added some doc to system_metric_collector