Robotics System Profiler Workshop#
This tutorial runs the Robotics System Profiler (ros-${ROS_DISTRO}-benchmark-framework) in a workshop. The profiler collects ROS 2 KPIs and shows them in Grafana through Prometheus. This workshop is a monitor: it runs no workload of its own, and watches another workshop with the profiler’s remote mode.
You will pair the profiler workshop with the Wandering workshop, run the Wandering simulation, and watch its topic rates and process CPU usage live in Grafana.
Prerequisites#
A host set up as described in Getting Started.
The Wandering workshop, launched and with the desktop connected. Any other workshop works as the target as well.
Launch and set up the workshop#
Launch the workshop:
cd src/components/ros-kpi/workshop workshop launch benchmark-framework
Set up the profiler:
workshop run benchmark-framework install
The package installs the profiler read-only in
/opt/ros/<distro>/benchmarking.installcopies it to~/benchmarking, where sessions are written, installsuv, and runsuv syncas the profiler’s documentation describes.
Pair the workshops#
The profiler’s remote mode reads process CPU and memory usage from the target over passwordless SSH, and the ROS graph over DDS. Pair the profiler workshop with the target from the host:
../../../workshops/scripts/authorize-remote.sh benchmark-framework wandering
The script:
Creates the monitor’s SSH key and adds it to the target’s
authorized_keys.Copies the profiler’s process probe to
~/ros-kpi/src/on the target and enables SSH there.Tests the login and records the target’s address on the monitor, so that
monitor-remoteaccepts the workshop name.
It is safe to run again. Pairing lives inside the workshops, so a rebuild of either workshop removes it; run the script again afterwards.
Monitor the workload#
Start the workload on the target, in the background:
(cd ../../wandering/workshop && workshop run wandering gazebo-tutorial) &
Monitor it for 100 seconds:
workshop run benchmark-framework monitor-remote wandering 100
The action starts Grafana and Prometheus, checks the SSH login, and runs the profiler against the target. If the login fails, it prints the pairing command to run again.
Find the workshop’s IP address:
workshop exec benchmark-framework -- ip -4 -br addr show eth0
Use this address;
hostname -Ilists Docker’sdocker0address first.Open Grafana at
http://<workshop IP>:30000and log in withadmin/admin, the profiler’s local default. Open the ROS2 KPI Dashboard. Grafana takes 5 to 30 seconds to answer after it starts.
While monitoring the Wandering simulation, Grafana showed 552 topic-rate series and 50 process CPU series live. The top processes were the Gazebo Sim server and GUI at about 110% CPU each, and RViz at about 38%.
Grafana keeps running after monitor-remote ends. Stop it with:
workshop run benchmark-framework dashboards-stop
Actions#
Action |
Description |
|---|---|
|
Copies the profiler to |
|
Remote mode against a paired workshop, for 120 seconds by default: Grafana and Prometheus up, live exporter, |
|
Grafana (port 30000) and Prometheus in Docker, fed live from the newest session. Ctrl+C stops the exporter |
|
Stops Grafana and Prometheus ( |
|
Headless: starts the stack, exports the newest session, checks that Prometheus scrapes |
dashboards-check needs a recorded session, so run monitor-remote first.
Grafana and Prometheus run in Docker inside the workshop. Before each start, the actions remove the GF_INSTALL_PLUGINS line from the profiler’s docker-compose.yml, because Grafana stops serving when it can’t download plugins without internet access. The provided dashboards need no plugins.
Humble#
Use benchmark-framework-humble in every command, and pair it with wandering-humble. install, monitor-remote and dashboards-check work as on Jazzy.
Ubuntu 26.04 and ROS 2 Lyrical#
benchmark-framework-lyrical runs the profiler on Ubuntu 26.04 with ROS 2 Lyrical. robotics-installer and Intel®’s apt repositories don’t support Ubuntu 26.04 yet, so this workshop installs ROS 2 from packages.ros.org, and builds the profiler package from the ros-kpi source in the repository. The profiler needs neither OpenVINO™ nor oneAPI.
Launch the workshop. It takes about 3 minutes:
cd src/components/ros-kpi/workshop workshop launch benchmark-framework-lyrical
Copy the profiler source from your clone into the workshop:
git -C "$(git rev-parse --show-toplevel)" archive HEAD:src/components/ros-kpi | \ workshop exec benchmark-framework-lyrical -- \ sh -c 'rm -rf ~/benchmark-framework-src && mkdir ~/benchmark-framework-src && tar -x -C ~/benchmark-framework-src'
Build and install the package, then set up the profiler:
workshop run benchmark-framework-lyrical build-package workshop run benchmark-framework-lyrical install
The other actions work as on Jazzy. In testing, a local monitor_stack.py measured a 10 Hz test topic at 10.0 Hz, and dashboards-check passed.
Source#
The definitions, package list and check script are in src/components/ros-kpi/workshop/. The pairing script is src/workshops/scripts/authorize-remote.sh.